How can I register a client-side command?

[haykam821]

How can I register a command that is available to clients exclusively?

[haykam821]

Note

This example has been created with Minecraft 1.20.1 in mind. Please reply if you are using a later version and the example seems outdated.

The fabric-command-api-v2 module provides the ClientCommandRegistrationCallback event that can be used to register client commands:

ClientCommandRegistrationCallback.EVENT.register((dispatcher, registryAccess) -> {
    dispatcher.register(ClientCommandManager
        .literal("test")
        .executes(ClientCommandExample::execute));
});

Command Source

If you are familiar with standard commands, you may know that command executions are supplied an instance of ServerCommandSource that provides details about a command's executor. Likewise, client commands are supplied an instance of FabricClientCommandSource. This interface provides methods to obtain relevant information about the executor:

• MinecraftClient getClient()
• ClientPlayerEntity getPlayer()
• Entity getEntity()
• Vec3d getPosition()
• Vec2f getRotation()
• ClientWorld getWorld()

It can also send feedback and error messages:

• void sendFeedback(Text message)
• void sendError(Text message)

Legacy Registration

On Minecraft 1.18.2 and earlier, the fabric-command-api-v1 module is instead used for client commands. With the fabric-command-api-v1 module, the ClientCommandManager.DISPATCHER field stores a command dispatcher that client commands can be registered to:

ClientCommandManager.DISPATCHER.register(ClientCommandManager
    .literal("test")
    .executes(ClientCommandExample::execute));