Inicio Herramientas Wiki para jugadores

Crear una wiki para jugadores

La Base de Sky incluye un generador que crea una wiki web a partir de los datos PBS de tu juego. Puedes elegir qué información publicar y configurar los combates desde una interfaz visual, sin editar código ni números de versión a mano.

Antes de empezar: ejecuta los comandos desde la raíz del repositorio, donde está wiki/generate.rb. El generador encuentra la carpeta del juego por mkxp.json, PBS/ y Data/Scripts/, aunque esté anidada o tenga otro nombre. Si hay varios juegos, define WIKI_GAME_DIR con la carpeta elegida. En macOS/Linux, por ejemplo: WIKI_GAME_DIR="ruta/al/juego" ruby wiki/generate.rb. En PowerShell, ejecuta $env:WIKI_GAME_DIR = "C:\ruta\al\juego" y luego ruby wiki/generate.rb. Necesitas Ruby 3.1 o superior; no hace falta instalar gems ni abrir el juego.
En esta guía
  1. Abrir el generador
  2. Configurar la wiki
  3. Configurar modos y combates
  4. Elegir qué mostrar
  5. Generar y previsualizar
  6. Guardar y compartir la configuración
  7. Publicar la wiki

Abrir el generador

Abre una terminal en la carpeta del proyecto y ejecuta:

ruby wiki/generate.rb

El menú permite generar con los ajustes guardados, cambiar opciones sencillas o abrir el configurador visual. Para abrir directamente el configurador:

ruby wiki/generate.rb --configure

Configurar la wiki

El configurador se abre en tu navegador y se sirve solo desde tu propio equipo. Sus pestañas agrupan las opciones:

Pulsa Guardar y generar wiki al terminar. Los cambios se guardan en wiki/config.json; puedes volver a abrir el configurador y seguir editándolos después.

Configurar modos y combates

Esta sección sirve para juegos con dificultades, rutas de historia u otras variantes de combate. Los nombres y la cantidad de modos son configurables; no están fijados a «Clásico», «Completo» o «Radical».

  1. Define los modos que tiene tu juego y elige cuál se muestra por defecto.
  2. Indica los tipos de los iniciales. Puedes añadir los tipos que correspondan a las elecciones reales del jugador.
  3. Asigna equipos por versión PBS. Puedes aplicar una asignación a todos los combates con una versión concreta y luego corregir excepciones. El número de versión es interno; no se muestra como «Equipo F» al jugador.
  4. Asigna una versión a varios modos si el mismo equipo se usa en más de uno.
  5. Configura herencia entre modos. Si un modo no tiene equipo propio para un entrenador, puede mostrar el equipo de otro modo.
  6. Pon nombres comprensibles a los combates, como «Primer combate» o «Revancha».

En la wiki generada, el lector puede elegir el tipo de su inicial desde la lista de entrenadores. La elección se recuerda al abrir otras fichas, y también puede cambiarse dentro de un combate.

Elegir qué mostrar

Las opciones de contenido controlan tanto páginas completas como secciones concretas. Puedes omitir, por ejemplo, encuentros, equipos de entrenadores, movimientos aprendidos por nivel o ubicaciones de objetos. Así cada creador adapta la guía a la información que quiere compartir.

Generar y previsualizar

El generador compila los PBS en modo headless, sin iniciar el juego, y restaura los archivos Data/*.dat originales al terminar. Al acabar, crea el sitio en wiki/site/.

Ver la wiki con VS Code

  1. Abre en VS Code la carpeta del repositorio.
  2. Instala Live Server, de Ritwick Dey, desde la vista de Extensiones.
  3. En el Explorador, busca wiki/site/index.html, haz clic derecho y selecciona Open with Live Server. También puedes abrir el archivo y pulsar Go Live en la barra inferior.

Se abrirá la wiki desde una dirección local y Live Server recargará la página cuando cambien los archivos. Pulsa Port: … o Go Live de nuevo para detenerlo. No abras el HTML mediante file://, porque la búsqueda necesita que el sitio se sirva localmente.

Si solo quieres usar una compilación PBS existente, ejecuta ruby wiki/generate.rb --no-recompile.

Guardar y compartir la configuración

Conserva wiki/config.json en el repositorio de tu juego para versionar los modos, las asignaciones de entrenadores y las opciones de la wiki. Al regenerarla, esos ajustes se vuelven a cargar.

Si tu juego parte de La Base de Sky, conserva wiki/baseline.json como referencia de los juegos oficiales. No generes un baseline nuevo desde los PBS modificados de tu juego: la wiki dejaría de señalar esos cambios.

Publicar la wiki

El contenido de wiki/site/ es HTML, CSS, JavaScript e imágenes estáticos. Puedes subir esa carpeta a GitHub Pages, GitLab Pages, Netlify o cualquier servicio de alojamiento estático. La guía de opciones y solución de problemas está en el README del generador.