Manual Setup
This tutorial aims to provide a guide to creating a standard project setup without using our template projects. If you prefer to start with a template, please see the quickstart guide instead.
Plugin Information
- Coordinate:
dev.kordex.gradle.kordex - Version:
- Requires Gradle:
- Minimum JDK:
Requirements
Before getting started, please ensure you have the following:
- A new or existing project, configured with a basic Gradle module and using Gradle via the Gradle wrapper.
- A Java Development Kit version compatible with Gradle, and at least version .
Build Configuration
Kord Extensions includes the API dependencies listed on the version picker page. If you need to use them, remember not to depend on them directly.
- Gradle (Kotlin)
- Gradle (Groovy)
Add the required plugins to your settings.gradle.kts file, creating it if it doesn't exist.
Then, add the required Gradle plugins to your build.gradle.kts file.
plugins {
kotlin("jvm")
kotlin("plugin.serialization")
id("com.google.devtools.ksp")
id("dev.kordex.gradle.kordex")
}
Finally, finish configuring your build.gradle.kts file.
Add the required plugins to your settings.gradle file, creating it if it doesn't exist.
Then, add the required Gradle plugins to your build.gradle file.
plugins {
id "org.jetbrains.kotlin.jvm"
id "org.jetbrains.kotlin.plugin.serialization"
id "com.google.devtools.ksp"
id "dev.kordex.gradle.kordex"
}
Finally, finish configuring your build.gradle file.
Further Configuration
The above guide provides a standard configuration that should get you started. However, we recommend exploring the following options for more ideas:
- We can't recommend using the Shadow plugin to build a runnable JAR with your bot's dependencies, as a group of vibe coders has taken over the project. Instead, we recommend the Gradle distribution plugin.
- The KordEx Gradle plugin has many configuration options, which you can explore here (TODO).