Skip to content
This repository has been archived by the owner on Aug 3, 2024. It is now read-only.

Usage Instructions

galister edited this page May 24, 2023 · 10 revisions

Legend

  • 🖊 means that a feature is customizable in config.yaml
  • 🎮 means that a binding can be customized in SteamVR.

Watch

The watch should be on your left🖊 hand by default.

Top row: Battery indicators

  • L/R: Controllers, T: Trackers
  • Will not show Oculus / other non-SteamVR controllers.

Middle row

  • Date and time, world clock🖊
  • Volume rocker🖊

Bottom row

  • Screens and keyboard
    • Click to hide/show.
    • If you misplaced a screen or the keyboard, long click its button (2s+) and release to reset.

To change brightness on all overlays, aim the pointer over the watch and use joystick up/down.

Pointer Modes

There are 3 modes, used extensively in many different ways, indicated by the color of the laser:

  • Blue: left click - keep your thumb off of A/B/X/Y
  • Orange: right click - touch the B/Y button with your thumb🎮
  • Purple: middle click - touch the A/X button with your thumb🎮

Clicking is done using the trigger🎮, while the modifier changes what happens on click.

When clicking, the pointer will freeze in place for a short time🖊 in order to help with double clicks.

Handling Overlays

Show/hide your last layout by double pressing B/Y🎮 on the left controller. By default it will show your primary screen🖊 and keyboard.

Grab and move using the grip🎮! While grabbing, joystick up/down🎮 to move near/far.

Resize overlays: while grabbing, tilt your controller so that your palm faces upwards, until you get a purple pointer. Then, use joystick up/down🎮 to resize.

Screen curvature can be enabled by clicking on the grabbing hand while a screen is held. The screen will be forced upright while curved.

Keyboard

The keyboard has 3 modes. The mode comes from the color of the pointer being pointed at the keyboard.

If both pointers are on the keyboard, right🖊 hand takes precedence.

  • Blue - regular keyboard layout
  • Orange - regular layout with shift
  • Purple - alternative (Fn) layout

The keyboard is fully customizable!

Advanced Features

Playspace Mover

WlxOverlay comes with a playspace mover for all your space dragging pleasure.

In order to use it, you will need to bind the spacedrag binding in SteamVR.

If you're having trouble with the SteamVR Bindings screen freezing, try this patch.

It is expected that the movement is jittery and not completely smooth. This is a limitation of SteamVR on Linux.

Floor Fix

Used to quickly set the floor height. Upon clicking, you will have 5 seconds to place either one of your controllers on the floor.

Colors

Used to adjust the brightness across all of SteamVR. You may also modify the colors in case you want a warmer image for night, or whatever your eyeballs crave.

Strokes

Used to draw lines in your playspace to save for later. Can be used for marking boundaries, furniture, etc. Especially useful for headsets that do not support stage tracking, like the Pico.

Creating a new polygon

  • Click New Polygon
  • The white dot in front of your right hand is your cursor that your draw with.
  • Click with the right trigger once, to start your polygon.
  • Click right trigger to add segments to the polygon. The height axis is locked unless you hold B/Y.
  • When done drawing, click Finish on the watch. This will connect the last point to the first point to form a closed polygon.

You may create any number of polygons, but there's a global limit of 128 overlays in SteamVR, with each line segment being its own overlay.

Reference points

Saving and loading is done using two reference points. These are points in your real life room that you don't expect to change over time.

You will be placing your controllers at each of the reference points when loading or saving the layout.

It's important that you place the controllers in the same exact spot every time. Rotation of the controllers do not matter.

The controllers cannot be swapped. Left goes in the same spot every time, and right goes in the same spot every time.

The points should be at least 1 meter or 3 feet apart for adequate precision. The further away, the better.

Examples of good reference points:

  • cracks in your couch
  • edges of a table or other furniture
  • inside edges of a shelf

Saving/Loading your layout

Click Save or Load. You will have 10 seconds to place your controllers in their reference positions.

Enjoy

I hope WlxOverlay proves a useful utility. Don't hesitate to reach out if you need help. https://discord.gg/gHwJ2vwSWV