Overlays guide

WIKI is in development, some topics might not be finished or missing

What are overlays

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.
• Multiple custom overlays can be created using the same template (for example, creating 3–4 Button overlays).

Getting started

Editing overlays

• Open VR Settings.
• Click on Setup Overlays. (Right side of VR Settings)

You should see this:

1. List of overlays available (depends on filters applied)
2. Search text box and Filters button - Useful in case you have many overlays
3. Info about selected overlay - Its name, addon which handles its logic, identifier, template name (if custom overlay), overlay icon, description
4. 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"!!

Creating new overlays

• Open VR Settings.
• Click on Setup Overlays. (Right side of VR Settings)
• Click on Create Overlay tab.

You should see this:

1. 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.
2. Specify Overlay Name - Name displayed in overlay settings, something what should shortly describe what your overlay is for
3. Specify Overlay Description (Optional) - Detailed description displayed in overlay settings. In most cases just ignore it. Useful for Modpacks or Visor presets creators
4. Specify Overlay icon (Optional) - Icon for an overlay. In most cases just ignore it. Useful for Modpacks or Visor presets creators
5. Select Overlay template - Select the template you want to use for your overlay. Button, HUD, Chat etc...
6. 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

Expansion on Overlays

• You can do more with overlays and templates by making addons. Check out how to create an addon to get started.