arunabase

📘 English Readme | 📕 Readme em português

📖 About

    The ArunaBase is a API code base for Discord, Twitch, and other platforms bots, made in TypeScript, with the objective of making ease the bot creation, with a simple and organized structure, other than being completely free and open source.

    With ArunaBase create a bot capable of running commands, interact with the user, in platforms like Discord and Twitch, other than having a simple and intuitive configuration, its very fast and ease.

💻 Installing

    To install ArunaBase in your project, you need first to have NodeJS installed, then run the following command in your terminal:

NPM:

npm install arunabase

Yarn:

yarn add arunabase

⌨ Use example

    To use ArunaBase in your project, you need to import one of the classes that it exports, then create an instance of that class, passing as parameter your bot configurations as an object.

🗨 Use example with Discord

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

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

// use client.getCommandManager().generateCommand('Command name', Command parameters); to create a command.
// use client.getCommandManager().registerCommand(command); to register that command.

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

client.login('<Bot token>');

📄 License

    The ArunaBase is distributed with the GNU license. See LICENSE for more details.

🤝 Contributing

    Contributions is what makes the open source community an amazing place and its a wonderful place to learn, inspire and create. Any contribution you make will be very much appreciated.

• Make a Fork of the Project
• Create your feature branch (git checkout -b feature/AmazingFeature)
• Commit your changes (git commit -m 'Add some AmazingFeature')
• Push to the branch (git push origin feature/AmazingFeature)
• Open a Pull Request

😉 Authors

LoboMetalurgico

SpaceFox

Made with 💚 By Aruna™'s team.

All Reserved Rights.

Changelog

v1.0.0-ALPHA.14

• [BREAKING]: Several interfaces were renamed in favor of their namespace usage

  • For example: IDiscordOptions -> Discord.IOptions

• [BREAKING]: The HTTP namespace is no longer exported globally

  • Its internal dependencies make standalone usage impractical
  • If you need an HTTP client library, consider using Axios or Node.js built-in features

• [BREAKING][discord]: The previously deprecated methods were permanently removed

  • CommandManager#getGlobalCommands
  • CommandManager#getGlobalCommand
  • CommandManager#hasGlobalCommand

• [BREAKING]: CommandManager is now a singleton

• [BREAKING]: CommandManager now stores commands in a native Map instead of a Collection

  • This is part of the abstraction effort, since Collection is provided by discord.js

• [FEAT]: Began the process of abstraction for common functionality

  • All clients now extend IClientBase
  • CommandManager is no longer exclusive to Discord and will be implemented for other clients soon

• [FEAT]: Introduced the new Common namespace

  • Contains interfaces and utilities shared across different clients

• [FIX]: Various performance improvements were made

• [CHORE]: Bump dependencies