サバちゃん(Saba-chan) 公式ドキュメント
サバちゃんのインストール、設定、モジュールおよびエクステンション開発を扱う公式ガイドです。
サバちゃん(Saba-chan) 公式ドキュメント
サバちゃんは、個人PCでゲームサーバーをインストールして管理するプログラムです。デーモン(常にバックグラウンドで動くプログラム)がサーバープロセスを制御します。GUI、CLI、またはDiscordコマンドからサーバーの起動・停止や状態確認を行えます。Windows、Linux(x86_64)、macOS(Appleシリコン)に対応しています。
ドキュメントガイド
はじめに
- はじめに:サバちゃんのインストールから、最初のゲームサーバーの作成・起動までのセットアップ手順を案内します。
- サーバーを運営する:サーバーの起動、停止、モニタリングなど、日常的な運用の流れを解説します。
- Discord Bot:Discord Botを接続し、Discordのチャンネルから直接サーバーを起動したり状態を確認したりする方法を扱います。
- コマンド:Discord Botで使えるコマンドと、エイリアスの登録方法をまとめています。
- トラブルシューティング:ポートの競合や接続エラーなど、よくある問題の原因と対処法を案内します。
設定と拡張
- 設定ファイル:すべてのユーザー設定を保持する単一のファイル
config.jsonと、環境変数のオプションを解説します。 - エクステンション:SteamCMDによる自動インストールやUnreal Engineの設定ファイル編集など、デーモンの機能を拡張する方法を扱います。
モジュールとAPI開発
- モジュールシステム:
module.tomlの設定とPython.pyスクリプトを使って、新しいゲームサーバーへの対応を追加する方法を扱います。 - REST APIリファレンス:外部ツールやダッシュボードと連携する際に参照する、デーモンが提供するHTTP REST APIの仕様です。
主な機能
1. ランタイムのセットアップ
サバちゃんはシステム全体の環境変数(PATH)を変更しません。モジュールとエクステンションに必要なPythonランタイムはインストーラーがサバちゃん専用のフォルダーに用意するため、環境を手動で構成する必要はありません。
2. デーモンとインターフェース
Rustで書かれたコアデーモンがすべての機能を実行し、サーバープロセスを直接管理します。GUIとCLIはデーモンAPIを呼び出すインターフェースです。
- GUIウィンドウを閉じるときに「インターフェースのみ終了」を選ぶと、デーモンとゲームサーバーは動き続けます。完全に終了するには「全て終了」を選び、デーモンも停止させます。
- デーモンが再起動すると、まだ動いている既存のサーバープロセスを調べて検証し、自動的に再接続(Re-attach)してモニタリングを再開します。
3. Discord Botとリモート管理
Discord Botはクラウドのリレーサーバー上で動作します。サバちゃんをBotとペアリングすると、デーモンが外向きにリレーへ接続するため、ルーターのポート開放なしで外部ネットワークからDiscordコマンドでサーバーを管理できます。リレーが中継するのは管理コマンドだけです。プレイヤーが接続するためのネットワーク設定は、リモート管理とは別に行う必要があります。
4. モジュールとエクステンション
- モジュール:ゲームごとのインストール・起動方法と設定ルールを定義し、新しいゲームへの対応を追加します。公式モジュールはMinecraft、Palworld、Project Zomboid、Terrariaです。
- エクステンション:SteamCMDによる自動インストールやUnreal Engineの設定ファイル(INI)編集など、運用ツールをデーモンに追加します。
- 公式署名が確認されていないモジュールとエクステンションは隔離された環境で実行されます(Windows は AppContainer、Linux は bubblewrap)。隔離できない環境(bubblewrap がない、または使えない Linux、macOS)では、ユーザーが同意した後にだけ実行されます。隔離なしで実行するには、ユーザーの明示的な同意が必要です。
5. アップデート
アプリ、モジュール、エクステンションのアップデートは、公式署名が確認されたリリースからのみダウンロードされ、ダウンロードしたすべてのファイルはハッシュで検証されます。
サポートと貢献
- GitHubリポジトリ:不具合の報告やプルリクエストは WareAoba/saba-chan Github リポジトリで受け付けています。
- インストールと初期設定については はじめに を参照してください。