Saba-chan Official Documentation

Official guide covering Saba-chan installation, configuration, and module and extension development.

Saba-chan Official Documentation

Saba-chan is a program that installs and manages game servers on a personal PC. A background daemon controls server processes, and you can start, stop, and monitor servers using the GUI, the CLI, or Discord commands.

Documentation Guide

Getting Started

  1. Getting Started: Walk through the entire setup process, from installing Saba-chan to creating and connecting to your first game server.
  2. Discord Bot: Connect a Discord bot to start servers and check server status directly from Discord channels.
  3. Troubleshooting: Identify causes and solutions for common issues, such as port conflicts and connection errors.

Configuration and Extensions

  • Configuration: Review daemon configuration files, including settings.json, along with environment variable options.
  • Extensions: Extend daemon capabilities with features such as Docker isolation environments and SteamCMD automated installation.

Module and API Development

  • Module System: Add support for new game servers using module.toml configurations and Python .py scripts.
  • REST API Reference: Review the HTTP REST API specifications provided by the daemon when integrating external tools or dashboards.

Key Features

1. Runtime Setup

Saba-chan does not modify system-wide environment variables (PATH). The installer prepares the required Node.js and Python runtimes in dedicated directories, removing the need to configure separate environments manually.

2. Daemon and Interfaces

A core daemon written in Rust directly manages server processes.

  • When you close the GUI window, selecting "Exit Interface" keeps the daemon and game servers running. To shut down completely, you must stop the daemon as well.
  • When the daemon restarts, it inspects existing server processes that are still running, verifies them, and automatically reconnects (Re-attach) to resume monitoring.

3. Discord Bot and Remote Management

Connecting the cloud relay server with the Discord bot allows you to manage servers via Discord commands from external networks without router port forwarding. The relay only forwards management commands. Network access for players must be configured separately from remote management.

4. Modules and Extensions

  • Modules: Define server executable paths and configuration rules to add support for new games.
  • Extensions: Add operational tools to the daemon, such as Docker container integration or SteamCMD automated installation.

Support and Contributions