Getting Started

Before getting started, please ensure you have the following installed:

Git
Java Development Kit (version 13 or later)
Ensure that the version of Java you install is compatible with Gradle. It can take a while for Gradle to add support for the latest versions of Java, so this is important!

For New Projects

If you're starting a new project, we highly recommend that you use the template project.

If you have a GitHub account, you can click the "Use this template" button to quickly create a new repository using the contents of the template project. This will get you started quickly, with a basic bot provided for you to play with.

Alternatively, you can clone or download the repository and push it up to any repository host with your tooling of choice.

For Existing Projects

First, add the required Maven repos to your settings.gradle.kts.

			pluginManagement {
				repositories {
					gradlePluginPortal()
					mavenCentral()

					maven("https://snapshots-repo.kordex.dev")
					maven("https://releases-repo.kordex.dev")
				}
			}
		

Next, add the KordEx Gradle plugin to your settings.gradle.kts or build.gradle.kts.

            plugins {
                id("dev.kordex.gradle.kordex") version "1.6.1"
            }
        

Then, configure it as needed. At minimum, you should specify your bot's main class, via the mainClass property in the bot builder. You may also wish to configure the Data Collection level.

            kordEx {
                bot {
                    dataCollection(DataCollection.Standard)

                    mainClass = "my.package.here.FileWithMainFunctionKt"
                }
            }
        

For more information on the Gradle plugin, what it does and how to configure it, please see the KordEx plugin documentation.

Last modified: 07 January 2025