Skip to content

Latest commit

 

History

History
55 lines (45 loc) · 3.31 KB

README.md

File metadata and controls

55 lines (45 loc) · 3.31 KB

AxonCore

Release NPM version Build status Discord server

npm installinfo

AxonCore

  • A Discord Bot framework that handles custom Client, Commands, and Events.
  • Built on top of Eris library, it allows you to easily create a customizable bot with its easy to use options.
  • This framework will be simple to setup, simple to use, and allows high customizability and efficiency.
  • This framework is built to use a DataBase for utilizing all of its functionality. It natively supports MongoDB, but it is possible to use an alternate JSON DataBase if necessary.

Features:

  • Client: Separates the Eris client and the main client that caches Modules, guildConfigs, DB schemas, etc...
  • Modular: A module that could host its own commands and events.
  • Command Handler: Creates a command easily with a lot of options and customization.
  • Event Handler: Listens to events sent by Discord API easily, splits / allows events per module.
  • GuildConfig: Natively supports guildConfigs (prefix, moderators, enabling / disabling modules / comands / events).
  • Utility: Useful shortcuts and utility functions.
  • Resolver: Built-in Resolver that can be replaced if needed.
  • Error Handling: Clean and feature rich error handling.
  • Logging: Colorful custom logging.
  • Customizable: Customize error messages easily, help command, bot staff, etc...

Documentation:

All the documentation and instructions on how to set it up can be found here.
We also have a discord server where we provide eventual support or discuss about development. Join here.

Examples

AxonCore is being used in these cool projects:

  • E.A.S.E. Enhance A Server Easily - A all in one modular bot that you can build and selfhost.
  • WebSPELL - A custom RSS bot made for a french community.

Contributions

Feel free to contribute to this project by opening Pull-Request or Issues. Contributions are always welcome.
To know more about contributions or discuss about development you can join the discord server here.

Honorable mentions

  • Jack for support and interesting talk when starting this.
  • Santhosh-Annamalai for helping me in building documentation.
  • Contributors for participating and helping in this project.