Setting up your development environment

To use the CommandAPI in your plugins, there are two methods of adding it to your development environment:

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
  • Add the plugin as a dependent in the plugin.yml (depend: [CommandAPI])

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 maven repository to your pom.xml file:

    <repositories>
        <repository>
            <id>mccommandapi</id>
            <url>https://raw.githubusercontent.com/JorelAli/1.13-Command-API/mvn-repo/1.13CommandAPI/</url>
        </repository>
    </repositories>
    
  • Add the dependency to your pom.xml:

    <dependencies>
        <dependency>
            <groupId>io.github.jorelali</groupId>
            <artifactId>commandapi</artifactId>
            <version>VERSION</version>
        </dependency>
    </dependencies>
    

    A list of version numbers can be found here. For example, if you wanted to use version 2.0, you would use <version>2.0</version>

  • Add the plugin as a dependent in the plugin.yml (depend: [CommandAPI])

Using Gradle

  • Add the repository to your build.gradle file:

    repositories {
        maven {
            name = 'mccommandapi'
            url = 'https://raw.githubusercontent.com/JorelAli/1.13-Command-API/mvn-repo/1.13CommandAPI/'
        }
    }
    
  • Add the dependency to your list of dependencies in your build.gradle file:

    dependencies {
        compile "io.github.jorelali:commandapi:VERSION"
    }
    

    A list of version numbers can be found here. For example, if you wanted to use version 2.0, you would use compile "io.github.jorelali:commandapi:2.0"

  • Add the plugin as a dependent in the plugin.yml (depend: [CommandAPI])