https://github.com/mxumx/viewboard
Mod that adds a keybord preview that shows which keys are used in minecraft
https://github.com/mxumx/viewboard
client-side minecraft minecraft-client-side minecraft-mod minecraft-neoforge minecraft-neoforge-mod neoforge neoforge-mod
Last synced: about 1 month ago
JSON representation
Mod that adds a keybord preview that shows which keys are used in minecraft
- Host: GitHub
- URL: https://github.com/mxumx/viewboard
- Owner: MXUMX
- License: mit
- Created: 2026-04-05T00:39:33.000Z (about 2 months ago)
- Default Branch: neoforge-1.21.11
- Last Pushed: 2026-04-25T05:05:03.000Z (about 1 month ago)
- Last Synced: 2026-04-25T07:13:05.370Z (about 1 month ago)
- Topics: client-side, minecraft, minecraft-client-side, minecraft-mod, minecraft-neoforge, minecraft-neoforge-mod, neoforge, neoforge-mod
- Language: Java
- Homepage: https://modrinth.com/mod/viewboard
- Size: 41.7 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ViewBoard
[
](https://modrinth.com/mod/viewboard) [
](https://www.curseforge.com/minecraft/mc-mods/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:
```bash
./gradlew clean build
```
Built jars are written to:
```text
build/libs/
```
The build produces both the mod jar and a matching `-sources` jar. The generated filenames follow this pattern:
```text
viewboard-neoforge--.jar
viewboard-neoforge---sources.jar
```
For example:
```text
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.