Codefi Ballerini🌃

Um bot criado pela Comunidade Ballerini para você ouvir músicas Lo-Fi sem parar enquanto desenvolve em algum canal de voz!

Tecnologias utilizadas No Projeto 🛠️

• TypeScript
• Node.js
• Discord.js
• ytdl-core

Como adicionar o Codefi no seu servidor? 🎧▶

1. Entre no link, selecione o servidor que deseja adicionar e dê as permissões necessárias.
   

2. Crie ou escolha um canal de voz para que o bot se conecte (não esqueça de autorizar o acesso dele nesse canal).
   

3. Digite >add #!canal ou >add <id_canal> para adicioná-lo.
   

4. Digite um dos comandos abaixo em algum canal de texto que o bot tenha permissão de ler para mais informações.
   >help (ajuda com os comandos dentro do servidor)
   >add #!canal (comando de adicionar o canal de voz/rádio)
   >remove (comando de remover o bot do canal,ele também pode ser removido simplesmente desconectando-o)
   

5. E pronto, agora todos os membros do seu servidor poderão ouvir lo-fi com o CODE FI 24/7.

Esclarecimentos ⚠️

Nota: O bot oficial que está sendo usado para os servidores e o mesmo do link que você pode adicionar no seu servidor possui o código fechado, porém há uma versão open-source nesse repositório que foi usada como base para o bot oficial e que está funcionando perfeitamente. O código do codefi para servidores pode ser encontrado com o moderador e desenvolvedor TAUZ#0001, que será disponibilizado apenas por certas exceções.

Para contribuir no desenvolvimento do projeto 💻

1. Você fará o fork do nosso repositório, pelo botão que aparece no canto direito superior fork.

Para colocar agora os arquivos na sua máquina, você fará um clone do repositório adicionado no seu github. Para isso, dentro do seu repositório haverá um botão code, onde você conseguirá copiar uma url. Utilize-a para rodar o comando dentro da pasta que quiser git clone <link copiado>.

Caso ainda não esteja familiarizado(a) com git e github, recomendamos assistir os seguintes vídeos: O que é Git e Github e Como usar Git e Github na prática

2. Dentro da pasta, no terminal a sua escolha, instale as dependências necessárias para o projeto com o comando:

npm install

3. Para obter o .env, basta escrever o seguinte código no seu terminal dentro da pasta do repositório:

cp .env.example .env

4. Crie um bot neste link e copie o token disponível para colocar no arquivo .env na parte que fica localizado o token.
   

(Caso não saiba criar um, basta clicar em New Application e depois em Bot no canto esquerdo para adicionar um novo. Lá aparecerá o token a ser adicionado no arquivo .env)

Além do token, é necessário adicionar outras 2 variáveis ambiente, url (que será a url do vídeo com as músicas lo-fi sem copyright) e chanelId (o ID do canal de voz em que o bot entrará, basta clicar com o botão direito no canal). Veja abaixo um molde para você criar esse arquivo:

5. Rode o projeto com:

npm run dev

6. Edite o código da forma que acha que poderá ser melhor para o projeto, adicionando features, resolvendo problemas que encontrar, iremos avaliar toda forma de contribuição!

7. Faça um pull request para o nosso repositório e descreva exatamente o que você alterou e qualquer ação necessária que devemos fazer para testar ou rodar. Siga nosso modelo de Pull Request.

Notas finais e Copyright ©️

Atualmente usamos a live do canal Lofi Girl para reproduzir a música usada. Não temos fins lucrativos pois o bot é totalmente público e mantido em um servidor particular que não recebe nenhum tipo de verba ou algo do tipo, sendo este um projeto 100% de entretenimento na plataforma discord que busca apenas contribuir para a comunidade

Desde já agradecemos qualquer contribuição! ❤