## Smart Key Prompts<\/p>\n
#### ***Need OneEngoughLib from 1.1.2 on!***<\/p>\n
This mod provides a **flexible and dynamic key prompt system**, along with extended features for **customizable key modification**.
\nIt improves the overall player experience and helps streamline key management.<\/p>\n
—<\/p>\n
### How to Use<\/p>\n
For **regular players**, simply install and play\u2014no setup required.<\/p>\n
For **developers**, there are four ways to add new key prompts in-game:<\/p>\n
* The target mod actively integrates with Smart Key Prompts.
\n* Use **KubeJS** to call the API provided by this mod.
\n* Add support via **datapacks** (with certain limitations; see the Datapack Extension Guide).
\n* Added directly through **built-in adaptation** within this mod.<\/p>\n
—<\/p>\n
### Main Features<\/p>\n
This mod selectively displays relevant key prompts at appropriate times.
\nIt provides flexible APIs for mod or modpack developers to show context-based key hints.<\/p>\n
“`java
\n\/\/ Display an existing registered keybinding.
\nshow(String group, String desc);<\/p>\n
\/\/ Display a fully custom key prompt.
\ncustom(String group, String key, String desc);<\/p>\n
\/\/ Display an existing registered keybinding under an alias.
\nalias(String group, String desc, String alias);
\n“`<\/p>\n
Simply call these methods under certain conditions (e.g., during the client tick event) to display contextual key prompts.
\nFor detailed implementation examples, see below.<\/p>\n
Datapack-based prompts are also supported, though with limited condition logic and syntax\u2014best suited for simpler use cases.
\nSee Datapack Extension Guide for more information.<\/p>\n
Example output:<\/p>\n
<\/p>\n
Each method\u2019s `group` parameter represents a key prompt group ID.
\nFor example, this mod uses `”jei_skp”` as the group ID when integrating with JEI, which is disabled by default.
\nYou can freely enable or disable any group in the configuration file using its group ID.<\/p>\n
When key prompts are visible on screen, pressing **Control Key (default: K) + Left Click** will open the corresponding keybinding menu directly\u2014no need to search through the full list.<\/p>\n
Example:<\/p>\n
<\/p>\n
Note that this shortcut only works for prompts linked to registered keybindings (`show`, `alias`),
\nand **not** for fully custom prompts (`custom`).<\/p>\n
Additionally, you can programmatically trigger the configuration interface for specific keybindings:<\/p>\n
“`java Holding the control key locks the current key prompts, making them persist temporarily.<\/p>\n Lastly, **Control Key + Right Click** toggles HUD visibility and position. —<\/p>\n ### Flexible Prompting System<\/p>\n The `”key”` and `”desc”` fields refer to entries in the language files.<\/p>\n For example, in Minecraft\u2019s default language file `assetsminecraftlangen_us.json`:<\/p>\n “`json And in TaCZ\u2019s language file `assetstaczlangzh_cn.json`:<\/p>\n “`json Example usage in a mod:<\/p>\n “`java Usage in **KubeJS**:<\/p>\n “`javascript For **combination keys**, you can use:<\/p>\n “`java Datapack-based configuration example (see the guide):<\/p>\n “`json Extended example: show interaction prompts below the crosshair when targeting an entity.<\/p>\n “`java Both `”custom”` and `”position”` can be customized. Smart Key Prompts also provides various utility methods\u2014such as key detection and entity targeting\u2014to simplify mod development.<\/p>\n —<\/p>\n ### Flexible Disabling<\/p>\n When holding the control key (default: K), prompts become **locked**, and their full identifiers (`group:desc`) are displayed.<\/p>\n In KubeJS, you can enable or disable prompts dynamically:<\/p>\n “`javascript You can also disable or re-enable specific keybindings:<\/p>\n “`javascript For example, calling `disableKeyMapping(“key.jump”)` prevents the player from jumping.<\/p>\n —<\/p>\n ### Other Information<\/p>\n If you\u2019d like this mod to support another mod, feel free to reach out. **Recommended companion mod:** KeyBindJS<\/p>\n **Planned features:**<\/p>\n * More prompt positions (e.g., follow mouse). See the full list of supported mods in the official documentation.<\/p>\n","protected":false},"excerpt":{"rendered":" Flexible on-screen key prompts and convenient key remapping features.<\/p>\n","protected":false},"featured_media":143696,"template":"","meta":{"_minecraft_slug":"smart-key-prompts","_minecraft_project_id":"E2pYUra0","_minecraft_author":"MerrySnow","_minecraft_license":"GPL-3.0-only","_minecraft_downloads":48366,"_minecraft_follows":26,"_minecraft_client_side":"required","_minecraft_server_side":"unsupported","_minecraft_storage_type":"zip","_minecraft_archive_name":"smart-key-prompts.zip","_minecraft_size_bytes":10778443,"_minecraft_version_count":22,"_minecraft_updated_at":"2026-05-16T09:41:39.666427Z","_minecraft_date_created":"2025-07-18T06:59:52.160107Z","_minecraft_date_modified":"2026-04-02T15:45:32.404422Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/smart-key-prompts","_minecraft_icon_attachment_id":143696,"_minecraft_imported_at":"2026-06-08T13:49:45+00:00","_minecraft_import_hash":"777afe78c7648da286caed149a1b2461","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,104,158,92],"mod_loader":[99,106],"minecraft_version":[36,60,93,94,101,102,62,37],"class_list":["post-143695","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-forge","mod_category-neoforge","mod_category-utility","mod_loader-fabric","mod_loader-forge","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1"],"yoast_head":"\n
\nConfigAction.modifyKey(List
\n“`<\/p>\n
\nWhile holding Control, you can use the mouse wheel to adjust the HUD size.<\/p>\n
\n{
\n “key.keyboard.f11”: “F11”,
\n “key.keyboard.left.shift”: “Left Shift”,
\n “key.mouse.left”: “Left Button”
\n}
\n“`<\/p>\n
\n{
\n “key.tacz.fire_select.desc”: “Fire Mode”,
\n “key.tacz.inspect.desc”: “Inspect”,
\n “key.tacz.interact.desc”: “Interact while armed”
\n}
\n“`<\/p>\n
\n@SubscribeEvent
\npublic static void tick(TickEvent.ClientTickEvent event) {
\n if (!ModList.get().isLoaded(“immersive_aircraft”)) return;
\n Player player = Minecraft.getInstance().player;
\n if (player == null || Minecraft.getInstance().screen != null) return;
\n String vehicle = Utils.getVehicleType(player);
\n if (vehicle != null && vehicle.startsWith(“immersive_aircraft:”)) {
\n SmartKeyPrompts.custom(modid, Utils.getKeyByDesc(“key.inventory”), “immersive_aircraft.slot.upgrade”);
\n SmartKeyPrompts.show(modid, “key.immersive_aircraft.dismount”);
\n String keyUse = Utils.getKeyByDesc(“key.immersive_aircraft.fallback_use”);
\n SmartKeyPrompts.custom(modid, Objects.equals(keyUse, “key.keyboard.unknown”) ? “key.mouse.right” : keyUse, “item.immersive_aircraft.item.weapon”);
\n if (vehicle.equals(“immersive_aircraft:biplane”)) {
\n SmartKeyPrompts.custom(modid, Utils.getKeyByDesc(“key.jump”), “item.immersive_aircraft.engine”);
\n }
\n }
\n}
\n“`<\/p>\n
\nClientEvents.tick(event => {
\n let player = event.player;
\n if ([“key.left”, “key.right”, “key.forward”, “key.back”].map(desc => SKP$KeyUtils.isKeyPressedOfDesc(desc)).includes(true)) {
\n SKP$PromptUtils.show(“parcool”, “key.parcool.Dodge”);
\n }
\n if (!player.onGround() && !player.isInWater()) {
\n SKP$PromptUtils.show(“parcool”, “key.parcool.Breakfall”);
\n SKP$PromptUtils.show(“parcool”, “key.parcool.ClingToCliff”);
\n }
\n if (player.isSprinting()) {
\n SKP$PromptUtils.show(“parcool”, “key.parcool.FastRun”);
\n }
\n if (SKP$KeyUtils.isKeyPressedOfDesc(“key.parcool.FastRun”)) {
\n SKP$PromptUtils.show(“parcool”, SKP$KeyUtils.getKeyByDesc(“key.parcool.Dodge”));
\n SKP$PromptUtils.custom(“parcool”, SKP$KeyUtils.getKeyByDesc(“key.sneak”), “parcool.action.CatLeap”);
\n }
\n});
\n“`<\/p>\n
\nSmartKeyPrompts.custom(modid, “key.keyboard.left.shift+key.mouse.left”, “Transfer items in bulk”);
\n“`<\/p>\n
\n{
\n “modid”: “tacz_skp”,
\n “vars”: {
\n “modLoaded”: “isModLoaded(‘tacz’)”,
\n “hasTaczGun”: “mainHandItem == ‘tacz:modern_kinetic_gun'”,
\n “isNotInVehicle”: “!isInVehicle()”
\n },
\n “entries”: [
\n {
\n “when”: {
\n “modLoaded”: “true”,
\n “hasTaczGun”: “true”,
\n “isNotInVehicle”: “true”
\n },
\n “then”: [
\n “show(‘tacz_skp’, ‘key.tacz.shoot.desc’)”,
\n “show(‘tacz_skp’, ‘key.tacz.zoom.desc’)”,
\n “show(‘tacz_skp’, ‘key.tacz.reload.desc’)”
\n ]
\n }
\n ]
\n}
\n“`<\/p>\n
\n@SubscribeEvent
\npublic static void tick(TickEvent.ClientTickEvent event) {
\n if (!ModList.get().isLoaded(modid)) return;
\n if (PlayerUtils.getTargetedEntityType() == “minecraft:pig”) {
\n PromptUtils.addDesc(“key.pig.feed”).forKey(“key.mouse.right”).withCustom(true).atPosition(“crosshair”).toGroup(modid);
\n }
\n}
\n“`<\/p>\n
\nThe `”custom”` flag determines whether the prompt appears in the filtered keybinding menu,
\nand `”position”` controls where the prompt is displayed (fixed, unaffected by HUD repositioning).<\/p>\n
\nSKP$PromptUtils.disablePromptByGroup(String group)
\nSKP$PromptUtils.enablePromptByGroup(String group)
\nSKP$PromptUtils.disablePromptByDesc(String desc)
\nSKP$PromptUtils.enablePromptByDesc(String desc)
\nSKP$PromptUtils.disablePrompt(String group, String desc)
\nSKP$PromptUtils.enablePrompt(String group, String desc)
\n“`<\/p>\n
\nSKP$KeyUtils.isKeyDisabled(String desc)
\nSKP$KeyUtils.getDisabledKeyMappingList()
\nSKP$KeyUtils.disableKeyMapping(String desc)
\nSKP$KeyUtils.disableKeyMapping(List
\nSKP$KeyUtils.disableAllKeyMapping()
\nSKP$KeyUtils.enableKeyMapping(String desc)
\nSKP$KeyUtils.enableKeyMapping(List
\nSKP$KeyUtils.enableAllKeyMapping()
\n“`<\/p>\n
\nYou can also submit new key prompt groups directly to the repository.<\/p>\n
\n* Support for double-tap and long-press keys.
\n* HUD visual improvements.
\n* Potential backports to more Minecraft versions.<\/p>\n