Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dirigeants/klasa

A class remix of the Komada Bot Framework
https://github.com/dirigeants/klasa

Last synced: 2 months ago
JSON representation

A class remix of the Komada Bot Framework

Host: GitHub
URL: https://github.com/dirigeants/klasa
Owner: dirigeants
License: mit
Archived: true
Created: 2017-07-14T20:01:50.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2020-08-26T00:31:17.000Z (over 4 years ago)
Last Synced: 2024-03-15T01:03:44.550Z (11 months ago)
Language: TypeScript
Homepage: https://klasa.js.org
Size: 28.6 MB
Stars: 203
Watchers: 9
Forks: 88
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Klasa

[![Discord](https://discordapp.com/api/guilds/339942739275677727/embed.png)](https://discord.gg/FpEFSyY)

[![npm](https://img.shields.io/npm/v/klasa.svg?maxAge=3600)](https://www.npmjs.com/package/klasa)

[![npm](https://img.shields.io/npm/dt/klasa.svg?maxAge=3600)](https://www.npmjs.com/package/klasa)

[![Build Status](https://dev.azure.com/dirigeants/klasa/_apis/build/status/dirigeants.klasa?branchName=master)](https://dev.azure.com/dirigeants/klasa/_build/latest?definitionId=1&branchName=master)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/dirigeants/klasa.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/dirigeants/klasa/alerts/)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=dirigeants/klasa)](https://dependabot.com)

[![David](https://img.shields.io/david/dirigeants/klasa.svg?maxAge=3600)](https://david-dm.org/dirigeants/klasa)

[![Patreon](https://img.shields.io/badge/donate-patreon-F96854.svg)](https://www.patreon.com/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](https://github.com/discordjs/discord.js).

Originally based on [Komada](https://github.com/dirigeants/komada), Klasa has become a [ship of Theseus](https://en.wikipedia.org/wiki/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes).

## 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 (blacklist, 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.

    - Tasks: Pieces that handle scheduled tasks.

## Time to get started!

See the following [tutorial](https://klasa.js.org/#/docs/main/stable/Getting%20Started/GettingStarted) on how to get started using Klasa.

## See also:

- [Documentation for Klasa](https://klasa.js.org)

- [Example premade pieces](https://github.com/dirigeants/klasa-pieces)

- [VS Code extension for rapid development](https://marketplace.visualstudio.com/items?itemName=bdistin.klasa-vscode)