Guía de Documentación

Configuración del Plugin

Cómo instalar, activar y configurar AxLore — incluyendo ElevenLabs y Dropbox.

Configuración Inicial

Sigue estos pasos para poner AxLore en funcionamiento en tu servidor Paper/Spigot.

1. Instalación desde el Dashboard

Para garantizar la máxima seguridad y compatibilidad, AxLore utiliza un sistema de Instalación Inteligente. No descargamos un archivo genérico, sino que generamos un JAR único para tu cuenta.

  1. Accede a axspace.us/dashboard.
  2. Inicia sesión con tu cuenta y dirígete a la sección de Licencias.
  3. Busca tu licencia activa de AxLore y haz clic en el botón Descargar Plugin.
  4. Importante: El sistema estampará automáticamente tu licencia dentro del archivo .jar. Esto asegura que el plugin sea compatible únicamente con tu cuenta y simplifica la activación.
Pro Tip Al descargar desde el dashboard, siempre obtendrás la versión más reciente compatible con tu servidor, sin necesidad de actualizaciones manuales constantes.

2. Activación Plug & Play

Gracias a nuestro sistema de "stamping", la activación es totalmente automática.

  • Sin Comandos: Al encender tu servidor por primera vez, AxLore detectará la licencia embebida en el JAR.
  • Validación Asíncrona: El plugin se comunicará con nuestra API en segundo plano para validar tu acceso sin afectar el rendimiento del servidor.
  • Configuración Silenciosa: Se generará un archivo .key en la carpeta del plugin para persistir la activación incluso si cambias el JAR en el futuro.
Important Notice No compartas el archivo JAR descargado con nadie. Incluye un token único vinculado a tu licencia.

3. 🎙️ Configurar ElevenLabs

AxLore utiliza ElevenLabs para generar narraciones de voz con IA de alta fidelidad.

Paso 1 — Crea una cuenta en ElevenLabs

  1. Ve a elevenlabs.io y crea una cuenta gratuita.
  2. El plan gratuito incluye un número limitado de caracteres por mes. Para servidores en producción, se recomienda un plan de pago.

Paso 2 — Genera una API Key

  1. Inicia sesión y ve a Configuración de PerfilAPI Keys.
  2. Haz clic en Create API Key.
  3. Ponle un nombre (ej: AxLore Server) y copia la clave.
Important Notice Permisos requeridos: **Text to Speech** (`tts:stream`). También se recomienda acceso de lectura a **Voices** y **Models**.

Paso 3 — Encuentra un Voice ID

  1. Ve a la Voice Library en tu dashboard de ElevenLabs.
  2. Haz clic en cualquier voz y revisa la URL — la cadena alfanumérica larga al final es el Voice ID.
  3. Ejemplo: https://elevenlabs.io/voice/IKne3meq5aSn9XLyUdCD → el ID es IKne3meq5aSn9XLyUdCD

Paso 4 — Añade las credenciales a AxLore

Abre plugins/AxLore/credentials.yml en tu servidor y agrega tu clave:

yaml
elevenlabs:
  api-key: "TU_ELEVENLABS_API_KEY"

Luego abre plugins/AxLore/config.yml y configura tu voz por defecto:

yaml
elevenlabs:
  model: "eleven_v3"              # Mejor calidad. Usa "eleven_multilingual_v2" para generación más rápida.
  default-voice-id: "TU_VOICE_ID"
  voice-settings:
    stability: 0.50               # 0.0 = expresivo, 1.0 = consistente
    similarity-boost: 0.75        # Qué tanto se parece a la voz original
    speed: 1.0                    # 0.7 (lento) a 1.2 (rápido)

4. 🔵 Configurar Dropbox (Hosting en la Nube)

Dropbox es el método recomendado para alojar el resource pack, ya que funciona en todo tipo de servidores sin necesidad de abrir puertos.

Paso 1 — Crea una App de Dropbox

  1. Ve a dropbox.com/developers/apps.
  2. Haz clic en Create app.
  3. Selecciona Scoped accessFull Dropbox.
  4. Ponle un nombre (ej: AxLoreServer) y haz clic en Create app.

Paso 2 — Configura los Permisos

En la configuración de tu app, ve a la pestaña Permissions y activa:

  • files.content.write
  • files.content.read
  • sharing.write

Haz clic en Submit para guardar.

Paso 3 — Obtén tu App Key y App Secret

Ve a la pestaña Settings de tu app de Dropbox. Ahí verás:

  • App key — Copia este valor.
  • App secret — Haz clic en "Show" y copia este valor.

Paso 4 — Añade las credenciales al plugin

Abre plugins/AxLore/credentials.yml y agrega tus claves:

yaml
dropbox:
  app-key: "TU_DROPBOX_APP_KEY"
  app-secret: "TU_DROPBOX_APP_SECRET"
[!WARNING] **No** llenes manualmente `refresh-token` ni `access-token`. Estos son gestionados automáticamente por el plugin.

Paso 5 — Autoriza el Plugin

En el juego (como operador), ejecuta:

code
/axlore dropbox auth

Haz clic en el enlace que aparece en el chat. Se abrirá una página de autorización de Dropbox en tu navegador. Acepta los permisos. El plugin almacenará los tokens automáticamente y comenzará a sincronizar.

Asegúrate también de que Dropbox esté habilitado en config.yml:

yaml
dropbox:
  enabled: true
  upload-path: "/axlore-pack.zip"

5. 🏠 Alternativa: Hosting Interno

Si prefieres no usar Dropbox, AxLore incluye un servidor web propio (NanoHTTPD).

yaml
dropbox:
  enabled: false

hosting:
  enabled: true
  port: 8085
  forced-host: "TU_IP_O_DOMINIO"  # ej: "mc.miservidor.com"
  force-pack: false
Pro Tip Asegúrate de que el puerto elegido esté abierto en tu firewall y/o redirigido en tu panel (ej: Pterodactyl).

6. 🛡️ Seguridad Inexpugnable (Zero-Secret)

AxLore está diseñado con una arquitectura de Seguridad de Confianza Cero:

  • Handshake Cifrado: Toda comunicación entre el plugin y nuestra API de licencias está cifrada y validada mediante un protocolo privado.
  • Protección de Integridad: El JAR está protegido contra modificaciones no autorizadas. Cualquier intento de alterar la lógica central resultará en una desactivación inmediata por seguridad.
  • Sin Claves Privadas en Disco: A diferencia de otros plugins, tu información de licencia sensible nunca se almacena en texto plano.

7. Requisitos y Dependencias

Para que AxLore funcione correctamente, debes cumplir con:

  • Paper o Spigot: Versión 1.19.4 o más nueva.
  • ProtocolLib: (Obligatorio) Versión compatible con tu servidor.
  • Java 17+: AxLore está optimizado para versiones modernas de Minecraft.
  • WorldGuard (Opcional): Necesario si deseas usar disparadores de tipo REGION para tus escenas narrativas.
  • FFmpeg (Auto-gestionado): Usado internamente para la conversión de audio. El plugin intentará descargar una versión portátil si no se detecta.

Pro Tip Después de completar la configuración, prueba todo con `/axlore play boss_defeated_epic`. ¡Si escuchas al narrador, tu sistema está operativo!

¿Te resultó útil?

Ayúdanos a mejorar nuestra documentación.(Anónimo y en cualquier idioma)