Skip to content

Commit df7e9be

Browse files
committed
update readme
1 parent 1d60588 commit df7e9be

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# WayVR
44

5-
A lightweight OpenXR/OpenVR overlay for Wayland and X11 desktops, inspired by XSOverlay.
5+
A lightweight OpenXR/OpenVR overlay for Wayland and X11 desktops.
66

7-
WayVR lets you to access your desktop screens while in VR.
7+
WayVR lets you to access your desktop screens while in VR, and even launch apps directly in VR.
88

99
In comparison to similar overlays, WayVR aims to run alongside VR games and experiences while having as little performance impact as possible. The UI appearance and rendering techniques are kept as simple and efficient as possible, while still allowing a high degree of customizability.
1010

@@ -24,14 +24,14 @@ Questions/issues specific to WayVR will be handled in the `wayvr` chat room. Fee
2424

2525
There are multiple ways to install WayVR:
2626

27-
1. AppImage: Download from [Releases](https://github.com/galister/wlx-overlay-s/releases)
28-
1. AUR package: [wlx-overlay-s-git](https://aur.archlinux.org/packages/wlx-overlay-s-git)
27+
1. AppImage: Download from [Releases](https://github.com/wlx-team/wayvr/releases)
28+
1. AUR package: [wayvr](https://aur.archlinux.org/packages/wayvr) or [wayvr-git](https://aur.archlinux.org/packages/wayvr-git)
2929
1. Homebrew:
3030

3131
- Add AtomicXR tap: `brew tap matrixfurry.com/atomicxr https://tangled.sh/@matrixfurry.com/homebrew-atomicxr`
3232
- Install WayVR: `brew install wlx-overlay-s`
3333

34-
1. [Building from source](https://github.com/galister/wlx-overlay-s/wiki/Building-from-Source).
34+
1. [Building from source](https://github.com/wlx-team/wayvr/wiki/Building-from-Source).
3535

3636
### General Setup
3737

@@ -44,7 +44,7 @@ There are multiple ways to install WayVR:
4444

4545
For users specifically running **SteamVR via Steam Flatpak**, follow these steps:
4646

47-
1. Grab the latest AppImage from [Releases](https://github.com/galister/wlx-overlay-s/releases).
47+
1. Grab the latest AppImage from [Releases](https://github.com/wlx-team/wayvr/releases).
4848
1. `WayVR-*.AppImage --appimage-extract`
4949
1. `chmod +x squashfs-root/AppRun`
5050
1. Move the newly created `squashfs-root` folder to a location accessible by the Steam Flatpak.
@@ -68,7 +68,7 @@ In case screens were selected in the wrong order:
6868
**Envision users**: Go to the Plugins menu and select the WayVR plugin. This will download and run the AppImage version of the overlay.
6969
In order to run a standalone installation (for instance from the AUR), create a bash script containing `wayvr --openxr --show` and then set this bash script as a custom Envision plugin.
7070

71-
This will show a home environment with headset passthrough by default or a [customizable background](https://github.com/galister/wlx-overlay-s/wiki/OpenXR-Skybox)!
71+
This will show a home environment with headset passthrough by default or a [customizable background](https://github.com/wlx-team/wayvr/wiki/OpenXR-Skybox)!
7272

7373
**SteamVR users**: WayVR will register itself for auto-start, so there is no need to start it every time. Disclaimer: SteamVR will sometimes disregard this and not start WayVR anyway.
7474

@@ -116,8 +116,6 @@ After grabbing, the watch will automatically attach to the hand that's opposite
116116

117117
In edit mode, try hovering other overlays to see their advanced options!
118118

119-
![Watch usage guide](https://github.com/galister/wlx-overlay-s/blob/guide/wlx-watch.png)
120-
121119
### The screens
122120

123121
Hovering a pointer over a screen will move the mouse. If there are more than one pointers hovering a screen, the pointer that was last used to click will take precedence.
@@ -141,11 +139,11 @@ Typing
141139

142140
### Default Bindings
143141

144-
![Index Controller Bindings](https://github.com/galister/wlx-overlay-s/blob/guide/wlx-index.png)
142+
![Index Controller Bindings](https://github.com/wlx-team/wayvr/blob/guide/wlx-index.png)
145143

146-
![Touch Controller Bindings](https://github.com/galister/wlx-overlay-s/blob/guide/wlx-oculus.png)
144+
![Touch Controller Bindings](https://github.com/wlx-team/wayvr/blob/guide/wlx-oculus.png)
147145

148-
To customize bindings on OpenXR, refer to the [OpenXR Bindings wiki page](https://github.com/galister/wlx-overlay-s/wiki/OpenXR-Bindings).
146+
To customize bindings on OpenXR, refer to the [OpenXR Bindings wiki page](https://github.com/wlx-team/wayvr/wiki/OpenXR-Bindings).
149147

150148
If your bindings are not supported, please reach out. \
151149
We would like to work with you and include additional bindings.
@@ -156,7 +154,7 @@ When an error is detected, we often print tips for fixing into the log file.
156154

157155
Logs will be at `/tmp/wayvr.log` for most distros.
158156

159-
Check [here](https://github.com/galister/wlx-overlay-s/wiki/Troubleshooting) for tips.
157+
Check [here](https://github.com/wlx-team/wayvr/wiki/Troubleshooting) for tips.
160158

161159
## Known Issues
162160

0 commit comments

Comments
 (0)