User Tools

Site Tools


Sidebar

Setup

Basics

Advanced

Items

Blocks and Block Entities

Fluids

Entities

World Generation

Recipe Types

Miscellaneous

Events

Mixins

Dynamic Data Generation

Tutorials for Minecraft 1.15

Tutorials for Minecraft 1.14

Documentation

tutorial:keybinds

Custom Keybinds

Keybinds: straight from the keyboard

Minecraft handles user input from peripherals such as the keyboard & mouse using key-binds. When you press W your character moves forward, and when you press E your inventory opens. Every keybind can also be configured with the settings menu, so you can make your player move with arrow keys instead of WASD if you so desire.

This tutorial assumes you have the key bindings API, if not add "fabric-key-binding-api-v1": "*" to the "depends" block in your fabric.mod.json file.

Adding a key-bind is easy. You'll need to:

  • open or create a Client entrypoint
  • create a KeyBinding object
  • react to the key being pressed

See here for an updated example.

Preparing an Entrypoint

If you already have a Client entrypoint created and you are familiar with how it works, you can safely proceed to the next section. Otherwise, stick around for a quick overview!

In order to create a Client entrypoint, we'll need to do a couple of different things to let Fabric know that we intend to specify code that only needs to be executed by the physical client side. We'll make a quick example class called ExampleClientEntrypoint, but usually the common practice would be to name the class “YourModName” followed by “Client”, e.g. YoYoDeleriumClient or HappySheepHammocksClient. Let's take a look at the code, and then we'll explain what's happening:

  1. /* package */
  2. /* imports */
  3.  
  4. public class ExampleClientEntrypoint implements ClientModInitializer {
  5.  
  6. // The KeyBinding declaration and registration are commonly executed here statically
  7.  
  8. @Override
  9. public void onInitializeClient() {
  10.  
  11. // Event registration will be executed inside this method
  12. }
  13. }

So, what are we doing here? Fabric entrypoints for most use cases are designated by implementing a special interface unique to the side or sides that the code in the entrypoint should be run on. For our Client, we simply have our class implement the ClientModInitializer interface. The interface requires us to @Override a single method, onInitializeClient. It is in this method (and the equivalents from the other entrypoints respectively) that we will often call methods provided by the Fabric API for easily registering and adding some of the objects and behaviors that we may wish to have in our mod. Of course, we'll also need to update our fabric.mod.json to include our newly created entrypoint, so be sure to consult the entrypoints page if you need a refresher on that process.

Creating your Keybind

Declare one of these in an area of your preference:

private static KeyBinding keyBinding;

FabricKeyBinding has a Builder for initialization. It takes in an Identifier, InputUtil.Type, key code, and binding category:

  1. keyBinding = KeyBindingHelper.registerKeyBinding(new KeyBinding(
  2. "key.examplemod.spook", // The translation key of the keybinding's name
  3. InputUtil.Type.KEYSYM, // The type of the keybinding, KEYSYM for keyboard, MOUSE for mouse.
  4. GLFW.GLFW_KEY_R, // The keycode of the key
  5. "category.examplemod.test" // The translation key of the keybinding's category.
  6. ));

If you want a sticky key, add () → true as last parameter.

GLFW.GLFW_KEY_R can be replaced with whatever key you want the binding to default to. The category is related to how the keybinding is grouped in the settings page.

Responding to your Keybind

The code here will print “Key 1 was pressed!” ingame.

ClientTickEvents.END_CLIENT_TICK.register(client -> {
    while (keyBinding.wasPressed()) {
	client.player.sendMessage(new LiteralText("Key 1 was pressed!"), false);
    }
});

Keep note that this is entirely client-side. To have the server respond to a keybind, you'll need to send a custom packet and have the server handle it separately.

tutorial/keybinds.txt · Last modified: 2021/02/28 17:23 by sailkite