PlayerCONSOLE API

The guide to using the PlayerCONSOLE API.

Environment Setup

Download the jar from any of the trusted source: Minecraftplugins.org, SpigotMC.org, BuiltByBit.com

Install the jar

CMD

mvn install:install-file -Dfile=pathtoyourjar\PlayerCONSOLE-5.0.jar -DgroupId=com.Mateitaa1 -DartifactId=PlayerCONSOLE -Dversion=5.0 -Dpackaging=jar

Add the maven dependency

Maven (.xml)

<dependency>
    <groupId>com.Mateitaa1</groupId>
    <artifactId>PlayerCONSOLE</artifactId>
    <version>5.0</version> <!-- Put latest vers here -->
    <scope>provided</scope>
</dependency>

Add PlayerCONSOLE to the plugin.yml

YML

depend: [PlayerCONSOLE]

Imports

Java ( Bukkit )

import com.Mateitaa1.playerconsole.CommandAPI;
import com.Mateitaa1.playerconsole.PlayerCONSOLE;

Java ( Velocity )

import com.Mateitaa1.playerconsole.velocity.CommandAPI;
import com.Mateitaa1.playerconsole.velocity.PlayerCONSOLEVelocity;

Basic Usage

Basic Command:

Java

api.registerCommand("ping", "Ping command", args -> {
    return new CommandAPI.CommandResult(true, "Pong!");
});

Basic Command ( With args ):

Java

api.registerCommand("say", "Say something now!", args -> {
    if (args.length == 0) {
        return new CommandAPI.CommandResult(false, "usage: say <yourmessage>");
    }
    
    String message = String.join(" ", args);
    return new CommandAPI.CommandResult(true, "User said: " + message);
});

SubCommands:

Java

api.registerCommand("admin", "Admin tools", args -> {
    if (args.length == 0) {
        return new CommandAPI.CommandResult(false, 
            "Cmd usage: admin <kick|ban|clear>");
    }
    
    switch (args[0].toLowerCase()) {
        case "kick": // Or whatever case you want
            // I am not doing kick logic, put whatever you want here
            return new CommandAPI.CommandResult(true, "Player kicked");
            
        case "ban":
            return new CommandAPI.CommandResult(true, "Player banned");
            
        case "clear":
            return new CommandAPI.CommandResult(true, "Chat cleared");
            
        default:
            return new CommandAPI.CommandResult(false, "Unknown subcommand");
    }
});

Getting the API

Java (Bukkit)

PlayerCONSOLE pc = (PlayerCONSOLE) Bukkit.getPluginManager()
    .getPlugin("PlayerCONSOLE");

CommandAPI api = pc.getCommandAPI();

Java (Velocity)

Optional<Object> pcInstance = server.getPluginManager()
    .getPlugin("playerconsole-velocity")
    .flatMap(container -> container.getInstance());

if (pcInstance.isPresent()) {
    PlayerCONSOLEVelocity plugin = (PlayerCONSOLEVelocity) pcInstance.get();
    CommandAPI api = plugin.getCommandAPI();
}

This is about it.