Saba-chan – Offizielle Dokumentation
Offizieller Leitfaden zu Installation und Konfiguration von Saba-chan sowie zur Entwicklung von Modulen und Erweiterungen.
Saba-chan – Offizielle Dokumentation
Saba-chan ist ein Programm, das Spieleserver auf einem privaten PC installiert und verwaltet. Ein Daemon, ein Programm, das immer im Hintergrund läuft, steuert die Serverprozesse. Sie können Server über die GUI, die CLI oder Discord-Befehle starten, stoppen und überwachen. Unterstützt werden Windows, Linux (x86_64) und macOS (Apple Silicon).
Leitfaden zur Dokumentation
Erste Schritte
- Erste Schritte: Der Einrichtungsablauf von der Installation von Saba-chan bis zum Erstellen und Starten Ihres ersten Spieleservers.
- Server verwalten: Der tägliche Ablauf, etwa Server starten, stoppen und überwachen.
- Discord-Bot: Verbinden Sie den Discord-Bot, um Server direkt aus Discord-Kanälen zu starten und ihren Status abzufragen.
- Befehle: Die im Discord-Bot verfügbaren Befehle und wie Sie Aliasse registrieren.
- Fehlerbehebung: Ursachen und Lösungen für häufige Probleme wie Portkonflikte und Verbindungsfehler.
Konfiguration und Erweiterungen
- Konfiguration:
config.json, die einzige Datei mit allen Benutzereinstellungen, sowie die Optionen über Umgebungsvariablen. - Erweiterungen: Erweitern Sie den Daemon um Funktionen wie die automatische Installation über SteamCMD und das Bearbeiten von Unreal-Engine-Konfigurationsdateien.
Modul- und API-Entwicklung
- Modulsystem: Fügen Sie Unterstützung für neue Spieleserver über
module.toml-Konfigurationen und Python-Skripte (.py) hinzu. - REST-API-Referenz: Die Spezifikation der HTTP-REST-API des Daemons, wenn Sie externe Werkzeuge oder Dashboards anbinden.
Hauptfunktionen
1. Einrichtung der Laufzeitumgebung
Saba-chan verändert keine systemweiten Umgebungsvariablen (PATH). Das Installationsprogramm bereitet die Python-Laufzeit, die Module und Erweiterungen benötigen, in einem eigenen Saba-chan-Ordner vor, sodass Sie keine Umgebung von Hand einrichten müssen.
2. Daemon und Oberflächen
Ein in Rust geschriebener Kern-Daemon führt alle Funktionen aus und verwaltet die Serverprozesse direkt. GUI und CLI sind Oberflächen, die die Daemon-API aufrufen.
- Wenn Sie beim Schließen des GUI-Fensters „Nur Oberfläche beenden“ wählen, laufen Daemon und Spieleserver weiter. Um alles vollständig zu beenden, wählen Sie „Alles beenden“; dann wird auch der Daemon gestoppt.
- Wenn der Daemon neu startet, prüft er noch laufende Serverprozesse, verifiziert sie und verbindet sich automatisch wieder mit ihnen (Re-attach), um die Überwachung fortzusetzen.
3. Discord-Bot und Fernverwaltung
Der Discord-Bot läuft auf dem Cloud-Relay-Server. Sobald Sie Saba-chan mit dem Bot gepairt haben, baut der Daemon eine ausgehende Verbindung zum Relay auf. So können Sie Server über Discord-Befehle aus externen Netzwerken verwalten, ohne Portweiterleitung am Router. Das Relay leitet nur Verwaltungsbefehle weiter. Den Netzwerkzugang für Spieler müssen Sie getrennt von der Fernverwaltung einrichten.
4. Module und Erweiterungen
- Module: Legen fest, wie ein Spiel installiert und gestartet wird und welche Konfigurationsregeln gelten, und fügen so Unterstützung für neue Spiele hinzu. Die offiziellen Module sind Minecraft, Palworld, Project Zomboid und Terraria.
- Erweiterungen: Fügen dem Daemon Betriebswerkzeuge hinzu, etwa die automatische Installation über SteamCMD, das Bearbeiten von Unreal-Engine-Konfigurationsdateien (INI) oder das portable Ablegen des XNA Framework.
- Module und Erweiterungen ohne verifizierte offizielle Signatur laufen in einer isolierten Umgebung (unter Windows AppContainer, unter Linux bubblewrap). In Umgebungen, die sich nicht isolieren lassen (Linux ohne oder mit nicht nutzbarem bubblewrap, macOS), laufen sie erst nach Ihrer Zustimmung. Eine Ausführung ohne Isolation erfordert Ihre ausdrückliche Zustimmung.
5. Updates
Updates für App, Module und Erweiterungen werden nur aus Releases mit verifizierter offizieller Signatur heruntergeladen, und jede heruntergeladene Datei wird per Hash geprüft.
Support und Beiträge
- GitHub-Repository: Melden Sie Probleme oder reichen Sie Pull Requests im Repository WareAoba/saba-chan Github ein.
- Hinweise zur Installation und Ersteinrichtung finden Sie unter Erste Schritte.