Grenadier

Command engine made with Mojang’s Brigadier for PaperMC

Allows for plugin developers to create commands using the same command engine that the vanilla game uses. This makes command creation and argument parsing a lot easier than is possible with Bukkit’s command system

Version compatibility

Grenadier VersionMinecraft Version
2.5.x (Latest 2.5.1)1.21
2.4.x (Latest 2.4.1)1.20.5 and 1.20.6
2.3.x (Latest 2.3.2)1.20.4
2.2.x (Latest 2.2.0)1.20.2
2.1.x (Latest 2.1.6)1.20 and 1.20.1
2.0.x (Latest 2.0.9)1.19.3

Dependency info

Kotlin Gradle:

repositories {
  mavenCentral()
  
  // Brigadier's repository
  maven("https://libraries.minecraft.net")
}

dependencies {
  // Grenadier itself
  implementation("net.forthecrown:grenadier:2.5.1")
  
  // Get the annotation library with
  implementation("net.forthecrown:grenadier-annotations:1.3.3")
  
  // Mojang's Brigadier engine
  compileOnly("com.mojang:brigadier:1.2.9")
}

Maven:

<repositories>
  <!-- Repository for Brigadier -->
  <repository>
    <id>minecraft-libraries</id>
    <url>https://libraries.minecraft.net/</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>net.forthecrown</groupId>
    <artifactId>grenadier</artifactId>
    <version>2.5.1</version>
  </dependency>

  <!-- Optional annotation library -->
  <dependency>
    <groupId>net.forthecrown</groupId>
    <artifactId>grenadier-annotations</artifactId>
    <version>1.3.3</version>
  </dependency>

  <!-- Brigadier itself -->
  <dependency>
    <groupId>com.mojang</groupId>
    <artifactId>brigadier</artifactId>
    <version>1.2.9</version>
  </dependency>
</dependencies>

Ensuring Grenadier gets downloaded
If you’re intending on shading Grenadier into your plugin, then you can ignore this part. This is intended for using the config.yml for Bukkit plugins and the PluginLoader for Paper plugins

Bukkit plugins

Simply add this line to your plugin.yml

libraries:
  - "net.forthecrown:grenadier:2.5.1"

  # Optional annotations library
  - "net.forthecrown:grenadier-annotations:1.3.3"

Paper plugins

You’ll need to create an implementation of PluginLoader, example:

package me.loaderexample;

public class LoaderExample implements PluginLoader {
  
  @Override
  public void classloader(@NotNull PluginClasspathBuilder classpathBuilder) {
    MavenLibraryResolver resolver = new MavenLibraryResolver();

    resolver.addDependency(
      new Dependency(new DefaultArtifact("net.forthecrown:grenadier:2.5.1"), null)
    );
    
    // Optional annotations library
    resolver.addDependency(
      new Dependency(new DefaultArtifact("net.forthecrown:grenadier-annotations:1.3.3"), null)
    );

    // Add Maven central repository
    RemoteRepository repo = new RemoteRepository.Builder("central", "default", "https://repo1.maven.org/maven2/").build();
    resolver.addRepository(repo);

    classpathBuilder.addLibrary(resolver);
  }
}

You’ll then need to tell Paper this loader exists by putting this line in your paper-plugin.yml:

loader: "me.loaderexample.LoaderExample"
Argument Types