Setting up your development environment

To use the CommandAPI in your plugins, there are a few methods of adding it to your development environment. First things first, if you're using the CommandAPI plugin, you need to add the CommandAPI has a dependent in your plugin.yml:

name: MyPlugin
main: some.package.name.Main
version: 1.0
depend: [CommandAPI]

Manually using the .jar

  • Download the latest CommandAPI.jar from the download page here

  • Add the CommandAPI.jar file to your project/environment's build path:

    An image of some context menu entries in Eclipse after right clicking a project. Displays the highlighted options "Build Path", followed by "Add External Archives..."

Using Maven (recommended)

Developer's Note:

If you've never used maven before, I highly recommend it! It makes it easier to keep your code updated with the latest dependency updates. For information on how to set up a plugin using maven, you can read Bukkit's plugin tutorial.

  • Add the dependency to your pom.xml:

    <dependencies>
    <dependency>
        <groupId>dev.jorel</groupId>
        <artifactId>commandapi-core</artifactId>
        <version>8.2.1</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Using Gradle

  • Add the repositories to your build.gradle file (the second repository is required because the CommandAPI depends on the NBT-API):

    repositories {
    mavenCentral()
    maven { url = "https://repo.codemc.org/repository/maven-public/" }
}

  • Add the dependency to your list of dependencies in your build.gradle file:

    dependencies {
    compileOnly "dev.jorel:commandapi-core:8.2.1"
}