StarboundBridge

Conecte o chat do seu servidor Starbound ao Discord!

English README

Funcionalidade

Este projeto cria uma ponte de comunicação entre o chat do seu servidor Starbound e um canal do Discord, permitindo que jogadores em ambas as plataformas conversem entre si.

Instalação

Você precisará de:

• Git
• Node.js e npm

Testado em Linux.

Instalação Rápida:

1. Crie uma pasta para o StarboundBridge no diretório do seu servidor Starbound (ou em outro local de sua preferência).
2. Clone o repositório:

   git clone https://github.com/Unix-User/StarboundBridge.git

3. Instale as dependências:

   cd StarboundBridge
   npm install

Configuração:

Siga as instruções abaixo para configurar o bot do Discord, o arquivo config.json e o servidor Starbound.

1. Discord Bot:
   • Crie um bot no Portal do Desenvolvedor do Discord.
   • Na aba "Bot", adicione um bot e copie o token.
   • Na aba "OAuth2", selecione "Bot" em "Escopos" e marque as permissões "Enviar mensagens" e "Ler histórico de mensagens".
   • Use o link gerado para adicionar o bot ao seu servidor.
   • Habilite a intenção de leitura de mensagens (Message Content Intent) nas configurações do bot.
   • Ative o "Modo de Desenvolvedor" em Configurações de Usuário > Avançado no Discord.
   • Copie o ID do canal desejado (clique com o botão direito > "Copiar ID").
2. config.json:
   • Copie config.json.example para config.json.
   • Abra config.json com um editor de texto.
   • serverLogPath: Caminho completo para o arquivo de log do servidor (storage/starbound_server.log). Evite arquivos com números no final.
   • discordToken: Cole o token do seu bot do Discord.
   • rconPass: Senha RCON do servidor Starbound.
   • discordChannelID: Cole o ID do canal do Discord para o chat.
   • port: Porta RCON do servidor Starbound.
   • discordWebhookURL: (Opcional) Cole a URL do webhook do Discord para mensagens do servidor.
   • log: Nível de log desejado. Pode ser error, warn, info ou debug.
3. Servidor Starbound:
   • Abra o arquivo storage/starbound_server.config.
   • Defina runRconServer como true.
   • Defina rconServerPassword com a mesma senha usada em config.json (rconPass).
   • Anote o valor de rconServerPort e use-o em config.json (port).
   • Salve as alterações.

Executando

1. O StarboundBridge funciona independentemente do servidor Starbound.
2. Na pasta do projeto, execute:

   npm start

3. Teste a comunicação entre o jogo e o Discord.

Compatibilidade com Mods

O StarboundBridge opera em um nível inferior aos mods, minimizando conflitos. Se um problema ocorrer apenas com um mod ativo, reporte-o no GitHub.