CommandAPI

Appearance

Kotlin-based commands ​

The CommandAPI also provides an alternative way of making commands when using Kotlin to develop your plugins: A DSL!

This DSL provides many methods to easily add arguments to your command structure. Examples of the DSL can be found here.

Installing the DSL ​

To install the DSL, you need to add the Kotlin DSL dependency into your build script, making sure to specify the server flavor you are developing for:

Adding the dependency ​

xml
<dependencies>
    <dependency>
        <groupId>dev.jorel</groupId>
        <artifactId>commandapi-kotlin-paper</artifactId>
        <version>12.1.0</version>
    </dependency>
</dependencies>
xml
<dependencies>
    <dependency>
        <groupId>dev.jorel</groupId>
        <artifactId>commandapi-kotlin-spigot</artifactId>
        <version>12.1.0</version>
    </dependency>
</dependencies>

Next, you need to add Kotlin to your project. For this, you first need to add the dependency:

xml
<dependencies>
    <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-stdlib</artifactId>
        <version>1.9.0</version>
    </dependency>
</dependencies>

Finally, you need to add the kotlin-maven-plugin:

xml
<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-plugin</artifactId>
            <version>1.9.0</version>
            <executions>
                <execution>
                    <id>compile</id>
                    <phase>compile</phase>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                </execution>
                <execution>
                    <id>test-compile</id>
                    <phase>test-compile</phase>
                    <goals>
                        <goal>test-compile</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <jvmTarget>16</jvmTarget>
            </configuration>
        </plugin>
    </plugins>
</build>

First, you need to add the repository:

groovy
repositories {
    mavenCentral()
}
kotlin
repositories {
    mavenCentral()
}

Next, you need to add the dependency:

groovy
dependencies {
    implementation "dev.jorel:commandapi-kotlin-paper:12.1.0"
}
groovy
dependencies {
    implementation "dev.jorel:commandapi-kotlin-spigot:12.1.0"
}
kotlin
dependencies {
    implementation("dev.jorel:commandapi-kotlin-paper:12.1.0")
}
kotlin
dependencies {
    implementation("dev.jorel:commandapi-kotlin-spigot:12.1.0")
}

You also need to add Kotlin to your project. For this, you first need to add the Kotlin plugin:

groovy
plugins {
    id "org.jetbrains.kotlin.jvm" version "1.9.0"
}
kotlin
plugins {
    kotlin("jvm") version "1.9.0"
}

Next, you need to add the dependency (you should already have added the mavenCentral() repository to your project):

groovy
dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib"
}
kotlin
dependencies {
    implementation("org.jetbrains.kotlin:kotlin-stdlib")
}

Then, you need to configure the Java version to build against:

groovy
kotlin {
    jvmToolchain(16)
}
kotlin
kotlin {
    jvmToolchain(16)
}