From 2a9124c27f96b392c152278cea78e744e8cfba1e Mon Sep 17 00:00:00 2001 From: galister <22305755+galister@users.noreply.github.com> Date: Thu, 15 Jan 2026 22:08:57 +0900 Subject: [PATCH] update --- Configuration.md | 8 ++++---- Custom-Textures.md | 4 ++-- Customization.md | 2 +- Home.md | 2 +- OSC-Parameters.md | 12 ++++++------ OpenXR-Skybox.md | 10 +++++----- Troubleshooting.md | 10 +++++----- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Configuration.md b/Configuration.md index 71b61d2..efaf68f 100644 --- a/Configuration.md +++ b/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 -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. -For further questions, reach out to us on Discord or Matrix. \ No newline at end of file +For further questions, reach out to us on Discord or Matrix. diff --git a/Custom-Textures.md b/Custom-Textures.md index bf88084..c75dbd2 100644 --- a/Custom-Textures.md +++ b/Custom-Textures.md @@ -42,7 +42,7 @@ Compressonator is a set of open-source graphics utilities by AMD. Example usage: ```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 @@ -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. -Be aware GIMP doesn't support BC7 compression. \ No newline at end of file +Be aware GIMP doesn't support BC7 compression. diff --git a/Customization.md b/Customization.md index 51843b4..0e5b9e5 100644 --- a/Customization.md +++ b/Customization.md @@ -108,4 +108,4 @@ The available widgets and their attributes are documented at: [wgui/doc/widgets. ## 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) \ No newline at end of file +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) diff --git a/Home.md b/Home.md index 5e9c6d2..e073b42 100644 --- a/Home.md +++ b/Home.md @@ -1 +1 @@ -Welcome to the wlx-overlay-s wiki! +Welcome to the WayVR wiki! diff --git a/OSC-Parameters.md b/OSC-Parameters.md index ee0b090..08d8461 100644 --- a/OSC-Parameters.md +++ b/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 -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 -# ~/.config/wlxoverlay/conf.d/osc_out_port.yaml +# ~/.config/wayvr/conf.d/osc_out_port.yaml osc_out_port: 9000 ``` @@ -38,7 +38,7 @@ All of the following parameters are prefixed with `/avatar/parameters/` for use ## 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`. - `trackerBattery` or `tracker1Battery`, etc (float 0-1): 1-indexed tracker device battery level. - `trackerCharging` 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 - `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. diff --git a/OpenXR-Skybox.md b/OpenXR-Skybox.md index 58c3963..66f65eb 100644 --- a/OpenXR-Skybox.md +++ b/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 @@ -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! -A custom texture may be set via `~/.config/wlxoverlay/conf.d`: +A custom texture may be set via `~/.config/wayvr/conf.d`: ```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: -- Path can be absolute, or relative to `~/.config/wlxoverlay/`. -- File must be DDS (See: [Custom Textures](https://github.com/galister/wlx-overlay-s/wiki/Custom-Textures)) +- Path can be absolute, or relative to `~/.config/wayvr/`. +- 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. diff --git a/Troubleshooting.md b/Troubleshooting.md index 175b118..a84c293 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -1,17 +1,17 @@ ## 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) -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. ``` -rust-gdb -ex run target/debug/wlx-overlay-s +rust-gdb -ex run target/debug/wayvr ```