John Bot

               

Um bot de utilidades para seu servidor no Discord

🚧 Projeto em desenvolvimento… 🚧

Tópicos

Objetivo • Roadmap • Tecnologias • Contribuição • Instalação • Suporte • Licença

Roadmap

• Comandos
  • [x] Help
  • [x] Ping
• Grupos
  • [ ] Musica
    • [ ] Play
    • [ ] Pause
    • [ ] Add
    • [ ] Remove
    • [ ] Skip
    • [ ] Go Back
    • [ ] Join
    • [ ] Leave
  • [ ] Moderação
    • [x] Kick
    • [ ] Unkick
    • [ ] Ban
    • [ ] Unban
    • [ ] Mute
    • [ ] Unmute

Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
• Discord.JS
• Express
• date-fns
• dotEnv
• Sucrase

Instalação

Pré-requisitos

Ferramentas

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Yarn. Além disto é bom ter um editor para trabalhar com o código como VSCode.

Tokens

Você tambem precisará de um token para o seu bot. Para conseguir um token, entre no Portal do Desenvolvedor no site oficial do Discord, selecione uma aplicação - se nessesário crie uma clicando no botão New Application - então clique em Bot, se nessesário clique em Add Bot e confirme que deseja criar um Bot em Yes, do it!.

⚠️ Não se esqueça que essa ação é irreversivel, se você criar o Bot, não tem como exclui-lo, a não ser o App por completo. ⚠️

Depois que seu bot foi criado, clique em Copy para copiar o token do seu Bot.

⚠️ O token é particular de cada Bot, com ele é possivel logar como seu Bot utilizando libs de conexão com a Discord Bot API, sendo ela via JDA no Java, discord.py no Python, Discord.JS no JavaScript ou Typescript, entre outras. Se por um acaso você vazou ele, clique em Regenerate para gerar outro token e em Copy para copia-lo. ⚠️

Iniciando o seu Bot

# Clone este repositório
$ git clone https://github.com/pedrinholemes/john-bot meu-bot

# Acesse a pasta do projeto no terminal/cmd
$ cd meu-bot

# Copie o template de variaveis ambiente
$ cp .env.example .env

# E coloque os valores utilizando:
# - Vim
$ vim .env
# - VSCode - abra o Vscode na pasta do projeto e edite o `.env`
$ code . 
# - NotePad
$ notepad .env
# - Nano
$ nano .env

# Instale as dependências
$ yarn install

# Execute a aplicação
# Em modo de desenvolvimento 
$ yarn dev

# Ou em modo de produção
# Faça o Build
$ yarn build
# Rode o Script
$ yarn start

# O servidor inciará na porta 3000, e Bot já estará logado no Discord

Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

Suporte

Entre em nosso servidor de suporte:  John Bot Server 

Autor

_{Pedro Henrique Lemes}

Licença

Este projeto esta sobe a licença Mozilla Public License 2.0.

Feito com ❤️ por Pedro Henrique 👋🏽 Entre em contato!