Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.71 KB

README.md

File metadata and controls

28 lines (24 loc) · 1.71 KB

Commands

Purpose

commands is a performant, flexible, future-rich, and easy-to-use command API, with several ways to implement it into your own programs and/or plugins.

We offer several platforms, and are always aiming to support more. And despite being written in kotlin, we're actively trying to keep it functional when using Java and other JVM-based languages. Several methods within commands use things such as reified parameter types, inline functions and more. We're actively working on writing mock functions so you can call these from other JVM-based languages.

Documentation

Note: this is not actively updated, we recommend checking out the wiki for more and more up-to-date information.

  • Build Tools
    • gradle - recommended build tool, commands is built using the Groovy DSL.
    • maven
  • Annotation-Based Command Creation
    • bukkit basic - How to create, define and register commands for the Bukkit module.
    • kord basic - How to create, define and register commands for the Kord module.
  • Locales
    • locales - Registering new locale fields, changing existing locale fields, and more.

Current State

commands is still actively being worked on, and we're planning to add many more features than we currently offer. When using commands, bugs might occur. We highly recommend reporting bugs at the issues section on the repository.