-
-
Notifications
You must be signed in to change notification settings - Fork 29
/
readme.txt
245 lines (178 loc) · 12 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
Desktop+, an advanced SteamVR Desktop Overlay, by elvissteinjr
--------------------------------------------------------------
Installation (GitHub Version)
-----------------------------
Extract the complete archive if not done yet. Put the files in a location where they can stay.
Run DesktopPlus.exe. This will also launch SteamVR if it's not already running. A VR-HMD must be connected.
If everything is fine, a message will come up to indicate successful first-time setup.
Desktop+ will continue running as a SteamVR overlay application afterwards.
If the message does not come up on the first launch, check the Troubleshooting section.
Desktop+ will register itself as an overlay application to SteamVR and run automatically on following SteamVR launches.
If you move the files of this application, you'll have to repeat these steps.
Installation (Steam Version)
----------------------------
Simply install the application through Steam and launch it. This will also launch SteamVR if it's not already running.
A VR-HMD must be connected. If everything is fine, a message will come up to indicate successful first-time setup.
Desktop+ will continue running as a SteamVR overlay application afterwards.
If the message does not come up on the first launch, check the "Startup / Shutdown" settings in SteamVR and the Troubleshooting
section.
Updates
-------
The latest version of Desktop+ can be found on https://github.com/elvissteinjr/DesktopPlus/ and on Steam.
Uninstallation (GitHub Version)
-------------------------------
Delete all files that came with the archive.
SteamVR will automatically remove the overlay application entry when the executable isn't present anymore.
Desktop+ does not write to files outside its own directory. However, if you did set up elevated mode, its scheduled task will
remain.
Uninstallation (Steam Version)
------------------------------
Uninstall the application through Steam.
Steam will not delete your configuration and profiles. They can be found in "[Steam Library Path]\SteamApps\common\DesktopPlus"
and be safely deleted if desired. These files are also synced to the Steam Cloud if that feature is enabled.
Additionally, if you did set up elevated mode, its scheduled task will remain.
User Guide
----------
A detailed user guide can be found on https://github.com/elvissteinjr/DesktopPlus/blob/master/docs/user_guide.md
It's recommended to finish reading this document beforehand, however, as the user guide does not cover some topics this readme
covers.
Configuration
-------------
Desktop+ can be fully configured from within VR. If desired, the settings interface can also be used from the desktop, however.
Either run DesktopPlusUI.exe while SteamVR is not running, press the [Misc|Troubleshooting|Desktop+ UI: Restart in Desktop Mode]
button in the VR settings interface, or run DesktopPlusUI.exe with the "-DesktopMode" command line argument to do so.
Some settings are only available while SteamVR is running.
Settings are applied instantly and written to disk when the settings window is dismissed or Desktop+ UI closes.
The setting slider values can be edited directly by right-clicking the slider.
Overlay Management
------------------
To use multiple overlays in Desktop+, click on the "Manage" button at the top-right of the Overlay settings page. This will open
a pop-up in which overlays can be added, removed and organized.
This and several other pop-ups can also be dismissed by simple clicking outside of it, in addition to the "Done" button.
Overlays can be renamed by right-clicking the drop-down selector at the top of the Overlay settings page.
The current overlay setup will be remembered automatically between sessions. Overlay profiles can be used to save and restore
multiple of such setups.
Actions
-------
Desktop+ offers built-in and user-definable actions which can be bound to controller buttons, the main bar or just executed from
the list.
Custom icons can be added by putting PNG files in the "images/icons" folder. Recommended size is 96x96 pixels.
About language support for action and profile names:
To save memory, only common Latin characters are loaded by default. Most symbols and eastern characters can be used, but will
appear as the placeholder "?" character at first. Additional characters will be loaded and display once the action or profile is
saved.
Global Shortcuts & Input Features
---------------------------------
Actions can be bound to 3 different global shortcuts which can be activated by the SteamVR Input bindings.
Desktop+ does not come with default SteamVR Input bindings. These can be set up by going to the Desktop+ controller bindings.
SteamVR currently only lists overlay applications in the old input binding interface, so that one has to be used instead.
Apart from the 3 global shortcuts, a function for floating overlay interaction can also be bound.
"Enable Floating Overlay Interaction": Can be used to enable the laser pointer outside of the dashboard.
Elevated Mode / Enabling UIAccess
---------------------------------
As Desktop+ is subject to User Interface Privilege Isolation (UIPI), it can't simulate input or move the cursor when a higher
privileged application (i.e. running as administrator) is in focus.
Desktop+ offers multiple ways to deal with this, such as elevated mode or enabling UIAccess for the application.
See "misc\!About this folder.txt" for details.
Keyboard Extension
------------------
The keyboard extension adds additional keyboard modifier toggles, tab, function and arrow keys below the SteamVR keyboard when
used with the Desktop+ overlay.
It can be disabled in [Input|Keyboard|Enable Keyboard Extension] should issues from it arise or future SteamVR changes break it.
Note that the modifier toggles directly manipulate the keyboard state, so using them and the hardware keyboard at the same time
may conflict.
Troubleshooting
---------------
As long as DesktopPlusUI.exe is running (launched automatically alongside Desktop+), critical errors will be displayed in VR
with an option to restart Desktop+. Very early runtime errors may not be displayed in VR, but can be read in error.log when they
occur.
In general, note that Desktop+ is using APIs which require Windows 8 or newer.
Using Graphics Capture overlays requires at least Windows 10 1803 for basic support, Windows 10 2004 or newer for full support.
No first-time setup message / Desktop+ not auto-launching (Steam version):
-
The Steam version detects the need of first time setup by checking if an user configuration existed on launch. If you previously
had Desktop+ installed or the configuration was synced from another machine via Steam Cloud, you may need to enable auto-launch
manually in SteamVR's "Startup / Shutdown" settings or delete config.ini to start fresh.
Black screen with question mark display icon instead of desktop mirror:
-
An error occurred trying to duplicate the desktop. This may happen when displays were disconnected or are unavailable for another
reason. You can try restarting Desktop+ or switch to another desktop if you have multiple displays.
Shaky/Delayed laser pointer:
-
By default, the laser pointed cursor may seem to lag behind a little bit, while other screen updates happen instantly.
This is in order to reduce the CPU load. Enable [Performance|Misc|Rapid Laser Pointer Updates] to increase the accuracy of the
laser pointer.
High GPU load when overlay visible and cursor moving:
-
In order to provide the lowest latency possible, all cursor updates are processed instantly, even if they occur more frequently
than the screen's vertical blanks.
Using the Frame Time limiter in [Performance|Update Limiter|Limiter Mode] with a low limit value can reduce the load from cursor
movement while leaving other screen updates unaffected.
Laser pointer not working when dashboard opened via HMD button:
-
By default the laser pointer will be deactivated if the dashboard had been opened via the HMD button and the physical
mouse was moved. Re-open the overlay to activate it again or disable [Input|Mouse|HMD-Pointer Override] to turn this feature off.
Input not working in certain applications:
-
Input simulated by Desktop+ is subject to User Interface Privilege Isolation (UIPI), see the Elevated Mode section for a
workaround.
Overlay is no longer visible:
-
There are several settings controlling overlay visibility and position. Check if they are not set to unexpected values.
Especially of interest are the cropping values. The cropping rectangle is preserved when switching between capture sources, but
that also means it could be invalid for the newly selected mirrored window or desktop.
If that's the case there will be a "(!)" warning next to the Cropping Rectangle section title. Simply reset it then.
Loading the Default overlay profile also works as a quick way to restore the initial overlay state.
Overlay settings are not applying:
-
The overlay settings page always applies to the current overlay. Make sure to have selected the right overlay as current when
making changes.
No overlays visible on laptop:
-
On laptops with hybrid-GPU solutions, the desktops are typically rendered on the power-saving integrated GPU. Make sure to have
DesktopPlus.exe set to be running on integrated graphics so it can mirror them.
Warnings
--------
Desktop+ may display several warnings in its settings interface. They are mostly informational and can be safely ignored.
Click on warnings to dismiss or not have them show up again.
"Compositor resolution is below 100%! This affects overlay rendering quality.":
-
The resolution of the VR compositor is based on the auto-resolution calculated by SteamVR, regardless of whether this resolution
has been chosen as the VR render resolution or not. There's no official way to change this. The auto-resolution can be increased
by lowering the HMD's refresh rate or getting a faster GPU.
Unofficially, there are tools such as SteamVR-ForceCompositorScale to combat this behavior.
"Overlay render quality is not set to high!":
-
The overlay render quality is a setting in SteamVR. It is recommended to set it to high to improve the visual clarity of the
overlays.
"Desktop+ is running with administrative privileges!":
-
This message serves as a reminder about Desktop+ being elevated.
Using Desktop+'s elevated mode is recommended over running all of Desktop+ with administrative privileges.
"Warning: Elevated mode is active!":
-
This message serves as a reminder about Desktop+ being in elevated mode.
Please keep the security implications of that mode in mind and leave it once it's not needed anymore.
"An elevated process has focus! Desktop+ is unable to simulate input right now."
-
User Interface Privilege Isolation (UIPI) prevents Desktop+ from simulating input when an elevated process has focus.
This warning persists until the a window with the same or lesser privilege level has gained focus again.
Clicking on this warning also offers the option to have Desktop+ try to change the focus to another window itself or to enter
elevated mode (only if the scheduled task is configured).
"An overlay creation failed!":
-
This message will typically appear with "(Maximum Overlay limit exceeded)" appended. It appears when the total overlay limit
in SteamVR has been exceeded. This limit is not set by Desktop+ and other overlay applications can affect how many overlays can
be created by Desktop+.
While the warning can be safely ignored, the overlays that were attempted to be created will be missing.
If this message appears with a different error status appended, it might be because of a bug in Desktop+ or SteamVR. Please
report it in that case.
"An unexpected error occurred in a Graphics Capture thread!":
-
This message appears when a Graphics Capture thread crashed. One or more overlays using Graphics Capture will not be updated anymore.
While this shouldn't ever happen, this message can be safely ignored if it only appears once. The affected overlays will need to
have their source be set again from either changing it or reloading a profile.
License
-------
Desktop+ is licensed under the GPL 3.0.
For the third-party licenses, see third-party_licenses.txt.