¶ Kord Extensions
This documentation is old.
We're currently working on a new set of documentation, which can be found at https://docs.kordex.dev. It's currently under heavy development, but we hope that it'll be higher quality and easier to navigate.
If you'd like to contribute, provide feedback or just follow the progress, you can also check out the new docs project on GitHub.
Kord Extensions is an addon for the excellent Kord library. It intends to provide a framework for larger bot projects, with easy-to-use commands, rich argument parsing and event handling, wrapped up into individual extension classes.
The approach taken here is relatively different from many Kotlin Discord libraries, many of which prefer to provide a DSL for quickly prototyping or implementing a small application. Instead, discord.py (the Discord library for Python) is a primary source of inspiration for our fairly object-oriented design, especially where it comes to its extensions (which are known as "cogs" in discord.py). Despite this, we still strive to provide an idiomatic API that makes full use of Kotlin's niceties.
Why not other Kord-based frameworks?
The Kord ecosystem has become rich with frameworks of many types, including an official framework named
kordx.commands. We believe that Kord Extensions speaks for itself - so we've created a feature comparison matrix that includes all of the major Kord-based frameworks.Not every framework is right for every bot - be sure to make an informed choice before you get started!
¶ Usage
- Maven repo: Maven Central for releases,
https://s01.oss.sonatype.org/content/repositories/snapshotsfor snapshots - Dependency:
com.kotlindiscord.kord.extensions:kord-extensions:VERSION
You can check the badges at the top of this page for the latest stable and snapshot versions. If you need a more in-depth guide to setting up your project, feel free to take a look at our setup guide.