EarphoneJack

Introdução • Tecnologias • Contribuindo • Projeto

🙆‍♀️ Introdução

EarphoneJack é uma bot legal de música para Discord, feita para dar uma nova experiência nas conversas.

Como surgi

O nome EarphoneJack vem de uma personagem chamada Kyouka Jirou do anime Boku no Hero Academia, que tem a individualidade (é como eles chamam os poderes), de "música".

🚀 Tecnologias

Projeto feito usando biblioteca javascript para Discord.

• Node.js
• Express
• Typescript
• Discord.js
• YouTube API v3
• Axios
• Ytdl-core

🧑‍🚀 Contribuindo

Antes de começar contribuir leia o CODE_OF_CONDUCT e CONTRIBUTNIG, para saber como agir na comunidade e como contribuir da melhor forma, e que pode fazer suas alrerações serem adicionadas ao projeto.

🎉 Configurando Projeto

Primeiro você precisa clonar o projeto e instalar as dependências. Você pode fazer isso usando o seguinte comando no ternminal.

git clone https://github.com/DevRadhy/EarphoneJack.git 

e para instalar as dependências basta usar

npm install
# ou yarn install

após clonar o projeto e instalar as dependências, você precisará configurar algumas variáveis de ambiente antes de rodar o projeto, para isso crie um arquivo .env na raiz do projeto. Você pode usar .env.development ou .env.local.

e crie duas variáveis:

# Token para iniciar o bot
SECRET_TOKEN=your_secret_token_bot_here

# Chave do Youtube API v3
YOUTUBE_KEY=your_youbube_api_key

# Dominios permitidos separados por ','
URLS_ORIGINS_LIST=

após configurar essas variáveis você pode iniciar o projeto com todas as funcionalidades.

O projeto possui um floxo de controle, além do Github, no Notion.so

Iniciando o projeto

Depois de instalar as dependêcias e configurar as variáveis de ambiente, basta usar o seguinte comando para iniciar o projeto.

npm run dev
# ou yarn dev

quando o bot estiver pronto, você verá no terminal com a menssagem, algo como:

Server On
Ready!

Fazendo chamandas HTTP

O bot tem um funcionalidade para fazer chamadas HTTP, para mandar mensagens em servidores e canais especificos, adicionando reações a mensagem.

Para user essa funcionalidade é só fazer uma requisição para /sendMessages, com o seguinte conteúdo no body da requisição:

{
  "guildId": "id_do_servidor",
  "channelId": "id_do_canal",
  "message": "mensagem_que_será_enviada",
  "reactions": [ "emoji" ]
}

• ID do servidor: guildId recebe uma string, com o ID do servidor onde a mensagem deve ser enviada.

• ID do canal: O campo channelId, recebe um string com o ID do canal, onde a mesagem deve ser enviada.

• Mensagem: message, pode receber dois tipos, uma string com a mensagem, ou uma array de strings, onde cada elemento é considerado uma linha, mas os dois formatos aceitam textos em multilinhas.

• Tipos de Reações: O campo de reactions recebe um string e pode receber emojis padrões que são usados normalmente no Discord, mas também pode receber emojis personalizados de cada servidor, além de emojis animados.

License

EarphoneJack by Lucas Jantsch Guedes is licensed under CC BY-SA 4.0