Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 3.9 KB

README.md

File metadata and controls

74 lines (51 loc) · 3.9 KB
Raw

Kord Extensions

Ko-Fi badge

Docs: Click here Discord: Click here
Weblate project translated

Translation status

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 a lot of Kotlin 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.

If you're ready to get started, please take a look at the documentation.

Patrons

Thanks to those that have donated to support the project via Ko-Fi. If you'd like to be listed for your donation here, please mention Kord Extensions and provide your GitHub username in your donation message.

Contributors

Thanks to everyone who's supported this project. The below grid shows the avatars of this repository's top contributors.

Image grid showing all contributors' avatars

contrib.rocks provides the above grid.

Development Testing

If you're a contributor (current or future), you'll need to be testing your code. While we do encourage that you write unit tests, we also ask that you use the test bot as a form of integration test. If you break the test bot, then you've broken KordEx too!

You can find the test bot in the test-bot module. To run it, use Gradle to run the test-bot:run task, with the following environment variables set:

  • TEST_SERVER - your test server's ID
  • TOKEN - your testing bot's token

Optionally, you can provide the following environment variables:

  • ENVIRONMENT - Set this to spam to enable trace logging for Kord's gateway
  • LOG_LEVEL - One of ERROR, WARNING, INFO or DEBUG, which refers to the highest log level that will be posted in #test-logs (as mentioned below)
  • PLURALKIT_TESTING - Set this to any value (eg, true) to enable the PluralKit integration test module, which will respond to all message events (create, delete, update) with whether the message was proxied by PK or not.

Additionally, ensure that your test server contains a channel named test-logs that your test bot can send messages to.

We designed the test bot to test KordEx's complex systems, such as command handling, plugin loading, and extension management. If you modify any of these systems (or add new ones), it is important you update (or add) extensions that test them.

This module also provides some convenience functions that you can use when writing tests in commands and event handlers.