Kord Extensions Help

About the Project

Kord Extensions is a Discord bot framework built on top of the excellent Kord library. It provides a framework for Discord bots of all sizes, with easy-to-use commands, rich argument parsing, and many more useful features.

Kord Extensions takes a somewhat different approach when compared to other Kotlin-based Discord bot frameworks, with inspiration taken from PyCord's Cogs feature instead of a light DSL meant for prototyping or implementing small bots. However, regardless of this inspiration, Kord Extensions still provides an idiomatic API that makes full use of Kotlin's niceties.

Version 2

The recently released Kord Extensions 2 includes quite a few changes, which we've detailed below.

  • The root package for all projects is no longer com.kotlindiscord.kord.extensions. It has been changed to dev.kordex.

    • Core package: dev.kordex.core

    • Modules package: dev.kordex.modules

    • Tokenizing parser package: dev.kordex.parser

  • Kord Extensions is now licensed under the EUPL, version 1.2, with the specific provision (EUPL articles 14 & 15) that the applicable law is the (Republic of) Irish law and the Jurisdiction is Dublin.

    For more information on this license, how we interpret it, and what it means for your project, see the license information page.

  • Due to changes that are coming with the new Maven Central platform, we no longer publish Kord Extensions to Maven Central or OSSRH. Instead, you should add the following repository URLs:

    • Releases: https://releases-repo.kordex.dev

    • Snapshots: https://snapshots-repo.kordex.dev

  • Version 2 includes a new Data Collection system, intended to guide development foci and provide interesting statistics for the community.

    If you're concerned about data collection in general, this system may be configured in multiple ways and is easily disabled.

    Our public statistics dashboard contains aggregated statistics from the data collected.

  • The modules have been reorganized and renamed to make it easier to figure out their coordinates and generally keep the Git repository cleaner. For more information, see the README in the modules folder.

  • Translations have been moved to their own repository and are still licensed under the Mozilla Public License 2.0.

  • The Contribution Guidelines have been updated with information on the expected code style. We'll continue to update the guidelines when other questions arise.

  • Kord Extensions 2 has a greater emphasis on the plugin system, which will be worked on and documented more over the coming days.

    There are a lot of plans in motion around this system, so keep an eye out for announcements!

  • The Unsafe Module has been updated to support Components and Modals.

  • A default about command is now included with Kord Extensions — to help you meet the EUPL's licensing requirements and provide a standard way for your bots to provide information about themselves.

Version 1

If you need to use Kord Extensions 1 for any reason, it can be found in the same Maven repository as version 2. You may also continue to use the Gradle plugin — just be sure to specify the Kord Extensions version you need.

  • Coordinate: com.kotlindiscord.kord.extensions:kord-extensions

  • Last Version: 1.9.0-SNAPSHOT

  • Kord Version: 0.15.0-SNAPSHOT

Version 1 is licensed under the Mozilla Public License, version 2.0. The code will always be available under the v1 branch on GitHub.

Last modified: 22 September 2024