Skip to content

README.md

Latest commit

 

History

History
87 lines (63 loc) · 2.24 KB

README.md

File metadata and controls

87 lines (63 loc) · 2.24 KB

Projeto

O Live Announcer é um BOT gratuito e opensource que promete avisar no discord, sempre que lives iniciarem.

Tecnologias

  • Javascript
  • Node.js

Configurando o projeto

Instale as dependências:

npm install

Insira o token do seu bot no arquivo .env.example e, em seguida, remova a extensão ".example" do nome do arquivo.

Crie um arquivo .json com a seguinte estrutura:

{
    "ClientId":"SeuClientId",
    "GuildId": "IdDoSeuServidor"
}

Rodando o projeto

Alguns scripts foram definidos no package.json, use conforme sua necessidade:

Deploy dos comandos (Global)

npm run deployGlobal

Deploy dos comandos (Servidor/Guild)

npm run deployGuild

Remover os comandos (Global)

npm run deleteGlobal

Remover os comandos (Servidor/Guild)

npm run deleteGuild

Iniciar o bot

npm run bot

Roadmap

Tenho alguns objetivos para esse projeto, apesar de não os ter planejados muito bem.

  • Conexão com Banco de Dados
  • Configuração Persistente de Streamers
  • Configuração Persistente de Canais e Roles
  • Conexão com API das 3 principais plataformas de livestreaming (Twitch, Youtube e Facebook)

Funcionalidades

Funcionalidades que já existem

  • Announce: Anúncio manual de início de live

Documentação

FAQ

O projeto é gratuito?

Sim, o projeto é, até o momento, gratuito e de código aberto.

Posso contribuir com o projeto?

Claro! O projeto é de código aberto, então você pode criar um fork no GitHub, desenvolver melhorias e abrir pull requests para contribuir.

Não sou um desenvolvedor, como posso sugerir novas funcionalidades?

Você pode sugerir ideias e melhorias na aba “Issues” do GitHub ou na aba "Ajuda" do Discord.

Estou com problemas, como posso solicitar ajuda?

Você pode solicitar ajuda tanto pela aba "Issues" dentro do github ou na aba "Ajuda" do discord.

O bot funciona apenas no Discord?

Sim, atualmente o Live Announcer foi desenvolvido para funcionar exclusivamente no Discord.

O bot é seguro para ser usado?

Sim, o código é aberto, o que permite que você revise toda a lógica do bot. Recomendamos não compartilhar seu token ou informações sensíveis.