Skip to content

Latest commit

 

History

History
192 lines (171 loc) · 7.8 KB

README.md

File metadata and controls

192 lines (171 loc) · 7.8 KB
Raw

He4rt Discord Bot

Comandos

  • /anunciar (ADM)
  • /falar (ADM)
  • /cargo-criar (ADM)
  • /cargo-deletar (ADM)
  • /versao (ADM)
  • /banir (ADM|MOD)
  • /desbanir (ADM|MOD)
  • /silenciar (ADM|MOD)
  • /observar (ADM|MOD)
  • /observar-lista (ADM|MOD)
  • /observar-remover (ADM|MOD)
  • /chat (ADM|MOD)
  • /limpar (ADM|MOD)
  • /cor (PRIVILEGIADOS)
  • /reputacao (DESATIVADO)
  • /especial
  • /sala
  • /sala-transferir
  • /sala-limite
  • /avaliar
  • /apoiase
  • /bonus
  • /apresentar
  • /perfil
  • /perfil-editar
  • /perguntar
  • /medalha
  • /medalha-adicionar (ADM|MOD)
  • /ranqueamento
  • /distintivo
  • /distintivo-criar (ADM)
  • /codigo
  • /forum
  • /forum-fechar
  • /reuniao-iniciar (ADM)
  • /reuniao-finalizar (ADM)
  • /reuniao-ata (ESCRIVÃO)
  • /onboarding
  • /onboarding-requisitar
  • /onboarding-voluntariar
  • /onboarding-finalizar
  • /onboarding-desistir

Contribuidores

Giovane
Giovane Cardoso 		Gustavo/
Gustavo 		Fernando
Fernando Andrade 		Henri/
Henri 		Daniel
Daniel Reis 		João
João Victor
Matheus/
Matheus 		Ronei
Ronei Kunkel 		Anibal
Anibal Sólon 		Augusto
Augusto Pieper

A He4rt Developers agradece a todos os contribuidores acima e aos contribuidores da primeira versão!

Guia de Contribuição

Caso deseje contribuir com a ferramenta, siga as seguintes instruções:

Requisitos

ATENÇÃO! Siga os guias do portal do desenvolver e convide o bot para o seu servidor usando o Discord Permissions para facilitar o seu trabalho.

Rodar

  • Clone o repositório
  • Instale as dependências usando pnpm install
  • Copie as chaves secretas usando:
cp .env.example .env

Itens com o prefixo HE4RT_ indicam env do discord-bot-api, FIREBASE_ do firebase, APOIASE_ do apoia.se. Essencialmente, você >não< precisa desses tokens para rodar o bot, apenas para testar comandos que dependem destas chaves. Caso queira usar o firebase, crie o seu json de admin na raiz do projeto com o nome firebase_admin.json.

  • Use o comando pnpm dev

ATENÇÃO! Caso use o comando pnpm dev e dê algum erro, aperte Ctrl + S em um arquivo .ts para ele recompilar a aplicação. As vezes a aplicação não vai responder, exigindo que cancele a operação, aguarde alguns segundos e execute pnpm dev

Estrutura

.
├── client                       # Anexos para o cliente padrão do `discord.js`
├── commands                     # Comandos do BOT
├── defines                      # Definições
├── events                       # Eventos temporizados, sequenciais e do discord.js
├── http                         # Construtores HTTP
| global.d.ts                    # Tipos do NodeJS e derivados
| index.ts                       # Ponto de partida para a inicialização do BOT
| main.ts                        # Criação do cliente do `discord.js`
| types.ts                       # Tipagem
| utils.ts                       # Funções para uso genérico em outros arquivos

Os arquivos de sufixo _development são variações usadas em modo de desenvolvedor (pnpm dev), com o ids_development indicando id's de nosso servidor de teste e com o ids.json indicando id's o nosso servidor do discord. Caso queira entrar no servidor de desenvolvimento, contate um dos administradores no discord.

Caso queira criar um novo comando, copie o de exemplo em src/commands/example.ts e consulte os outros para entender o padrão