Spatial GUI

A client-side Minecraft mod that turns screens into immersive 3D displays, with fully configurable first-person and third-person modes.

Features

General

• Visual editor
• Per-screen enable and disable lists for mod compatibility
• Optional world blur behind the screen
• Screen drop shadow
• Configurable HUD and hotbar visibility
• Adjustable GUI scale, render scale, screen opacity, and FOV-aware scaling
• Screen opening animation
• FOV override
• Auto-detect camera mode, switches the camera mode based on perspective

First-person Mode

• Crosshair and mouse modes
• Screen position, distance, scale, and rotation are all configurable
• Configurable screen opening animation
• Curved screen option, especially good with mods that add large GUI extensions, such as JEI

Third-person Mode

• Camera and screen position, distance, scale, and rotation are all configurable
• Configurable avatar body rotation
• Smooth camera transition and configurable screen opening animation
• Optional fallback to first person when the camera is blocked

Dependencies

| Loader | Mod |
|——–|———————–|
| All | YACL |
| Fabric | Fabric API & Mod Menu |

Configuration

Open the config through the keybind (unbound by default), Mod Menu, or the config file.
Spatial GUI has many options, so it is worth looking through them to tailor the mod to your preferences.

For advanced users and modpack creators, per-screen configuration profiles are supported via config/spatial-gui/profiles.json5. This file contains documentation.

Visual Editor

Spatial GUI includes a built-in visual editor that lets you configure screen position, scale, rotation, and more in real-time. You can also create and manage profiles for different screens. Press the button in the config to enter editor mode, or bind it to a keybind in controls.

Profile Picker

You can assign different editor profiles to specific screens. Press the profile picker key (backtick/tilde by default) while a screen is open to select a profile.

Compatibility

Spatial GUI is a client-side mod and does not need to be installed on the server.

However, compatibility isn’t guaranteed with every mod. Spatial GUI modifies GUI and camera rendering, which may conflict with mods that modify these as well.

If you find a reproducible incompatibility with another mod, please report it on GitHub so it can be investigated. Reporting an issue helps make the mod better for everyone!

Warning: Lunar Client is not supported. Lunar Client modifies Minecraft’s rendering in ways that are incompatible with Spatial GUI. While it’s not completely incompatible and still functions in most cases, issues caused by using Lunar Client will not be addressed.

FAQ

| Question | Answer |
|————————————————-|—————————————————————————————————————————————————————————————————————–|
| Does Spatial GUI work in multiplayer? | Yes. Other players and the server do not need to have Spatial GUI installed. |
| Does Spatial GUI give a gameplay advantage? | Spatial GUI is primarily visual and does not add or automate gameplay mechanics. Some settings can change how the camera behaves, so whether it is allowed on a particular server is up to that server’s rules. |
| Is Spatial GUI compatible with _____? | Probably! However, compatibility isn’t guaranteed, especially with mods that modify GUIs, cameras, or rendering. If you encounter an issue with a specific mod, feel free to report it on GitHub. |
| Why is my GUI behaving strangely? | Another installed mod may be incompatible. Try to identify the mod involved, then check existing GitHub issues or open a new issue with steps to reproduce the problem. |
| Why is my GUI blurry? | This is usually caused by another mod or a client. Try and figure out which mod is causing this, or look in your client settings for terms like ‘blur’ and ‘background’. |
| Can I use Spatial GUI in a modpack? | Yes. Spatial GUI is welcome in modpacks and no additional permission is required. Compatibility with other mods is not guaranteed. |
| Is Spatial GUI purely visual? | Almost entirely. Spatial GUI changes how existing screens and the camera are presented. One setting intentionally allows your rotation to persist after closing a GUI, which can turn your character’s view. |

Notes

• Feel free to suggest features or report bugs on the GitHub.
• Spatial GUI is welcome in modpacks, no additional permission required. Be aware that compatibility with some mods may vary.

Special thanks to:

vibing for all of their GitHub contributions
Dizabanik for tons of code fixes and improvements
BUILDLCS for the Brazilian Portuguese translation
suheckii for the Russian translation
22SSendo & jankeverse for particularly awesome feature suggestions
Anyone else who reported bugs or suggested features 🙂