Skip to content

davidcanas/yamb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

✨ YAMB (Yet another Minecraft Bot)

Este projeto é um bot desenvolvido para conectar-se a servidores Minecraft, receber mensagens e executar comandos no servidor sem a necessidade de manter um cliente Minecraft aberto. Ele também utiliza um bot do Discord para interagir com os comandos e enviar logs/mensagens do Minecraft para um canal do Discord configurado.


🚀 Funcionalidades:

  • Conecta-se automaticamente a um servidor Minecraft.
  • Mantém-se ativo, reconectando-se em caso de desconexões ou kick.
  • Lê mensagens do servidor e envia logs para um canal do Discord configurado.
  • Permite o envio e execução de comandos para o Minecraft a partir do Discord.
  • Mostra os jogadores online no servidor Minecraft no canal do Discord.
  • Capacidade de ignorar mensagens irrelevantes (ex.: mensagens de manutenção).

⚠️ Aviso Importante

O código foi desenvolvido de forma rápida e simples para atender a necessidades básicas, então não segue as melhores práticas de programação (este foi apenas mais documentado e dinamizado antes de ser enviado para o Github). Apesar de funcional, pode conter problemas relacionados à estrutura, otimização e tratamento de erros. Se você deseja usar ou modificar este projeto, é recomendado revisar e melhorar o código de acordo com suas necessidades. (o código foi escrito em Setembro de 2024)


💫 Ambiente

  • Arquivo .env contendo as seguintes variáveis:
DISCORD_TOKEN=Bot token_do_bot_do_discord // Token de autenticação do bot do Discord
DISCORD_CHANNEL_ID=ID_do_canal_do_discord // ID do canal do discord.

MINECRAFT_SERVER_IP=ip_do_servidor // o IP do servidor a conectar
MINECRAFT_SERVER_PORT=porta // Padrão: 25565

MINECRAFT_USERNAME=nick_no_minecraft
MINECRAFT_ORIGINAL=true/false // Caso a conta de minecraft seja original ou não..
MINECRAFT_PASSWORD=senha // Apenas utilize caso MINECRAFT_ORIGINAL=false

O token de autenticação ao bot do discord, pode ser obtido aqui


📂 Estrutura do Projeto

.
├── src/
│   └── main.ts            # Arquivo principal
├── .env                   # Variáveis de ambiente
├── package.json           # Configurações do projeto e dependências
├── tsconfig.json          # Configuração do TypeScript
└── README.md              # Documentação do projeto

⚙️ Configuração e Execução

  1. Clone o repositório:

    git clone https://github.com/davidcanas/yamb
    cd yamb
  2. Instale as dependências:

    yarn add
  3. Configure o arquivo .env com as variáveis necessárias.

  4. Execute o bot:

    yarn start

📘 Comandos Disponíveis

Comandos no Discord:

  • /list: Lista os jogadores online no servidor de Minecraft.

  • /{comando}: Executa um comando no servidor de Minecraft a partir do Discord.

Eventos:

  • Mensagens do servidor: As mensagens do servidor Minecraft são tratadas e enviadas para o canal configurado no Discord.

🛠 Tecnologias Usadas

  • TypeScript: Linguagem de programação utilizada
  • Yarn: Gerenciador de pacotes utilizado
  • Oceanic.js: Biblioteca para criar bots do Discord.
  • Mineflayer: Biblioteca para interações com servidores Minecraft.

📝 Licença

Este projeto está sob a licença GNU AGPLv3. Consulte o arquivo LICENSE para mais informações.

About

Yet another minecraft bot...

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published