hytale-commands

Hytale Custom Commands

Complete guide for creating custom server commands with arguments, permissions, tab completion, and execution handling.

When to use this skill

Use this skill when:

• Creating new slash commands for players or admins
• Adding command arguments (required, optional, flags)
• Setting up command permissions
• Creating command collections/groups
• Implementing async commands for long-running operations
• Adding tab completion for arguments

Command Architecture Overview

Hytale uses a command system based on abstract command classes with typed arguments. Commands are registered through the plugin's CommandRegistry and managed by the CommandManager singleton.

Command Class Hierarchy

AbstractCommand
├── CommandBase              # Base for simple commands
├── AbstractAsyncCommand     # For async execution
├── AbstractPlayerCommand    # Requires player sender
├── AbstractWorldCommand     # Requires world context
├── AbstractTargetPlayerCommand    # Target another player
└── AbstractCommandCollection      # Group of subcommands

Command Flow

Player Input -> CommandManager -> Parse Arguments -> Check Permissions -> Execute

Basic Command Implementation

Simple Command

package com.example.myplugin.commands;

import com.hypixel.hytale.server.core.command.CommandBase;
import com.hypixel.hytale.server.core.command.CommandContext;

public class HelloCommand extends CommandBase {
    
    public HelloCommand() {
        super("hello", "Says hello to the world");
    }
    
    @Override
    protected void execute(CommandContext ctx) {
        ctx.sendSuccess("Hello, World!");
    }
}

Registration in Plugin

@Override
protected void setup() {
    getCommandRegistry().registerCommand(new HelloCommand());
    getCommandRegistry().registerCommand(new SpawnCommand());
    getCommandRegistry().registerCommand(new TeleportCommand());
}

Command Arguments

Argument Types

ArgType	Description	Example Value
STRING	Text string	"hello"
INTEGER	Whole number	42
FLOAT	Decimal number	3.14
BOOLEAN	True/false	true
PLAYER_REF	Online player	PlayerName
WORLD	World name	world_overworld
ITEM_ID	Item identifier	hytale:sword
BLOCK_ID	Block identifier	hytale:stone
ENTITY_TYPE_ID	Entity type	hytale:zombie
RELATIVE_INT_POSITION	Block position	~10 ~0 ~-5
RELATIVE_POSITION	Precise position	~10.5 ~0 ~-5.5
DIRECTION	Direction vector	north, up
DURATION	Time duration	10s, 5m, 1h
JSON	JSON object	{"key":"value"}
GREEDY_STRING	Rest of input	"hello world"