RomanNum3ral
/
wayvr
mirror of https://github.com/wayvr-org/wayvr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update

galister 2026-01-15 22:08:57 +09:00
parent 53f53aa991
commit 2a9124c27f
7 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Configuration.md

@ -1,11 +1,11 @@
The sample configuration file is located at [wlx-overlay-s/src/res/config.yaml](https://github.com/galister/wlx-overlay-s/blob/main/wlx-overlay-s/src/res/config.yaml). The sample configuration file is located at [wayvr/src/res/config.yaml](https://github.com/wlx-team/wayvr/blob/main/wayvr/src/res/config.yaml).
Place this file into `~/.config/wlxoverlay/conf.d` in order to make changes: Place this file into `~/.config/wayvr/conf.d` in order to make changes:
```sh ```sh
wget -O ~/.config/wlxoverlay/conf.d/base.yaml https://raw.githubusercontent.com/galister/wlx-overlay-s/refs/heads/main/wlx-overlay-s/src/res/config.yaml wget -O ~/.config/wayvr/conf.d/base.yaml https://raw.githubusercontent.com/wlx-team/wayvr/refs/heads/main/wayvr/src/res/config.yaml
``` ```
The file is self-documenting, opening and reading it will hopefully answer your questions. The file is self-documenting, opening and reading it will hopefully answer your questions.
For further questions, reach out to us on Discord or Matrix. For further questions, reach out to us on Discord or Matrix.

4
Custom-Textures.md

@ -42,7 +42,7 @@ Compressonator is a set of open-source graphics utilities by AMD.
Example usage: Example usage:
```bash ```bash
compressonatorcli -nomipmap -fd BC7 ~/Downloads/table_mountain_2_puresky.png ~/.config/wlxoverlay/table_mountain_2.dds compressonatorcli -nomipmap -fd BC7 ~/Downloads/table_mountain_2_puresky.png ~/.config/wayvr/table_mountain_2.dds
``` ```
## Convert standard picture to DDS: GIMP ## Convert standard picture to DDS: GIMP
@ -53,4 +53,4 @@ To export it, go to `File -> Export As...`, and then select your output filename
Select your compression type, for example BC3. Select your compression type, for example BC3.
Be aware GIMP doesn't support BC7 compression. Be aware GIMP doesn't support BC7 compression.

2
Customization.md

@ -108,4 +108,4 @@ The available widgets and their attributes are documented at: [wgui/doc/widgets.
## Custom UI Elements (WayVR) ## Custom UI Elements (WayVR)
An up-to-date list of custom functions, see [wayvr/src/gui/README.md](https://github.com/wlx-team/wayvr/blob/main/wayvr/src/gui/README.md) An up-to-date list of custom functions, see [wayvr/src/gui/README.md](https://github.com/wlx-team/wayvr/blob/main/wayvr/src/gui/README.md)

2
Home.md

@ -1 +1 @@
Welcome to the wlx-overlay-s wiki! Welcome to the WayVR wiki!

12
OSC-Parameters.md

@ -1,12 +1,12 @@
For compatibility, WlxOverlay-S implements all of the OSC parameters from [XSOverlay](https://xsoverlay.vercel.app/OSC) and most from [OVR Toolkit](https://wiki.ovrtoolkit.co.uk/#/OSC), as well as several more for extended functionality. For compatibility, WayVR implements all of the OSC parameters from [XSOverlay](https://xsoverlay.vercel.app/OSC) and most from [OVR Toolkit](https://wiki.ovrtoolkit.co.uk/#/OSC), as well as several more for extended functionality.
This requires WlxOverlay-S to be built with the `osc` feature, which is enabled by default. This requires WayVR to be built with the `osc` feature, which is enabled by default.
# Configuration # Configuration
The port used by WlxOverlay-S can be configured with the `osc_out_port` config value: The port used by WayVR can be configured with the `osc_out_port` config value:
```yaml ```yaml
# ~/.config/wlxoverlay/conf.d/osc_out_port.yaml # ~/.config/wayvr/conf.d/osc_out_port.yaml
osc_out_port: 9000 osc_out_port: 9000
``` ```
@ -38,7 +38,7 @@ All of the following parameters are prefixed with `/avatar/parameters/` for use
## Tracker Parameters ## Tracker Parameters
Tracker parameters dynamically increase in number for as many tracker devices exist. For example, with 3 trackers WlxOverlay-S will send parameters for `tracker1`, `tracker2`, and `tracker3`. Tracker parameters dynamically increase in number for as many tracker devices exist. For example, with 3 trackers WayVR will send parameters for `tracker1`, `tracker2`, and `tracker3`.
- `tracker<id>Battery` or `tracker1Battery`, etc (float 0-1): 1-indexed tracker device battery level. - `tracker<id>Battery` or `tracker1Battery`, etc (float 0-1): 1-indexed tracker device battery level.
- `tracker<id>Charging` or `tracker1Charging`, etc (bool): 1-indexed tracker device charging state. - `tracker<id>Charging` or `tracker1Charging`, etc (bool): 1-indexed tracker device charging state.
@ -51,4 +51,4 @@ The following parameters are currently missing for full parity:
### OVR Toolkit ### OVR Toolkit
- `MediaPlaying` (bool) - Whether the overlay is currently playing media. - `MediaPlaying` (bool) - Whether the overlay is currently playing media.
- WlxOverlay-S does not directly support controlling media playback, however it should be possible to create a button which sends this parameter as an `::OscSend` Button Action alongside a command to play or pause media. - WayVR does not directly support controlling media playback, however it should be possible to create a button which sends this parameter as an `::OscSend` Button Action alongside a command to play or pause media.

10
OpenXR-Skybox.md

@ -1,4 +1,4 @@
WlxOverlay-S comes with a skybox for OpenXR. WayVR comes with a skybox for OpenXR.
# Turning off Pass-through # Turning off Pass-through
@ -8,12 +8,12 @@ Some headsets will show a camera pass-through by default. If skybox is preferred
We are only allowed to include pieces with specific licenses in the git repo, but feel free to procure your own skybox materiel for personal use! We are only allowed to include pieces with specific licenses in the git repo, but feel free to procure your own skybox materiel for personal use!
A custom texture may be set via `~/.config/wlxoverlay/conf.d`: A custom texture may be set via `~/.config/wayvr/conf.d`:
```bash ```bash
echo 'skybox_texture: my-skybox.dds' > ~/.config/wlxoverlay/conf.d/skybox.yaml echo 'skybox_texture: my-skybox.dds' > ~/.config/wayvr/conf.d/skybox.yaml
``` ```
Criteria: Criteria:
- Path can be absolute, or relative to `~/.config/wlxoverlay/`. - Path can be absolute, or relative to `~/.config/wayvr/`.
- File must be DDS (See: [Custom Textures](https://github.com/galister/wlx-overlay-s/wiki/Custom-Textures)) - File must be DDS (See: [Custom Textures](https://github.com/wlx-team/wayvr/wiki/Custom-Textures))
- Image must be an equirectangular (aka "HDRI" or "Spherical 360") image. - Image must be an equirectangular (aka "HDRI" or "Spherical 360") image.

10
Troubleshooting.md

@ -1,17 +1,17 @@
## Check logs ## Check logs
Wlx-S will often show troubleshooting tips in the logs, so it's good to always check them first. WayVR will often show troubleshooting tips in the logs, so it's good to always check them first.
By default, Wlx-S logs into `/tmp/wlx.log`. By default, WayVR logs into `/tmp/wayvr.log`.
Another way is to run Wlx in the terminal with `--replace`. This will stop the Wlx process started by SteamVR/WiVRn and start a new one that can be monitored in the terminal. Another way is to run WayVR in the terminal with `--replace`. This will stop the WayVR process started by SteamVR/WiVRn and start a new one that can be monitored in the terminal.
## Troubleshooting segmentation faults (SIGSEGV) ## Troubleshooting segmentation faults (SIGSEGV)
Run Wlx-S in `rust-gdb` (or even regular `gdb`) to get more info about the segfault. Run WayVR in `rust-gdb` (or even regular `gdb`) to get more info about the segfault.
Attach this with the other logs that you have. Attach this with the other logs that you have.
``` ```
rust-gdb -ex run target/debug/wlx-overlay-s rust-gdb -ex run target/debug/wayvr
``` ```