📘 English Readme | 📕 Readme em português

📖 Sobre

    A ArunaBase é uma base de código de API para bots do Discord, Twitch, e outras plataformas, feita em TypeScript, com o objetivo de facilitar a criação de bots, com uma estrutura simples e organizada, além de ser totalmente gratuita e de código aberto.

    Com a ArunaBase criar um bot capaz de executar comandos, interagir com o usuário, em plataformas como o Discord e a Twitch, além de ter uma configuração simples e intuitiva, é muito fácil e rápido.

💻 Instalação

    Para instalar a ArunaBase no seu projeto, você precisa ter o NodeJS instalado, e então executar o seguinte comando no seu terminal:

NPM:

npm install arunabase

Yarn:

yarn add arunabase

⌨ Exemplo de uso

    Para usar a ArunaBase em seu projeto, você precisa importar uma das classes que ela exporta, e então criar uma instância da classe que você importou, passando como parâmetro um objeto com as configurações do seu bot.

🗨 Exemplo de uso com o Discord

const { Discord } = require('arunabase');
// ou
import { Discord } from 'arunabase';

const client = new Discord.DiscordClient({
  botID: '<Id do bot>',
  intents: [
    Discord.Intents.Flags.MessageContent, // Opcional
    // ...
  ],
});

// use client.getCommandManager().generateCommand('Nome do comando', parâmetros do comando); para criar comandos.
// use client.getCommandManager().registerCommand(comando); para registrar o comando.

client.on('ready', () => {
  console.log('Bot pronto!');
});

client.login('<Token do bot>');

📄 Licença

    A ArunaBase é distribuída sob a licença GNU. Veja LICENSE para mais informações.

🤝 Contribuições

    Contribuições são o que fazem a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada.

1. Faça um Fork do projeto
2. Crie sua Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
4. Push para a Branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

😉 Autores

LoboMetalurgico

SpaceFox

Feito com 💚 pela equipe da Aruna™.

Todos os direitos reservados.