Saba-chan(鯖魚醬)官方文件

涵蓋 Saba-chan 安裝、設定,以及模組與擴充功能開發的官方指南。

Saba-chan(鯖魚醬)官方文件

Saba-chan 是在個人電腦上安裝並管理遊戲伺服器的程式。常駐程式是一直在背景執行的程式,負責控制伺服器程序。你可以透過 GUI、CLI 或 Discord 指令啟動、停止及監控伺服器。支援 Windows、Linux(x86_64)與 macOS(Apple 晶片)。


文件導覽

開始使用

  1. 開始使用:從安裝 Saba-chan 到建立並啟動第一個遊戲伺服器的設定流程。
  2. 管理伺服器:了解啟動、停止、監控伺服器等日常工作流程。
  3. Discord 機器人:連接 Discord 機器人,直接在 Discord 頻道中啟動伺服器並查看伺服器狀態。
  4. 指令:查看 Discord 機器人可用的指令,以及註冊別名的方法。
  5. 疑難排解:找出連接埠衝突、連線錯誤等常見問題的原因與解決方法。

設定與擴充

  • 設定:了解存放所有使用者設定的單一檔案 config.json,以及環境變數選項。
  • 擴充功能:以 SteamCMD 自動安裝、Unreal Engine 設定檔編輯等功能擴充常駐程式的能力。

模組與 API 開發

  • 模組系統:透過 module.toml 設定與 Python .py 指令碼新增對新遊戲伺服器的支援。
  • REST API 參考:整合外部工具或儀表板時,可參考常駐程式提供的 HTTP REST API 規格。

主要功能

1. 執行環境設定

Saba-chan 不會修改系統層級的環境變數(PATH)。安裝程式會在 Saba-chan 專用資料夾中準備模組與擴充功能所需的 Python 執行環境,你不必另外手動設定環境。

2. 常駐程式與介面

以 Rust 撰寫的核心常駐程式執行所有功能,並直接管理伺服器程序。GUI 與 CLI 則是呼叫常駐程式 API 的介面。

  • 關閉 GUI 視窗時選擇「僅關閉介面」,常駐程式與遊戲伺服器會繼續運作。若要完全關閉,請選擇「全部結束」,連同常駐程式一起停止。
  • 常駐程式重新啟動時,會檢查仍在執行中的既有伺服器程序,確認後自動重新連結(Re-attach)並繼續監控。

3. Discord 機器人與遠端管理

Discord 機器人在雲端中繼伺服器上運作。將 Saba-chan 與機器人配對後,常駐程式會主動向外連線到中繼伺服器,因此不需在路由器設定連接埠轉發,也能從外部網路透過 Discord 指令管理伺服器。中繼伺服器只轉送管理指令,玩家連線所需的網路設定必須與遠端管理分開進行。

4. 模組與擴充功能

  • 模組:定義各遊戲的安裝與啟動方式及其設定規則,藉此新增對新遊戲的支援。官方模組有 Minecraft、Palworld、Project Zomboid 與 Terraria。
  • 擴充功能:為常駐程式加入 SteamCMD 自動安裝、Unreal Engine 設定檔(INI)編輯、XNA Framework 可攜式配置等營運工具。
  • 沒有經過驗證之官方簽章的模組與擴充功能會在隔離環境中執行(Windows 為 AppContainer,Linux 為 bubblewrap)。在無法隔離的環境(沒有 bubblewrap 或無法使用它的 Linux,以及 macOS),只有在你同意後才會執行。不隔離執行需要你明確同意。

5. 更新

應用程式、模組與擴充功能的更新只會從具有已驗證官方簽章的發行版下載,且每個下載的檔案都會進行雜湊檢查。


支援與貢獻