Saba-chan Official Documentation
Welcome to Saba-chan! A detailed guide for everyone, from absolute beginners to seasoned developers.
Welcome to the Saba-chan Official Documentation!
Hosting your own private game server is always exciting — but port forwarding, firewall rules, and cryptic errors can also turn it into the single biggest barrier to entry. Have you ever burned out trying to set up a server just so you could play with friends?
Saba-chan is a next-generation, all-in-one game server management platform built to solve exactly that problem!
For beginners, it's a magical tool that lets you spin up a server and invite your friends with just a few clicks. For veteran developers who manage servers for a living, it's a powerful framework with limitless extensibility and automation.
📖 Documentation Guide: Who is this for?
This documentation is carefully structured so that everyone — from first-time Saba-chan users to developers who want to build their own custom game modules — can find exactly what they need.
🎮 First-time server hosts (recommended for beginners)
You don't need to know a thing about servers! Just read these documents in order.
- Getting Started: The friendliest, easiest walkthrough — from downloading Saba-chan all the way to opening your first game server and getting your friends connected.
- Discord Bot: Learn how to start and stop your server with a single chat message in Discord, like "Saba-chan, please turn the server on."
- Troubleshooting Guide: "Port forwarding won't work!", "The server won't boot!" — common errors and clear solutions, all in one place.
🛠️ Power users who want to customize (recommended for intermediate users)
Want to wrangle your server setup exactly the way you like it?
- Configuration File Deep Dive: Take complete control of the fine-grained daemon settings and environment variables that the GUI doesn't expose.
- Extensions (Docker, SteamCMD): Don't want to clutter up your PC? Learn how to build an isolated environment with Docker, or fully automate installation with SteamCMD.
💻 Developers who want to dig into modules and code (recommended for experts)
Saba-chan is more than a utility — it's designed as a modular server management framework.
- Game Module System: A from-the-ground-up dive into how Saba-chan recognizes new game servers (Palworld, Minecraft, etc.) and controls their lifecycle, plus how to write your own game module in Python.
- REST API Reference: The full specification of the 100+ REST API endpoints exposed by the Saba-chan core daemon. A must-read if you want to build your own custom web dashboard or client!
✨ So, what makes Saba-chan special?
Saba-chan isn't like the cluttered server launchers you may have used before. It was designed from the ground up to deliver both user-friendliness and developer extensibility — without compromise.
1. It won't pollute your PC environment (Portable & Clean)
Saba-chan never touches the system registry and never pollutes your PATH. Installing and uninstalling is as clean as deleting a folder. All required runtimes — Node.js, Python, and so on — are bundled internally as portable binaries, so there's nothing for you to install separately.
2. A robust, daemon-centric ecosystem
The flashy GUI window isn't the main act. Saba-chan's heart is a core daemon written rock-solid in Rust.
- Because the daemon runs independently, accidentally closing the GUI won't kill your server.
- Did your computer suddenly lose power? When Saba-chan restarts, it uncannily finds the now-orphaned game server processes, breathes life back into them, and resumes management (Re-attach).
3. A complete Discord bot and relay server, designed for friends
Stuck behind a router and can't do port forwarding? Don't worry. Combine Saba-chan's cloud relay server with the Discord bot, and you can open your server and play with friends with a single button click in Discord — no complicated network configuration required.
4. Endless extensibility through modules and extensions
Even if it's a niche game Saba-chan doesn't support out of the box, you're covered. Write a single Python .py file and Saba-chan can recognize and manage any game server (the module system).
On top of that, extensions that expand the core feature set — a music bot that plays BGM in a Discord voice channel, Docker container integration, and more — can be plugged in with a single tap.
🙋 Need help? Reach out anytime!
Got a question while using Saba-chan, or thought of an improvement you'd love to see? You're always welcome.
- File feedback on GitHub: Drop by the WareAoba/saba-chan Github repository and open an issue, or send us a PR (Pull Request)! Your code makes Saba-chan's heart beat even stronger.
- Edit this documentation: Spotted a typo or have something to add on the page you're reading right now? Click the 'Edit this page' button at the bottom of the screen to send us a suggestion directly.
Alright — shall we begin the most stress-free game server management experience in the world, together with Saba-chan? Head over to the next page, Getting Started!