Dynmie's Command Framework (DCF)

A cool command framework for Minecraft.

About

This is a stripped down version of the command framework used on pixlies.net.

WARNING: This only runs on Paper. Spigot and Bukkit is not supported.

For developers

If you wish to use DCF in your pluhin, add the dependency to your pom.xml file.

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.dynmie</groupId>
    <artifactId>commands</artifactId>
    <version>1.0</version>
</dependency>

To avoid dependency conflicts, make sure you shade DCF.

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-shade-plugin</artifactId>
      <version>3.1.0</version>
      <configuration>
        <relocations>
          <relocation>
            <pattern>me.dynmie.commands</pattern>
            <!-- Replace this with your package! -->
            <shadedPattern>your.package</shadedPattern>
          </relocation>
        </relocations>
      </configuration>
      <executions>
        <execution>
          <phase>package</phase>
          <goals>
            <goal>shade</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

Contributing

Want to contribute? Create a pull request!

---

Getting started

To get started, create a command framework:

// Create the default settings for the framework
FrameworkSettings settings = new FrameworkSettings();
// Pass in your plugin instance and settings
CommandFramework framework = new CommandFramework(plugin, settings);

Registering a command

Create a class that extends BaseCommand, then register your command with the framework.

framework.register(new CoolCommand());

Command Contexts

To add a context resolver for CommandContext#argAt, add them to the settings before passing them in to the framework.

FrameworkSettings settings = new FrameworkSettings();

settings.addResolver(MyClass.class, arg -> {
        MyClass something = MyClass.getSomething(arg);
        if (something != null) {
            return something;
        }
        return null;
});

CommandFramework framework = new CommandFramework(plugin, settings);

Command Completions

To add command completions, add the completions to your command constructor.

public class MyCommand extends BaseCommand {
    public MyCommand() {
        setTabables(List.of(Tabables.player(), new StringTabable("wow", "cool")));
    }
}

To add custom command completions, implement the Tabable interface and add them in your constructor.

public class MyTabable implements Tabable {
    @Override
    public List<String> onTab(CommandSender sender, String match) {
        List<String> ret = new ArrayList<>();
        StringUtil.copyPartialMatches(match, List.of("i", "love", "java"), ret);
        return ret;
    }
}

public class MyCommand extends BaseCommand {
    public MyCommand() {
        setTabables(List.of(new MyTabable()));
    }
}

Command conditions and prerequisites use an equivalent approach.