How to make a key the player can press in a Minecraft mod
A key mapping is a KeyMapping with a translation key, a default key and a category (KeyBinding on 1.16.5 and 1.12.2); once registered it shows in Controls, where players can change it. Fabric API registers it with KeyBindingHelper.registerKeyBinding, Forge and NeoForge in RegisterKeyMappingsEvent (ClientRegistry on 1.16.5 and 1.12.2). Check it each client tick with consumeClick(), which is true once per press (isPressed() on 1.12.2).
Works on Minecraft 1.20.1 to 26.3 on NeoForge; Minecraft 1.16.5 to 26.3 on Fabric; Minecraft 1.16.5 to 1.20.1 on Forge; Minecraft 1.12.2 on Forge. Each example was compiled against its loader and version before it shipped in Linen.
- Make a KeyMapping with a translation key, InputConstants.KEY_R and a category.
- Register it in the client.
- Each client tick, while (key.consumeClick()) { … }.
- Name the key and the category in en_us.json.
What you can change
Section titled “What you can change”The example uses these values. Change them in the code.
| Setting | In the example | What it does |
|---|---|---|
| key | R |
The key it is on until the player changes it in Controls. |
| message | Key pressed! |
The message it shows. |
For each loader and version
Section titled “For each loader and version”The example mod is examplemod in the package com.example.examplemod. Use your own mod id and package.
Fabric 1.19 to 1.21, Fabric 1.21.1, Fabric 1.21.2 to 1.21.8
Section titled “Fabric 1.19 to 1.21, Fabric 1.21.1, Fabric 1.21.2 to 1.21.8”Uses:
KeyBindingHelper.registerKeyBindingKeyMappingInputConstantsClientTickEvents.END_CLIENT_TICKKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper;import net.minecraft.client.KeyMapping;import net.minecraft.network.chat.Component;
// The Open Notes key (R until changed in Controls), registered with Fabric API's KeyBindingHelper.public final class OpenNotesKeys { public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from the mod's client entrypoint. public static void register() { KeyBindingHelper.registerKeyBinding(OPEN_NOTES); ClientTickEvents.END_CLIENT_TICK.register(client -> { while (OPEN_NOTES.consumeClick()) { if (client.player != null) { client.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }); }}In your client setup class, inside onInitializeClient:
OpenNotesKeys.register();In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}Forge 1.17.1
Section titled “Forge 1.17.1”Uses:
RegisterKeyMappingsEventKeyMappingTickEvent.ClientTickEventKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import net.minecraft.network.chat.TextComponent;import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.minecraftforge.fmlclient.registry.ClientRegistry;import net.minecraftforge.common.MinecraftForge;import net.minecraftforge.event.TickEvent;import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
// The Open Notes key (R until changed in Controls): registered in FMLClientSetupEvent, checked every client tick.public final class OpenNotesKeys { public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register() { FMLJavaModLoadingContext.get().getModEventBus().addListener(OpenNotesKeys::onClientSetup); MinecraftForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void onClientSetup(FMLClientSetupEvent event) { ClientRegistry.registerKeyBinding(OPEN_NOTES); }
private static void onClientTick(TickEvent.ClientTickEvent event) { if (event.phase != TickEvent.Phase.END) { return; } while (OPEN_NOTES.consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(new TextComponent("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.dist == Dist.CLIENT) { OpenNotesKeys.register();}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}Forge 1.18.2
Section titled “Forge 1.18.2”Uses:
RegisterKeyMappingsEventKeyMappingTickEvent.ClientTickEventKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import net.minecraft.network.chat.TextComponent;import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.minecraftforge.client.ClientRegistry;import net.minecraftforge.common.MinecraftForge;import net.minecraftforge.event.TickEvent;import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
// The Open Notes key (R until changed in Controls): registered in FMLClientSetupEvent, checked every client tick.public final class OpenNotesKeys { public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register() { FMLJavaModLoadingContext.get().getModEventBus().addListener(OpenNotesKeys::onClientSetup); MinecraftForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void onClientSetup(FMLClientSetupEvent event) { ClientRegistry.registerKeyBinding(OPEN_NOTES); }
private static void onClientTick(TickEvent.ClientTickEvent event) { if (event.phase != TickEvent.Phase.END) { return; } while (OPEN_NOTES.consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(new TextComponent("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.dist == Dist.CLIENT) { OpenNotesKeys.register();}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}Forge 1.19 to 1.20.1, NeoForge 1.20.1
Section titled “Forge 1.19 to 1.20.1, NeoForge 1.20.1”Uses:
RegisterKeyMappingsEventKeyMappingTickEvent.ClientTickEventKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.minecraftforge.client.event.RegisterKeyMappingsEvent;import net.minecraftforge.common.MinecraftForge;import net.minecraftforge.event.TickEvent;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
// The Open Notes key (R until changed in Controls): registered in RegisterKeyMappingsEvent, checked every client tick.public final class OpenNotesKeys { public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register() { FMLJavaModLoadingContext.get().getModEventBus().addListener(OpenNotesKeys::registerKeys); MinecraftForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void registerKeys(RegisterKeyMappingsEvent event) { event.register(OPEN_NOTES); }
private static void onClientTick(TickEvent.ClientTickEvent event) { if (event.phase != TickEvent.Phase.END) { return; } while (OPEN_NOTES.consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.dist == Dist.CLIENT) { OpenNotesKeys.register();}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}NeoForge 1.20.5 to 1.21.1, NeoForge 1.21.2 to 1.21.8
Section titled “NeoForge 1.20.5 to 1.21.1, NeoForge 1.21.2 to 1.21.8”Uses:
RegisterKeyMappingsEventKeyMappingLazyClientTickEvent.PostKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.neoforged.bus.api.IEventBus;import net.neoforged.neoforge.client.event.ClientTickEvent;import net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent;import net.neoforged.neoforge.common.NeoForge;import net.neoforged.neoforge.common.util.Lazy;
// The Open Notes key (R until changed in Controls): registered in RegisterKeyMappingsEvent, checked every client tick.public final class OpenNotesKeys { public static final Lazy<KeyMapping> OPEN_NOTES = Lazy.of(() -> new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, "key.categories.examplemod"));
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register(IEventBus modBus) { modBus.addListener(OpenNotesKeys::registerKeys); NeoForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void registerKeys(RegisterKeyMappingsEvent event) { event.register(OPEN_NOTES.get()); }
private static void onClientTick(ClientTickEvent.Post event) { while (OPEN_NOTES.get().consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.dist == Dist.CLIENT) { OpenNotesKeys.register(modEventBus);}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}NeoForge 1.20.2 to 1.20.4
Section titled “NeoForge 1.20.2 to 1.20.4”Uses:
RegisterKeyMappingsEventKeyMappingLazyTickEvent.ClientTickEventKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.neoforged.bus.api.IEventBus;import net.neoforged.neoforge.event.TickEvent;import net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent;import net.neoforged.neoforge.common.NeoForge;import net.neoforged.neoforge.common.util.Lazy;
// The Open Notes key (R until changed in Controls): registered in RegisterKeyMappingsEvent, checked every client tick.public final class OpenNotesKeys { public static final Lazy<KeyMapping> OPEN_NOTES = Lazy.of(() -> new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, "key.categories.examplemod"));
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register(IEventBus modBus) { modBus.addListener(OpenNotesKeys::registerKeys); NeoForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void registerKeys(RegisterKeyMappingsEvent event) { event.register(OPEN_NOTES.get()); }
private static void onClientTick(TickEvent.ClientTickEvent event) { while (OPEN_NOTES.get().consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.dist == Dist.CLIENT) { OpenNotesKeys.register(modEventBus);}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}NeoForge 1.21.9 to 1.21.10
Section titled “NeoForge 1.21.9 to 1.21.10”Uses:
RegisterKeyMappingsEventKeyMappingLazyClientTickEvent.PostKeyMapping.consumeClick
Since 1.21.9 a key’s category is a KeyMapping.Category you register, not a string; its Controls title is the lang key key.category.<namespace>.<path>.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.minecraft.resources.ResourceLocation;import net.neoforged.bus.api.IEventBus;import net.neoforged.neoforge.client.event.ClientTickEvent;import net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent;import net.neoforged.neoforge.common.NeoForge;import net.neoforged.neoforge.common.util.Lazy;
// The Open Notes key (R until changed in Controls): registered in RegisterKeyMappingsEvent, checked every client tick.public final class OpenNotesKeys { // Since 1.21.9 a key belongs to a registered category; its name is the lang key key.category.examplemod.main. private static final KeyMapping.Category CATEGORY = KeyMapping.Category.register(ResourceLocation.fromNamespaceAndPath("examplemod", "main"));
public static final Lazy<KeyMapping> OPEN_NOTES = Lazy.of(() -> new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, CATEGORY));
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register(IEventBus modBus) { modBus.addListener(OpenNotesKeys::registerKeys); NeoForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void registerKeys(RegisterKeyMappingsEvent event) { event.register(OPEN_NOTES.get()); }
private static void onClientTick(ClientTickEvent.Post event) { while (OPEN_NOTES.get().consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.getDist() == Dist.CLIENT) { OpenNotesKeys.register(modEventBus);}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.category.examplemod.main": "Example Mod"}Fabric 1.21.9 to 1.21.10
Section titled “Fabric 1.21.9 to 1.21.10”Uses:
KeyBindingHelper.registerKeyBindingKeyMappingInputConstantsClientTickEvents.END_CLIENT_TICKKeyMapping.consumeClick
Since 1.21.9 a key’s category is a KeyMapping.Category you register, not a string; its Controls title is the lang key key.category.<namespace>.<path>.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper;import net.minecraft.client.KeyMapping;import net.minecraft.network.chat.Component;import net.minecraft.resources.ResourceLocation;
// The Open Notes key (R until changed in Controls), registered with Fabric API's KeyBindingHelper.public final class OpenNotesKeys { // A category groups the keys in the Controls screen; its title is the lang key key.category.examplemod.examplemod. public static final KeyMapping.Category CATEGORY = KeyMapping.Category.register(ResourceLocation.fromNamespaceAndPath("examplemod", "examplemod")); public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, CATEGORY);
private OpenNotesKeys() { }
// Called from the mod's client entrypoint. public static void register() { KeyBindingHelper.registerKeyBinding(OPEN_NOTES); ClientTickEvents.END_CLIENT_TICK.register(client -> { while (OPEN_NOTES.consumeClick()) { if (client.player != null) { client.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }); }}In your client setup class, inside onInitializeClient:
OpenNotesKeys.register();In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.category.examplemod.examplemod": "Example Mod"}NeoForge 1.21.11
Section titled “NeoForge 1.21.11”Uses:
RegisterKeyMappingsEventKeyMappingLazyClientTickEvent.PostKeyMapping.consumeClick
Since 1.21.9 a key’s category is a KeyMapping.Category you register, not a string; its Controls title is the lang key key.category.<namespace>.<path>.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.minecraft.resources.Identifier;import net.neoforged.bus.api.IEventBus;import net.neoforged.neoforge.client.event.ClientTickEvent;import net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent;import net.neoforged.neoforge.common.NeoForge;import net.neoforged.neoforge.common.util.Lazy;
// The Open Notes key (R until changed in Controls): registered in RegisterKeyMappingsEvent, checked every client tick.public final class OpenNotesKeys { // Since 1.21.9 a key belongs to a registered category; its name is the lang key key.category.examplemod.main. private static final KeyMapping.Category CATEGORY = KeyMapping.Category.register(Identifier.fromNamespaceAndPath("examplemod", "main"));
public static final Lazy<KeyMapping> OPEN_NOTES = Lazy.of(() -> new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, CATEGORY));
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register(IEventBus modBus) { modBus.addListener(OpenNotesKeys::registerKeys); NeoForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void registerKeys(RegisterKeyMappingsEvent event) { event.register(OPEN_NOTES.get()); }
private static void onClientTick(ClientTickEvent.Post event) { while (OPEN_NOTES.get().consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.getDist() == Dist.CLIENT) { OpenNotesKeys.register(modEventBus);}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.category.examplemod.main": "Example Mod"}Fabric 1.21.11
Section titled “Fabric 1.21.11”Uses:
KeyBindingHelper.registerKeyBindingKeyMappingInputConstantsClientTickEvents.END_CLIENT_TICKKeyMapping.consumeClick
Since 1.21.9 a key’s category is a KeyMapping.Category you register, not a string; its Controls title is the lang key key.category.<namespace>.<path>.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper;import net.minecraft.client.KeyMapping;import net.minecraft.network.chat.Component;import net.minecraft.resources.Identifier;
// The Open Notes key (R until changed in Controls), registered with Fabric API's KeyBindingHelper.public final class OpenNotesKeys { // A category groups the keys in the Controls screen; its title is the lang key key.category.examplemod.examplemod. public static final KeyMapping.Category CATEGORY = KeyMapping.Category.register(Identifier.fromNamespaceAndPath("examplemod", "examplemod")); public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, CATEGORY);
private OpenNotesKeys() { }
// Called from the mod's client entrypoint. public static void register() { KeyBindingHelper.registerKeyBinding(OPEN_NOTES); ClientTickEvents.END_CLIENT_TICK.register(client -> { while (OPEN_NOTES.consumeClick()) { if (client.player != null) { client.player.displayClientMessage(Component.literal("Key pressed!"), true); } } }); }}In your client setup class, inside onInitializeClient:
OpenNotesKeys.register();In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.category.examplemod.examplemod": "Example Mod"}NeoForge 26.1 to 26.2
Section titled “NeoForge 26.1 to 26.2”Uses:
RegisterKeyMappingsEventKeyMappingLazyClientTickEvent.PostKeyMapping.consumeClick
Since 1.21.9 a key’s category is a KeyMapping.Category you register, not a string; its Controls title is the lang key key.category.<namespace>.<path>.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.minecraft.resources.Identifier;import net.neoforged.bus.api.IEventBus;import net.neoforged.neoforge.client.event.ClientTickEvent;import net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent;import net.neoforged.neoforge.common.NeoForge;import net.neoforged.neoforge.common.util.Lazy;
// The Open Notes key (R until changed in Controls): registered in RegisterKeyMappingsEvent, checked every client tick.public final class OpenNotesKeys { // Since 1.21.9 a key belongs to a registered category; its name is the lang key key.category.examplemod.main. private static final KeyMapping.Category CATEGORY = KeyMapping.Category.register(Identifier.fromNamespaceAndPath("examplemod", "main"));
public static final Lazy<KeyMapping> OPEN_NOTES = Lazy.of(() -> new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, CATEGORY));
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register(IEventBus modBus) { modBus.addListener(OpenNotesKeys::registerKeys); NeoForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void registerKeys(RegisterKeyMappingsEvent event) { event.register(OPEN_NOTES.get()); }
private static void onClientTick(ClientTickEvent.Post event) { while (OPEN_NOTES.get().consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.sendOverlayMessage(Component.literal("Key pressed!")); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.getDist() == Dist.CLIENT) { OpenNotesKeys.register(modEventBus);}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.category.examplemod.main": "Example Mod"}Fabric 26.1 to 26.2, Fabric 26.3
Section titled “Fabric 26.1 to 26.2, Fabric 26.3”Uses:
KeyBindingHelper.registerKeyBindingKeyMappingInputConstantsClientTickEvents.END_CLIENT_TICKKeyMapping.consumeClick
Since 1.21.9 a key’s category is a KeyMapping.Category you register, not a string; its Controls title is the lang key key.category.<namespace>.<path>.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;import net.fabricmc.fabric.api.client.keymapping.v1.KeyMappingHelper;import net.minecraft.client.KeyMapping;import net.minecraft.network.chat.Component;import net.minecraft.resources.Identifier;
// The Open Notes key (R until changed in Controls), registered with Fabric API's KeyMappingHelper.public final class OpenNotesKeys { // A category groups the keys in the Controls screen; its title is the lang key key.category.examplemod.examplemod. public static final KeyMapping.Category CATEGORY = KeyMapping.Category.register(Identifier.fromNamespaceAndPath("examplemod", "examplemod")); public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.KEY_R, CATEGORY);
private OpenNotesKeys() { }
// Called from the mod's client entrypoint. public static void register() { KeyMappingHelper.registerKeyMapping(OPEN_NOTES); ClientTickEvents.END_CLIENT_TICK.register(client -> { while (OPEN_NOTES.consumeClick()) { if (client.player != null) { client.player.sendOverlayMessage(Component.literal("Key pressed!")); } } }); }}In your client setup class, inside onInitializeClient:
OpenNotesKeys.register();In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.category.examplemod.examplemod": "Example Mod"}NeoForge 26.3
Section titled “NeoForge 26.3”Uses:
RegisterKeyMappingsEventKeyMappingLazyClientTickEvent.PostKeyMapping.consumeClick
Since 1.21.9 a key’s category is a KeyMapping.Category you register, not a string; its Controls title is the lang key key.category.<namespace>.<path>.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import com.mojang.blaze3d.platform.InputConstants;import net.minecraft.client.KeyMapping;import net.minecraft.client.Minecraft;import net.minecraft.network.chat.Component;import net.minecraft.resources.Identifier;import net.neoforged.bus.api.IEventBus;import net.neoforged.neoforge.client.event.ClientTickEvent;import net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent;import net.neoforged.neoforge.common.NeoForge;import net.neoforged.neoforge.common.util.Lazy;
// The Open Notes key (R until changed in Controls): registered in RegisterKeyMappingsEvent, checked every client tick.public final class OpenNotesKeys { // Since 1.21.9 a key belongs to a registered category; its name is the lang key key.category.examplemod.main. private static final KeyMapping.Category CATEGORY = KeyMapping.Category.register(Identifier.fromNamespaceAndPath("examplemod", "main"));
public static final Lazy<KeyMapping> OPEN_NOTES = Lazy.of(() -> new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYBOARD, InputConstants.KEY_R, CATEGORY));
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register(IEventBus modBus) { modBus.addListener(OpenNotesKeys::registerKeys); NeoForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void registerKeys(RegisterKeyMappingsEvent event) { event.register(OPEN_NOTES.get()); }
private static void onClientTick(ClientTickEvent.Post event) { while (OPEN_NOTES.get().consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.sendOverlayMessage(Component.literal("Key pressed!")); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.getDist() == Dist.CLIENT) { OpenNotesKeys.register(modEventBus);}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.category.examplemod.main": "Example Mod"}Fabric 1.18 to 1.18.2
Section titled “Fabric 1.18 to 1.18.2”Uses:
KeyBindingHelper.registerKeyBindingKeyMappingInputConstantsClientTickEvents.END_CLIENT_TICKKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import net.minecraft.network.chat.TextComponent;import com.mojang.blaze3d.platform.InputConstants;import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper;import net.minecraft.client.KeyMapping;import net.minecraft.network.chat.Component;
// The Open Notes key (R until changed in Controls), registered with Fabric API's KeyBindingHelper.public final class OpenNotesKeys { public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, InputConstants.KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from the mod's client entrypoint. public static void register() { KeyBindingHelper.registerKeyBinding(OPEN_NOTES); ClientTickEvents.END_CLIENT_TICK.register(client -> { while (OPEN_NOTES.consumeClick()) { if (client.player != null) { client.player.displayClientMessage(new TextComponent("Key pressed!"), true); } } }); }}In your client setup class, inside onInitializeClient:
OpenNotesKeys.register();In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}Forge 1.16.5
Section titled “Forge 1.16.5”Uses:
KeyBindingClientRegistry.registerKeyBindingKeyBinding.consumeClickTickEvent.ClientTickEvent
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import net.minecraft.client.Minecraft;import net.minecraft.client.settings.KeyBinding;import net.minecraft.util.text.StringTextComponent;import net.minecraftforge.common.MinecraftForge;import net.minecraftforge.event.TickEvent;import net.minecraftforge.fml.client.registry.ClientRegistry;import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import org.lwjgl.glfw.GLFW;
// The Open Notes key (R until changed in Controls): registered in FMLClientSetupEvent, checked every client tick.public final class OpenNotesKeys { public static final KeyBinding OPEN_NOTES = new KeyBinding("key.examplemod.open_notes", GLFW.GLFW_KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from the mod's constructor, in the client only. public static void register() { FMLJavaModLoadingContext.get().getModEventBus().addListener(OpenNotesKeys::onClientSetup); MinecraftForge.EVENT_BUS.addListener(OpenNotesKeys::onClientTick); }
private static void onClientSetup(FMLClientSetupEvent event) { ClientRegistry.registerKeyBinding(OPEN_NOTES); }
private static void onClientTick(TickEvent.ClientTickEvent event) { if (event.phase != TickEvent.Phase.END) { return; } while (OPEN_NOTES.consumeClick()) { Minecraft minecraft = Minecraft.getInstance(); if (minecraft.player != null) { minecraft.player.displayClientMessage(new StringTextComponent("Key pressed!"), true); } } }}In your main mod class, inside <init>:
if (FMLEnvironment.dist == Dist.CLIENT) { OpenNotesKeys.register();}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}Fabric 1.16.5 to 1.17.1
Section titled “Fabric 1.16.5 to 1.17.1”Uses:
KeyBindingHelper.registerKeyBindingKeyMappingInputConstantsClientTickEvents.END_CLIENT_TICKKeyMapping.consumeClick
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import net.minecraft.network.chat.TextComponent;import com.mojang.blaze3d.platform.InputConstants;import org.lwjgl.glfw.GLFW;import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper;import net.minecraft.client.KeyMapping;import net.minecraft.network.chat.Component;
// The Open Notes key (R until changed in Controls), registered with Fabric API's KeyBindingHelper.public final class OpenNotesKeys { public static final KeyMapping OPEN_NOTES = new KeyMapping("key.examplemod.open_notes", InputConstants.Type.KEYSYM, GLFW.GLFW_KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from the mod's client entrypoint. public static void register() { KeyBindingHelper.registerKeyBinding(OPEN_NOTES); ClientTickEvents.END_CLIENT_TICK.register(client -> { while (OPEN_NOTES.consumeClick()) { if (client.player != null) { client.player.displayClientMessage(new TextComponent("Key pressed!"), true); } } }); }}In your client setup class, inside onInitializeClient:
OpenNotesKeys.register();In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}Forge 1.12.2
Section titled “Forge 1.12.2”Uses:
KeyBindingClientRegistry.registerKeyBindingKeyBinding.isPressedTickEvent.ClientTickEvent
In 1.12.2 the class is KeyBinding, registered with ClientRegistry.registerKeyBinding, and you check isPressed() in a client tick handler.
src/main/java/com/example/examplemod/client/OpenNotesKeys.java
package com.example.examplemod.client;
import net.minecraft.client.Minecraft;import net.minecraft.client.settings.KeyBinding;import net.minecraft.util.text.TextComponentString;import net.minecraftforge.common.MinecraftForge;import net.minecraftforge.fml.client.registry.ClientRegistry;import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;import net.minecraftforge.fml.common.gameevent.TickEvent;import org.lwjgl.input.Keyboard;
// The Open Notes key (R until changed in Controls): registered with ClientRegistry, checked every client tick.public final class OpenNotesKeys { public static final KeyBinding OPEN_NOTES = new KeyBinding("key.examplemod.open_notes", Keyboard.KEY_R, "key.categories.examplemod");
private OpenNotesKeys() { }
// Called from preInit, in the client only. public static void register() { ClientRegistry.registerKeyBinding(OPEN_NOTES); MinecraftForge.EVENT_BUS.register(new OpenNotesKeys()); }
@SubscribeEvent public void onClientTick(TickEvent.ClientTickEvent event) { if (event.phase != TickEvent.Phase.END) { return; } while (OPEN_NOTES.isPressed()) { Minecraft minecraft = Minecraft.getMinecraft(); if (minecraft.player != null) { minecraft.player.sendStatusMessage(new TextComponentString("Key pressed!"), true); } } }}In your main mod class, inside preInit:
if (event.getSide() == Side.CLIENT) { OpenNotesKeys.register();}In src/main/resources/assets/examplemod/lang/en_us.json:
{ "key.examplemod.open_notes": "Open Notes", "key.categories.examplemod": "Example Mod"}Sources
Section titled “Sources”- https://docs.fabricmc.net/1.21.11/develop/key-mappings
- https://maven.fabricmc.net/docs/fabric-api-0.116.17+1.21.1/net/fabricmc/fabric/api/client/keybinding/v1/KeyBindingHelper.html
- https://docs.neoforged.net/docs/1.21.1/misc/keymappings
Related how-tos
Section titled “Related how-tos”- Draw text on the screen
- Open a screen from an item
- A command that runs on the client
- A mob with attributes and a spawn egg
- Send data from a player’s game to the server
In Linen
Section titled “In Linen”Linen’s How-tos library has this page too, with the example for your own mod’s loader and Minecraft version. Hover a name in your code and Linen points to the how-tos that explain it. Both are free. Download Linen.