Saba-chan(鲭鱼酱)官方文档

涵盖 Saba-chan 安装、配置以及模块和扩展开发的官方指南。

Saba-chan(鲭鱼酱)官方文档

Saba-chan 是一款在个人电脑上安装和管理游戏服务器的程序。守护进程是始终在后台运行的程序,负责控制服务器进程。你可以通过 GUI、CLI 或 Discord 命令启动、停止和监控服务器。支持 Windows、Linux(x86_64)和 macOS(Apple 芯片)。

Discord 方面由 Server-chan 负责。Server-chan 是 Saba-chan 的姐姐,是连接 Discord 机器人和电脑的中继服务器。文档中提到 Server-chan,指的就是这个中继服务器。


文档导览

入门

  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)。安装程序会把模块和扩展所需的 Python 运行时准备在 Saba-chan 专用文件夹中,无需手动配置单独的环境。

2. 守护进程与界面

用 Rust 编写的核心守护进程执行所有功能,并直接管理服务器进程。GUI 和 CLI 是调用守护进程 API 的界面。

  • 关闭 GUI 窗口时选择“仅关闭界面”,守护进程和游戏服务器会继续运行。若要完全关闭,请选择“全部退出”,同时停止守护进程。
  • 守护进程重启时,会检查仍在运行的现有服务器进程,在验证后自动重新连接(Re-attach)并恢复监控。

3. Discord 机器人与远程管理

Discord 机器人运行在 Server-chan 上。将 Saba-chan 与机器人配对后,守护进程会主动向外连接到 Server-chan,因此无需在路由器上做端口转发,就能从外部网络通过 Discord 命令管理服务器。Server-chan 只转发管理命令。玩家连接所需的网络访问需要与远程管理分开配置。

4. 模块与扩展

  • 模块:定义每款游戏的安装与启动方式以及配置规则,从而添加对新游戏的支持。官方模块有 Minecraft、Palworld、Project Zomboid 和 Terraria。
  • 扩展:为守护进程添加运维工具,例如 SteamCMD 自动安装、Unreal Engine 配置文件(INI)编辑或 XNA Framework 便携部署。
  • 没有经过验证的官方签名的模块和扩展会在隔离环境中运行(Windows 为 AppContainer,Linux 为 bubblewrap)。在无法隔离的环境(没有 bubblewrap 或无法使用 bubblewrap 的 Linux、macOS)中,只有在你同意后才会运行。不隔离运行需要你明确同意。

5. 更新

应用、模块和扩展的更新只会从经过验证的官方签名版本中下载,且每个下载的文件都会校验哈希。


支持与贡献