Documentation officielle de Saba-chan

Guide officiel couvrant l'installation et la configuration de Saba-chan, ainsi que le développement de modules et d'extensions.

Documentation officielle de Saba-chan

Saba-chan est un programme qui installe et gère des serveurs de jeu sur un PC personnel. Un démon, un programme qui tourne en permanence en arrière-plan, contrôle les processus des serveurs. Vous pouvez démarrer, arrêter et surveiller vos serveurs depuis la GUI, la CLI ou des commandes Discord. Windows, Linux (x86_64) et macOS (puce Apple) sont pris en charge.


Guide de la documentation

Premiers pas

  1. Démarrage : suivez la mise en place, de l'installation de Saba-chan à la création et au démarrage de votre premier serveur de jeu.
  2. Gérer vos serveurs : découvrez le fonctionnement au quotidien, comme le démarrage, l'arrêt et la surveillance des serveurs.
  3. Bot Discord : connectez le bot Discord pour démarrer des serveurs et consulter leur état directement depuis des salons Discord.
  4. Commandes : consultez les commandes disponibles dans le bot Discord et la façon d'enregistrer des alias.
  5. Dépannage : identifiez les causes et les solutions des problèmes courants, comme les conflits de ports et les erreurs de connexion.

Configuration et extensions

  • Configuration : passez en revue config.json, le fichier unique qui contient tous les paramètres utilisateur, ainsi que les variables d'environnement.
  • Extensions : étendez les capacités du démon avec des fonctionnalités comme l'installation automatisée via SteamCMD ou l'édition des fichiers de configuration Unreal Engine.

Développement de modules et API

  • Système de modules : ajoutez la prise en charge de nouveaux serveurs de jeu à l'aide d'une configuration module.toml et de scripts Python .py.
  • Référence de l'API REST : consultez la spécification de l'API REST HTTP fournie par le démon pour intégrer des outils externes ou des tableaux de bord.

Fonctionnalités principales

1. Préparation de l'environnement d'exécution

Saba-chan ne modifie pas les variables d'environnement du système (PATH). L'installateur prépare le runtime Python nécessaire aux modules et aux extensions dans un dossier dédié de Saba-chan, ce qui évite d'avoir à configurer un environnement séparé à la main.

2. Démon et interfaces

Un démon central écrit en Rust exécute toutes les fonctionnalités et gère directement les processus des serveurs. La GUI et la CLI sont des interfaces qui appellent l'API du démon.

  • Lorsque vous fermez la fenêtre de la GUI, choisir « Fermer l'interface » laisse tourner le démon et les serveurs de jeu. Pour tout arrêter, choisissez « Quitter complètement » afin d'arrêter aussi le démon.
  • Au redémarrage du démon, celui-ci inspecte les processus de serveur encore en cours d'exécution, les vérifie et s'y reconnecte automatiquement (Re-attach) pour reprendre la surveillance.

3. Bot Discord et gestion à distance

Le bot Discord s'exécute sur le serveur relais cloud. Une fois Saba-chan appairé avec le bot, le démon se connecte vers l'extérieur au relais, ce qui vous permet de gérer vos serveurs par des commandes Discord depuis un réseau externe sans redirection de ports sur le routeur. Le relais ne transmet que les commandes de gestion. L'accès réseau des joueurs doit être configuré séparément de la gestion à distance.

4. Modules et extensions

  • Modules : définissent la manière d'installer et de lancer chaque jeu ainsi que ses règles de configuration, pour ajouter la prise en charge de nouveaux jeux. Les modules officiels sont Minecraft, Palworld, Project Zomboid et Terraria.
  • Extensions : ajoutent des outils d'exploitation au démon, comme l'installation automatisée via SteamCMD, l'édition des fichiers de configuration Unreal Engine (INI) ou le déploiement portable de XNA Framework.
  • Les modules et extensions sans signature officielle vérifiée s'exécutent dans un environnement isolé (AppContainer sous Windows, bubblewrap sous Linux). Là où l'isolation est impossible (Linux sans bubblewrap ou avec un bubblewrap inutilisable, macOS), ils s'exécutent seulement après votre accord. Les exécuter sans isolation demande votre consentement explicite.

5. Mises à jour

Les mises à jour de l'application, des modules et des extensions ne sont téléchargées qu'à partir de versions portant une signature officielle vérifiée, et chaque fichier téléchargé est contrôlé par hachage.


Support et contributions

  • Dépôt GitHub : signalez des problèmes ou soumettez des pull requests sur le dépôt WareAoba/saba-chan Github.
  • Pour l'installation et la configuration initiale, reportez-vous à la page Démarrage.