Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 4.44 KB

como-contribuir.md

File metadata and controls

117 lines (83 loc) · 4.44 KB

🐼 Contribuindo com o pandadomalbot

  1. Como contribuir
  2. Antes de executar
  3. Executando

Como contribuir

Para contribuir com este projeto, você não precisa necessariamente programar. Reportar problemas e sugerir melhorias também são ótimas formas de contribuir. Para isto, basta criar uma nova issue, bem descritiva.

Mas caso queira contribuir com código, você precisa ter o git e o NodeJS devidamente instalados.

Caso você tenha dificuldades ou não saiba usar o GitHub, recomendo que leia esse artigo da levxyca falando sobre GitHub para leigos.

Uma vez que ambos estiverem prontos, basta clonar este repositório:

git clone git@github.com:levxyca/pandadomalbot.git

E instalar as dependências:

cd ./pandadomalbot
npm i

Antes de executar

Antes de executar a aplicação, é necessário configurar algumas variáveis de ambiente. Já deixamos um arquivo na raiz do projeto, chamado .env.example para tornar mais fácil de visualizar quais são essas variáveis.

Dependendo da feature que você irá trabalhar, talvez não seja necessário especificar todas as variáveis. Na maioria dos casos, somente o canal no qual o bot irá atuar e o token de acesso (OAuth) da Twitch são suficientes.

Obtendo token

Para obter o token, você precisa ter uma conta na Twitch. Você pode utilizar a conta do seu canal mesmo, caso não tenha uma conta específica para bots.

  • Faça login na sua conta da Twitch
  • Em seguida, acesse este serviço e autorize o acesso à sua conta da Twitch
  • Depois de autorizado, guarde o token exibido.

Client ID/Secret

Visto que também utilizamos a API da Twitch para obter algumas informações, é necessário que você registre uma aplicação no console de desenvolvimento da Twitch para obter um client ID e um client secret. Para isto:

  • Acesse o console e clique em Registre seu aplicativo;
  • Em Nome, insira qualquer valor para identificar esta aplicação - se preferir, pode ser o mesmo nome de usuário do bot;
  • Em URLs de redirecionamento OAuth, pode utilizar o valor http//localhost. Isto não será importante visto que utilizamos o credentials flow.
  • Em Categoria, pode selecionar o valor "Chat Bot";
  • Clique em Criar.
  • Na tela seguinte, você terá acesso ao client ID (ID do cliente) e client secret (Segredo do cliente), insira-os no arquivo de de variáveis de ambiente substituindo as chaves CLIENT_ID e CLIENT_SECRET respectivamente.

Executando

Você pode definir todas as variáveis de ambiente especificadas no arquivo .env.example, mas para não ter tanto trabalho, basta renomear o arquivo para .env, assim a própria aplicação se encarregará de carregar todas as variáveis definidas nesse arquivo. Depois de renomeá-lo, edite as variáveis:

  • USERNAME: nome de usuário da conta da Twitch que será utilizado pelo bot;
  • PASSWORD: é o token de acesso que foi obtido anteriormente, caso não lembre, acesse novamente este serviço;
  • CHANNEL: nome do canal onde o bot ficará ativo.

Você pode usar o nome do seu canal em USERNAME e CHANNEL, para testes.

Depois disso, basta executar o seguinte comando:

npm start


> pandadomalbot@1.0.0 start
> node src/index.js

info: Connecting to irc-ws.chat.twitch.tv on port 443..
info: Sending authentication to server..
info: Connected to server.
info: Executing command: JOIN :levxyca
info: Joined :levxyca

🎉 E pronto, basta dar comandos para o bot! Um bom ponto de partida é executar o comando !commands.

Links úteis