README

klasa

Let's stop reinventing the wheel, and start coding the bots of our dreams!

Klasa is an OOP discord.js bot framework which aims to be the most feature complete, while feeling like a consistent extension of discord.js.

Originally based on Komada, Klasa has become a ship of Theseus, keeping many similarities with the former framework but with many enhancements and extra features.

What's with the name?

Following suit from Komada (the Croatian word for "pieces"), Klasa is the Croatian word for "class". By the same token, Klasa is modular, and each module is a piece of a puzzle you use to build your own bot. And you can replace, enhance, reload or remove these pieces; the difference is that Klasa uses classes.

What is different in this fork

ExtendedHelp has been redesigned to be forward compatible with the change to i18next that will be needed when Skyra migrated to Sapphire Framework
RichDisplay#addPage typings have been changed to take (template: MessageEmbed) => MessageEmbed to save a lot of unnecessary typing effort when building RichDisplay's
Command#extendedHelp and CommandOptions#extendedHelp now take unknown as type to facilitate better i18next transition
Other QoL changes specific for Skyra

This fork should not be used in your own projects. This fork is exclusively for Skyra's use!!

Features

Abstracted database handler, works with any database, or atomically written JSON (by default).
Easy and powerful command system, featuring usage string, dependent arguments, and custom types.
Easy and powerful to configure the permission levels system.
Easy to create your own pieces and structures!
Editable commands with quoted string support and custom parameter delimiter.
Flag arguments.
Full OOP and hot-reloadable pieces.
Full personalizable configuration system that can serve for much more than just guilds.
Incredibly fast loading (~100ms) with deep loading for commands.
Per-command cooldowns with bucket support and easy to configure.
Many different pieces and standalone utils to help you build the bot of your dreams!
- Commands: The most basic piece, they run when somebody types the prefix and the command name or any of its aliases.
- Events: Hot-reloadable structures for events, with internal error handling.
- Extendables: Easily extend Klasa or discord.js.
- Finalizers: Structures that run after successful command run.
- Inhibitors: Middleware that can stop a command from running (permissions...).
- Languages: Easy internationalization support for your bot!
- Monitors: Watch every single message your bot receives! They're perfect for no-mention-spam, swear word filter, and so on!
- Providers: You can have one, or more, they're interfaces for the settings system and ensures the data is written correctly!
- Serializers: These allow you to change how the Settings system reads, writes, and displays information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_bdistin 💻	_{Antonio Román} 💻	_{Vlad Frangu} 💻	_{Jeroen Claassens} 💻	_Jacz 💻	_{Tyler Davis} 💻	_Pandraghon 💻
_{Gryffon Bellish} 💻	_Hutch 💻	_Skillz4Killz 💻	_GC 💻	_Yukine 💻	_HellPie 💻	_{Shayne Hartford} 💻
_pedall 💻	_Dwigoric 💻	_{Fayne Aldan} 💻	_{Kenan Yildirim} 💻	_{TheFloppyBanana} 💻	_Uriel 💻	_BannerBomb 💻
_{Charalampos Fanoulis} 💻	_Angelo 💻	_Damian 💻	_{Deniz Can} 💻	_Soumil07 💻	_Excigma 💻	_{John Burke} 💻
_{Johnson Chen} 💻	_{Jordan Jones} 💻	_Kizuru 💻	_{Kovacs Alex} 💻	_{Michael Cumbers} 💻	_OGNovuh 💻	_{Piyush Bhangale} 💻
_{Nejc Drobnic} 💻	_SZephyr 💻	_{FOG_Yamato} 💻	_SuperOP535 💻	_Zach 💻	_kshxtij 💻	_{Andrew Valleteau} 💻
_hellbound 💻	_void 💻	_Faith 💻