ViewBoard

ViewBoard is a client-side NeoForge mod for Minecraft 1.21.11 that adds a keyboard map screen and keybind-management tools to the controls menu. The screens help show which keys are used, conflicting, ignored, grouped, or still free.

This branch (neoforge-1.21.11) targets Minecraft 1.21.11 on NeoForge 21.11.42.

ViewBoard supports most GUI scales, but the keyboard view is currently most comfortable at GUI scale 3 or below.

Requirements

• Java 21
• Minecraft 1.21.11
• NeoForge 21.11.42

New Features in 1.1.0+

• Support for most GUI scales, with the best results at GUI scale 3 or below
• An ignore system for keybinds that lets intentional conflicts exist without warnings
• Vanilla Controls / Key Binds integration that respects ignored keybinds and suppresses those warnings there too
• A keybind group system where grouped keybinds share a forced key until they are removed from the group
• Multiple keyboard layouts in the keyboard view: QWERTY, AZERTY, and QWERTZ
• Mouse button support in the keyboard view
• Detection and display of custom keys assigned through Minecraft's keybind settings

Usage

1. Open Minecraft's Controls / Key Binds screen.
2. Use the Keyboard View button in the bottom-right corner to open the keyboard map.
3. Hover keys in the keyboard view to inspect conflicts, ignored bindings, and grouped bindings.
4. Use Manage Rules to open the Keybind Rules screen.
5. In Keybind Rules, search keybinds, toggle whether a binding is ignored, and jump into group editing for a specific keybind.
6. In Keybind Groups, create a group, rename it, assign a shared trigger key, and add or remove bindings from that group.
7. When a binding is marked as ignored, ViewBoard and the vanilla keybind screen both stop warning about that intentional conflict.

Build

Use the Gradle wrapper from the project root:

./gradlew clean build

Built jars are written to:

build/libs/

The build produces both the mod jar and a matching -sources jar. The generated filenames follow this pattern:

viewboard-neoforge-<minecraft-version>-<mod-version>.jar
viewboard-neoforge-<minecraft-version>-<mod-version>-sources.jar

For example:

viewboard-neoforge-1.21.11-1.1.0.jar
viewboard-neoforge-1.21.11-1.1.0-sources.jar

Project Layout

• src/main/java contains the mod source code
• src/main/resources contains metadata and assets
• build.gradle and gradle.properties define the NeoForge build

Mod ID

The mod ID is viewboard.

License

This project is licensed under the MIT License. See LICENSE for details.