From bae19cb130da7e32881bd7fe02117aa93a258419 Mon Sep 17 00:00:00 2001 From: Netboy3 <1472804+netboy3@users.noreply.github.com> Date: Mon, 2 Aug 2021 09:08:55 -0400 Subject: [PATCH] [doc] install: Add Overlay Mode section --- doc/install.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/install.rst b/doc/install.rst index c9f27cae..3f98fa06 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -297,6 +297,30 @@ The format of this file is the commonly known INI format, for example:: Command line arguments will override any options loaded from the config files. +.. _client_overlay_mode: + +Overlay Mode +~~~~~~~~~~~~ + +Looking-Glass is utilizing an overlay layer to draw various widgets (such +as the FPS display). An "Overlay Mode" can be toggled (see +:ref:`client_key_bindings`) that allows editing and modifying widgets +properties, such as their position and size. To use the Overlay Mode: + +- Enable one or more widgets (such as the FPS display) +- Enter Overlay Mode by using its keybinding (the screen will turn + darker to indicate Overlay Mode is active) +- Drag the widgets you enabled to your preferred position +- Change the widget size (if the widget allows you) by dragging the + lower right edge +- Change any other properties a widget has and are modifiable +- Exit Overlay Mode by pressing :kbd:`ESC` or using the Overlay-Mode + keybinding again + +Modifications done in Overlay Mode are persistent and are stored +in a special config file $XDG_CONFIG_HOME/looking-glass/imgui.ini. +Please refrain from editing this file manually as your changes might +be overwritten by the client. .. _client_full_command_options: