https://github.com/infinitemarcus/monika-bot
Bot de propósito geral para Discord utilizando discord.js e baseado na personagem Monika de DDLC
https://github.com/infinitemarcus/monika-bot
discordjs nodejs
Last synced: about 1 month ago
JSON representation
Bot de propósito geral para Discord utilizando discord.js e baseado na personagem Monika de DDLC
- Host: GitHub
- URL: https://github.com/infinitemarcus/monika-bot
- Owner: InfiniteMarcus
- Created: 2020-10-20T02:56:21.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-15T19:26:01.000Z (almost 4 years ago)
- Last Synced: 2025-08-20T19:20:43.472Z (10 months ago)
- Topics: discordjs, nodejs
- Language: JavaScript
- Homepage:
- Size: 221 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Monika Bot
🛑 AVISO! Repositório descontinuado! 🛑
O **Projeto Monika** foi reformulado para **Projeto Hanna**. Por consequência, este repositório se tornou obsoleto e não será mais atualizado no futuro. É possível acompanhar mais novidades via [Twitter da Hanna](https://twitter.com/ProjectHanna).
Entretanto, esta ainda é uma boa base para diversos sistemas e comandos para bots de Discord, e uma boa porcentagem disso foi reaproveitada para a Hanna.
É importante frisar que o código aqui escrito pode estar defasado e desatualizado, dado que:
- Atualizações com mudanças importantes na API do Discord e no wrapper discord.js podem (e devem) ter acontecido
- Quando eu criei este repositório, eu ainda estava aprendendo Node.js e conceitos sobre estruturação e engenharia de software
## Conceito
O projeto **Monika bot** se baseou na criação de um bot de propósito geral para a plataforma Discord, utilizando-se de do módulo [discord.js](https://github.com/discordjs/discord.js), em Node.js, para acessar a API da mesma e fornecer diversos comandos úteis para os usuários.
Os principais intuitos deste programa eram:
* Aumentar o engajamento de usuários em servidores do Discord
* Facilitar a interação entre usuários e/ou bots
* Automatizar o uso de ferramentas já disponíveis em outros meios computacionais
* Desenvolver novas funcionalidades úteis em geral
Além disso, a persona do bot era uma referência direta a personagem Monika, do jogo [Doki Doki Literature Club!](https://ddlc.moe/) (2017). O autor do projeto seguiu todos os direcionamentos e recomendações presentes no site da desenvolvedora do jogo, a [Team Salvato](http://teamsalvato.com/), sobre o uso de seus personagens em outras mídias e/ou formatos, bem como entrou em contato com a mesma para esclarecer eventuais dúvidas sobre o mesmo tema. Mais informações podem ser encontradas [aqui](http://teamsalvato.com/ip-guidelines/) (último acesso em: 07/12/2020).
O autor deste projeto deixa claro que não possui quaisquer direitos oficiais sobre a personagem Monika e/ou o jogo DDLC. O uso de quaisquer informações, imagens, referências ou detalhes deles neste software se baseiam apenas no desejo de contribuir com a comunidade de fãs deste jogo, não desejando prejudicar a empresa detentora dos direitos legais, Team Salvato. O autor sempre estará aberto para conversar e resolver quaisquer possíveis conflitos existentes no uso destas propriedades intelectuais com a respectiva desenvolvedora.
É possível jogar Doki Doki Literature Club! de graça oficialmente por [aqui](https://ddlc.moe/).
## Funcionalidades
Dentre as funcionalidades implementadas, a Monika pode:
* Cumprimentar usuários, enviar abraços, escrever mensagens e realizar outras interações
* Entrar e sair de canais de voz
* Mostrar uma lista completa de comandos (e fornecer mais detalhes sobre cada um eles)
* Mostrar a previsão do tempo para um determinado lugar
* Enviar gifs de uma seleção aleatória
* Realizar um ping TCP em um endereço na Web (e em uma determinada porta, se especificado)
* Rolar dados de diversos lados
* Tocar músicas a partir de links do Youtube
* Deletar pessoas e trazê-las de volta (referência ao jogo DDLC 😉 )
* Entre outras
## Recursos utilizados
Para o desenvolvimento deste projeto, o recurso utilizado mais importante foi o ambiente de execução [Node.js](https://nodejs.org/en/), que possibilita o uso da linguagem Javascript para aplicações servidoras. No entanto, o gerenciador de pacotes [npm](https://www.npmjs.com/) também foi de suma importância, possibilitando a instalação de pacotes fundamentais para a implementação dos comandos propostos.
A lista de dependências de pacotes npm pode ser encontrada no arquivo `package.json` neste repositório.
Outros recursos valiosos para o desenvolvimento deste projeto foram o tutorial disponível em [Discord.js Guide](https://discordjs.guide/), para melhor compreensão de como começar a construir bots para a plataforma Discord, e a documentação disponível em [discord.js.org](https://discord.js.org/#/docs/main/stable/general/welcome), para consultar mais informações sobre o módulo discord.js.
Algumas funcionalidades utilizam acesso a banco de dados para armazenar, registrar e consultar alguns dados dos usuários dos servidores aos quais o bot servirá. A tecnologia usada para tal fim foi o PostgreSQL, a partir do pacote `pg`, presente na lista de dependências. As credênciais de acesso ao banco se encontram no arquivo `database.js`, no diretório `functions`, a partir de variáveis de ambiente do Node (`process.env`).
Também é importante observar que o comando de previsão do tempo necessita de um token para a [API](https://openweathermap.org/api) do site [OpenWeather](https://openweathermap.org/). Isto pode ser adicionado ao modificar a o texto `MYAPIID` no arquivo `weather.js` no diretório `commands/utils`.
## Passo a passo
Para o desenvolvimento deste projeto, foram realizados os seguintes passos:
* Uma versão inicial do programa foi criada seguindo o passo a passo detalhado no guia [Discord.js Guide](https://discordjs.guide/)
* O primeiro comando, de envio de arquivos gif, foi criado, buscando-se compreender o funcionamento da API do Discord
* Demais comandos básicos foram sendo construidos, como os de ajuda e cumprimento de usuários
* Refatorou-se o arquivo principal `index.js`, de maneira a colocar cada função do bot em um módulo JavaScript separado
* A conexão com banco de dados foi criada, armazenando dados sobre as interações dos usuários do servidor do HackoonSpace
* O sistema de níveis e pontos de experiência foi implementado, visando a existência de comandos exclusivos para determinados níveis
* Comandos mais complexos, como de conexão com a API de previsão do tempo e de deletar usuários foram sendo implementados, usando recursos mais avançados do Node.Js
* Uma microeconomia, baseada em moedas ficticias (HackoonCoins) foi criada, possibilitando que alguns comandos só pudessem ser utilizados se o usuário consumisse algumas dessas moedas
* Alguns tratamentos mais avançados para [Promises](https://developer.mozilla.org/pt-BR/docs/Web/JavaScript/Reference/Global_Objects/Promise) e comportamentos assíncronos foram adicionados
## Instalação
### 1º Passo:
Baixe e instale o Node.js, preferencialmente na mesma versão apresentada no arquivo `package.json`. Se tudo der certo, o gerenciador de pacotes npm será instalado automaticamente junto com o Node
### 2º Passo:
Clone/copie os arquivos deste repositório em um diretório na sua máquina
### 3º Passo:
Execute o comando `npm install` para instalar todas as dependências presentes em `package.json`
### 4º Passo:
Preencha todos os campos necessários no arquivo `config.json`
### 5º Passo:
Preencha os demais campos com tokens e chaves de configuração do projeto:
* `process.env.BOT_TOKEN`, em `index.js`, para autenticar o bot na API do Discord
* `process.env.ROLE` e `process.env.WELCOME_CHANNEL`, em `index.js`, para configurar qual cargo padrão novos usuários irão receber e qual mensagem de boas-vindas deverá aparecer
* (OPCIONAL) `process.env.process.env.BOTS_ONLY_CHANNEL`, em `index.js`, caso o bot necessite responder apenas em um único canal exclusivo
* os campos de acesso ao banco de dados, em `functions/database.js`, para usufruir do sistema de níveis e moedas
* o campo MYAPIID, na chamada da API Open Weather, em `commands/utils/weather.js`, para o comando de previsão do tempo
### 6º Passo:
Crie as tabelas necessárias no mesmo banco de dados PostgreSQL das credenciais fornecidas na etapa anterior
Os códigos SQL necessários para a criação das tabelas do banco de dados se encontram no arquivo `database.sql`
## Execução
```
Execute os comandos `npm start` ou `node .` para hospedar o bot na sua máquina
```
Se tudo der certo, a mensagem "Estou na sua realidade!" deve aparecer no seu terminal.
## Bugs/problemas conhecidos
Os problemas mais notórios a serem resolvidos neste projeto foram:
* O comando `-myinfo` possui alguns problemas de visualização em dispositivos móveis;
* O comando `-help`, a medida em que novas funcionalidades estão sendo implementadas, retorna uma lista extensa de comandos, não sendo muito amigável para ler;
* A busca por localidades com o comando `-weather` pode, em algumas situações, não funcionar. Isto ocorre por problemas envolvendo acentos e traduções de nomes de países, cidades e demais lugares, dado que a API que fornece os dados de previsão do tempo foi feita originalmente em inglês;
* Instalação e configuração do projeto possui alta complexidade. Diversos dados necessitam ser reorganizados para simplificar este processo
## Autores
* Marcus Vinícius N. Garcia ([Infinitemarcus](https://github.com/Infinitemarcus))
## Demais anotações e referências
Seguem algumas últimas informações e observações sobre o projeto:
* O autor do projeto, como qualquer outra pessoa, não é perfeito. O projeto sempre está aberto para sugestões, recomendações, alterações, correções e afins. Então sinta-se livre para entrar em contato direto ou utilizar as próprias ferramentas do GitHub para tal
## Imagens/screenshots
