Documentación oficial de Saba-chan
Guía oficial sobre la instalación y configuración de Saba-chan y el desarrollo de módulos y extensiones.
Documentación oficial de Saba-chan
Saba-chan es un programa que instala y gestiona servidores de juego en un PC personal. Un demonio, un programa que se ejecuta siempre en segundo plano, controla los procesos de los servidores. Puede iniciar, detener y supervisar los servidores con la GUI, la CLI o comandos de Discord. Se admiten Windows, Linux (x86_64) y macOS (Apple silicon).
La parte de Discord la lleva el relay en la nube, un servidor que conecta el bot de Discord con su PC.
Guía de la documentación
Primeros pasos
- Primeros pasos: recorra el proceso de puesta en marcha, desde la instalación de Saba-chan hasta la creación y el arranque de su primer servidor de juego.
- Gestión de servidores: conozca el flujo de trabajo diario, como iniciar, detener y supervisar servidores.
- Bot de Discord: conecte el bot de Discord para iniciar servidores y consultar su estado directamente desde los canales de Discord.
- Comandos: consulte los comandos disponibles en el bot de Discord y cómo registrar alias.
- Resolución de problemas: identifique las causas y soluciones de los problemas habituales, como conflictos de puertos y errores de conexión.
Configuración y extensiones
- Configuración: revise
config.json, el único archivo que contiene todos los ajustes del usuario, junto con las variables de entorno. - Extensiones: amplíe las capacidades del demonio con funciones como la instalación automatizada con SteamCMD o la edición de archivos de configuración de Unreal Engine.
Desarrollo de módulos y API
- Sistema de módulos: añada compatibilidad con nuevos servidores de juego mediante configuraciones
module.tomly scripts de Python.py. - Referencia de la API REST: consulte la especificación de la API REST HTTP que proporciona el demonio para integrar herramientas externas o paneles.
Funciones principales
1. Preparación del entorno de ejecución
Saba-chan no modifica las variables de entorno del sistema (PATH). El instalador prepara el runtime de Python que necesitan los módulos y las extensiones en una carpeta dedicada de Saba-chan, por lo que no hace falta configurar entornos por separado a mano.
2. Demonio e interfaces
Un demonio central escrito en Rust ejecuta todas las funciones y gestiona directamente los procesos de los servidores. La GUI y la CLI son interfaces que llaman a la API del demonio.
- Al cerrar la ventana de la GUI, elegir «Solo cerrar interfaz» mantiene en marcha el demonio y los servidores de juego. Para cerrarlo todo, elija «Salir Todo» para detener también el demonio.
- Cuando el demonio se reinicia, inspecciona los procesos de servidor que siguen en ejecución, los verifica y se vuelve a conectar a ellos automáticamente (Re-attach) para reanudar la supervisión.
3. Bot de Discord y gestión remota
El bot de Discord se ejecuta en el servidor relay en la nube. Una vez emparejado Saba-chan con el bot, el demonio se conecta hacia fuera al relay, de modo que puede gestionar sus servidores con comandos de Discord desde redes externas sin reenvío de puertos en el router. El relay solo transmite comandos de gestión. El acceso de red de los jugadores debe configurarse aparte de la gestión remota.
4. Módulos y extensiones
- Módulos: definen cómo se instala y se lanza cada juego, junto con sus reglas de configuración, para añadir compatibilidad con nuevos juegos. Los módulos oficiales son Minecraft, Palworld, Project Zomboid y Terraria.
- Extensiones: añaden herramientas de operación al demonio, como la instalación automatizada con SteamCMD o la edición de archivos de configuración (INI) de Unreal Engine.
- En Windows, los módulos y extensiones sin una firma oficial verificada se ejecutan en un entorno aislado. En Linux y macOS no hay aislamiento, así que solo se ejecutan después de que usted lo acepte. Ejecutarlos sin aislamiento requiere su consentimiento explícito.
5. Actualizaciones
Las actualizaciones de la aplicación, los módulos y las extensiones solo se descargan de versiones con una firma oficial verificada, y cada archivo descargado se comprueba mediante hash.
Soporte y contribuciones
- Repositorio de GitHub: informe de problemas o envíe pull requests en el repositorio WareAoba/saba-chan Github.
- Para la instalación y la configuración inicial, consulte Primeros pasos.