Documentação Oficial do Saba-chan

Guia oficial sobre a instalação, a configuração e o desenvolvimento de módulos e extensões do Saba-chan.

Documentação Oficial do Saba-chan

O Saba-chan é um programa que instala e gerencia servidores de jogos em um PC pessoal. Um daemon, um programa que fica sempre em execução em segundo plano, controla os processos dos servidores. Você pode iniciar, parar e monitorar servidores pela GUI, pela CLI ou por comandos do Discord. Há suporte para Windows, Linux (x86_64) e macOS (Apple silicon).


Guia da documentação

Primeiros passos

  1. Primeiros passos: percorra o processo de configuração, desde a instalação do Saba-chan até a criação e a inicialização do seu primeiro servidor de jogo.
  2. Gerenciando seus servidores: conheça o fluxo do dia a dia, como iniciar, parar e monitorar servidores.
  3. Bot do Discord: conecte o bot do Discord para iniciar servidores e verificar o status deles diretamente nos canais do Discord.
  4. Comandos: veja os comandos disponíveis no bot do Discord e como cadastrar apelidos.
  5. Solução de problemas: identifique causas e soluções para problemas comuns, como conflitos de porta e erros de conexão.

Configuração e extensões

  • Configuração: conheça o config.json, o arquivo único que guarda todas as configurações do usuário, além das opções de variáveis de ambiente.
  • Extensões: amplie os recursos do daemon com funções como a instalação automatizada via SteamCMD e a edição de arquivos de configuração da Unreal Engine.

Desenvolvimento de módulos e da API

  • Sistema de módulos: adicione suporte a novos servidores de jogos usando configurações module.toml e scripts Python .py.
  • Referência da REST API: consulte as especificações da HTTP REST API fornecida pelo daemon ao integrar ferramentas externas ou dashboards.

Principais recursos

1. Preparação do runtime

O Saba-chan não altera as variáveis de ambiente do sistema (PATH). O instalador prepara o runtime Python de que módulos e extensões precisam em uma pasta própria do Saba-chan, dispensando a configuração manual de ambientes separados.

2. Daemon e interfaces

Um daemon central escrito em Rust executa todas as funções e gerencia diretamente os processos dos servidores. A GUI e a CLI são interfaces que chamam a API do daemon.

  • Ao fechar a janela da GUI, escolher "Fechar apenas interface" mantém o daemon e os servidores de jogo em execução. Para encerrar tudo, escolha "Sair Tudo" para parar também o daemon.
  • Quando o daemon reinicia, ele inspeciona os processos de servidor que continuam em execução, verifica-os e se reconecta automaticamente (re-attach) para retomar o monitoramento.

3. Bot do Discord e gerenciamento remoto

O bot do Discord roda no servidor de relay em nuvem. Depois de parear o Saba-chan com o bot, o daemon se conecta de dentro para fora ao relay, então você pode gerenciar servidores por comandos do Discord a partir de redes externas sem encaminhamento de portas no roteador. O relay só encaminha comandos de gerenciamento. O acesso de rede dos jogadores precisa ser configurado separadamente do gerenciamento remoto.

4. Módulos e extensões

  • Módulos: definem como cada jogo é instalado e iniciado, junto com suas regras de configuração, para adicionar suporte a novos jogos. Os módulos oficiais são Minecraft, Palworld, Project Zomboid e Terraria.
  • Extensões: adicionam ferramentas de operação ao daemon, como a instalação automatizada via SteamCMD, a edição de arquivos de configuração (INI) da Unreal Engine ou a implantação portátil do XNA Framework.
  • Módulos e extensões sem assinatura oficial verificada rodam em um ambiente isolado (AppContainer no Windows, bubblewrap no Linux). Onde não é possível isolar (Linux sem bubblewrap ou em que ele não funciona, e macOS), eles só rodam depois que você concorda. Rodá-los sem isolamento exige seu consentimento explícito.

5. Atualizações

As atualizações do aplicativo, dos módulos e das extensões são baixadas apenas de releases com assinatura oficial verificada, e o hash de cada arquivo baixado é conferido.


Suporte e contribuições