Официальная документация Saba-chan

Официальное руководство по установке и настройке Saba-chan, а также по разработке модулей и расширений.

Официальная документация Saba-chan

Saba-chan — это программа, которая устанавливает игровые серверы на личном ПК и управляет ими. Демон, программа, которая всегда работает в фоне, управляет процессами серверов. Запускать, останавливать и отслеживать серверы можно через GUI, CLI или команды Discord. Поддерживаются Windows, Linux (x86_64) и macOS (Apple silicon).


Путеводитель по документации

Начало работы

  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-бот работает на облачном сервере-ретрансляторе (relay). После сопряжения Saba-chan с ботом демон сам подключается к ретранслятору исходящим соединением, поэтому управлять серверами командами Discord можно из внешних сетей без проброса портов на роутере. Ретранслятор передаёт только команды управления. Сетевой доступ для игроков настраивается отдельно от удалённого управления.

4. Модули и расширения

  • Модули описывают, как устанавливается и запускается каждая игра, а также её правила настройки, и тем самым добавляют поддержку новых игр. Официальные модули — Minecraft, Palworld, Project Zomboid и Terraria.
  • Расширения добавляют демону инструменты эксплуатации, например автоматическую установку через SteamCMD, редактирование конфигурационных файлов (INI) Unreal Engine или портативное размещение XNA Framework.
  • Модули и расширения без проверенной официальной подписи запускаются в изолированной среде (AppContainer в Windows, bubblewrap в Linux). Там, где изолировать нельзя (Linux без bubblewrap или с неработающим bubblewrap, macOS), они запускаются только после вашего согласия. Для запуска без изоляции нужно ваше явное согласие.

5. Обновления

Обновления приложения, модулей и расширений загружаются только из релизов с проверенной официальной подписью, а хеш каждого загруженного файла сверяется.


Поддержка и участие

  • Репозиторий на GitHub: сообщайте о проблемах и присылайте pull request'ы в репозиторий WareAoba/saba-chan Github.
  • Об установке и первоначальной настройке — на странице Начало работы.