Giter Club home page Giter Club logo

klasa-pieces's Introduction

Klasa Pieces repository

This repository contains the various Pieces submitted by users and collaborators.

What are Pieces?

Pieces are simply parts of code that can be downloaded and installed straight into your Klasa bot installation.

Pieces can include:

  • Commands: Chat commands that generally respond with a message after taking some actions.
  • Events: Pieces that get executed when a Discord event triggers.
  • Extendables: Pieces that act passively, attaching new getters, setters or methods or static to the current Discord.js classes. They're executed at startup before any other piece.
  • Finalizers: Pieces that run on messages after a successful command.
  • Inhibitors: Inhibitors are pieces that run before a command is executed and may take action on the message received, and block a command from running in certain cases (thus inhibit a command).
  • Monitors: Monitors are pieces that can run on every message, whether or not it triggers a command. Useful for spam monitoring, swear filters, etc.
  • Providers: Support for a specific database type. By default a very small amount of DBs are supported, but you can extend the support by adding a provider for whatever database you choose, and configure it to point to your own database.
  • Tasks: Pieces that get executed on scheduled tasks.

Submitting Pieces

Check out the documentation:

To submit your own pieces for approval (quick steps):

  • Fork this repository
  • Create a new piece in the appropriate folder
  • Lint your code with klasa-lint
  • Create a Pull Request to the repository
  • Be patient. Someone will approve/deny it as soon as they can

We will automatically deny PRs that:

  • Have identical functionality to an existing Piece
  • Have code that breaks/does not catch errors/etc
  • Contain NSFW, NSFL contents or contents we deem to be unacceptable
  • Contain hacks/exploits/etc
  • Have code that might cause a bot to break the TOS or Ratelimits
  • Any reason WE feel is valid

WE RESERVE THE RIGHT TO REFUSE ANY CONTENTS FOR ANY REASON WHETHER YOU ACCEPT THEM OR NOT.

klasa-pieces's People

Contributors

kyranet avatar bdistin avatar pandraghon avatar kashalls avatar linkzyzvg avatar tech6hutch avatar gc avatar newtj avatar internetprotocolv6 avatar dwigoric avatar mrjacz avatar samplasion avatar dolliwyx avatar vladfrangu avatar soumil-07 avatar yorkaargh avatar devyukine avatar eslachance avatar

Watchers

James Cloos 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.