-
-
Notifications
You must be signed in to change notification settings - Fork 21
Overlays guide
WIKI is in development, some topics might not be finished or missing
Overlays are 2D graphical user interfaces for VR. Powerful Visor feature, highly customizable.
Built-in overlays - Created by Visor or Visor addons.
They are limited in options, some of them don't even have options at all. For example: keyboard, hotbar, movementState
Custom overlays - Created and fully controlled by you!
Every custom overlay is based on overlay template - it is a foundation of custom overlay, providing its logic and customization options.
- Open VR Settings.
- Click on Setup Overlays. (Right side of VR Settings)
You should see this:
- List of overlays available (depends on filters applied)
- Search text box and Filters button - Useful in case you have many overlays
- Info about selected overlay - Its name, addon which handles its logic, identifier, template name (if custom overlay), overlay icon, description
- Edit options - here you can select options to modify, loadDefaults (defaults are delivered from template or built-in overlay). If it is a custom overlay, you can delete it. When you finished editing options, don't forget to click "Save"!!
- Open VR Settings.
- Click on Setup Overlays. (Right side of VR Settings)
- Click on Create Overlay tab.
You should see this:
- Specify Overlay Id - it is Visor's internal identifier for your overlay and a name for its config file. You can type whatever you want. For convenience, it is strongly suggested to type id similar to overlay's name. For example: id "hud_health", name "HUD Health".
- Specify Overlay Name - Name displayed in overlay settings, something what should shortly describe what your overlay is for
- Specify Overlay Description (Optional) - Detailed description displayed in overlay settings. In most cases just ignore it. Useful for Modpacks or Visor presets creators
- Specify Overlay icon (Optional) - Icon for an overlay. In most cases just ignore it. Useful for Modpacks or Visor presets creators
- Select Overlay template - Select the template you want to use for your overlay. Button, HUD, Chat etc...
- Create and finish - Once you specified "Id" and "Name" correctly as well as selected template, you can finish to move on to configure overlay's options
Visor features both built-in overlays and support for custom user created overlays.
- Navigate to the Create Overlay tab.
- Select one of the three available Template Types:
HUDButtonChat
- Set an Overlay ID:
The Overlay ID serves as Visor's internal identifier and becomes the filename for its
.jsonconfiguration file. - Multiple custom overlays can be created using the same template type (for example, creating 3–4 distinct HUD overlays).
When editing an overlay, options are organized into the following tabs:
- Name & Description: Custom labels for identifying the overlay.
-
Icon: Accepts resource file paths to display custom textures (e.g.,
minecraft:textures/item/bundle.pngrenders an open bundle texture). You can reference texture paths using a Template Resource Pack on Curseforge.
- Toggle: Controls whether the overlay is currently active or hidden.
- HUD Layer: Toggle to render the overlay on top of standard world objects and menus.
-
Anchor: Attaches the overlay to a relative reference point:
-
None- Hides the overlay. -
HMD- Anchors the overlay to your head/headset. -
MainHand- Anchors the overlay to your right hand. -
Offhand- Anchors the overlay to your left hand.
-
- Position Sliders (X, Y, Z): Adjusts offset relative to the anchor point.
-
Rotation Sliders (X, Y, Z): Adjusts orientation.
A 180 degree rotation is approximately Pi,
3.14159. A 90 degree rotation is approximately1.57079, half of Pi. - Rotation Aimed: Forces the overlay to face its anchor point dynamically.
- Scale: Sets the overall physical size of the overlay. Default is 0.15.
- Hand Lock Tool: Clicking the lock button on the bottom right anchors the overlay to your physical hand; pulling the trigger drops and places it at your hand's current position.
- Copy Transform: Use the green copy button on the right to duplicate current position and rotation values.
Captures a specific 2D screen region from the standard Minecraft HUD and projects it into 3D space.
-
Settings: Manual
X,Y,Width, andHeightsliders, or click and drag directly on the screen preview to select a region.
Creates an interactive touch button in VR space that executes specific actions when pressed.
-
Settings:
Width,Height,Button Text,Text Color,Visibility(AlwaysorIn Game),Button Color/Texture(e.g.,minecraft:textures/item/bundle.png). -
Actions:
- Keyboard Keybind (e.g., press
Rfor weapon mods to reload) - Run a Command
- Toggle Visibility of other overlays
- VR Keybind
- Keyboard Keybind (e.g., press
Displays the Minecraft chat box as a standalone VR overlay.
-
Settings:
Update Options(Tick,Frame, orOff).
- You can do more with overlays by making addons. Check out how to create an addon to get started.