Giter Club home page Giter Club logo

klasa's Introduction

Klasa

Discord npm npm Build Status Total alerts Dependabot Status David Patreon

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.

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 on how to get started using Klasa.

See also:

klasa's People

Contributors

bdistin avatar dependabot-preview[bot] avatar kyranet avatar dependabot[bot] avatar unseenfaith avatar vladfrangu avatar tylertron1998 avatar mrjacz avatar pandraghon avatar tech6hutch avatar gc avatar greenkeeper[bot] avatar devyukine avatar skillz4killz avatar hellpie avatar pyrotechniac avatar shaybox avatar pedall avatar soumil-07 avatar dwigoric avatar ruintd avatar favna avatar kenany avatar dolliwyx avatar imurx avatar mcumbers avatar ognova avatar officialpiyush avatar quantumlyy avatar szephyr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.