From 5df6ce93f8e3e4a03446c535dd05a82381ee5dfd Mon Sep 17 00:00:00 2001 From: Aleksander Date: Tue, 24 Mar 2026 00:19:27 +0100 Subject: [PATCH 1/3] docs: move out docs to a separate repo/website, fix typos [skip ci] --- README.md | 7 +- wayvr-ipc/README.md | 6 +- wayvr/contrib/wayvr/README.md | 42 ------- wayvr/src/gui/README.md | 221 ---------------------------------- wayvrctl/src/main.rs | 2 +- wgui/README.md | 2 + 6 files changed, 8 insertions(+), 272 deletions(-) delete mode 100644 wayvr/contrib/wayvr/README.md delete mode 100644 wayvr/src/gui/README.md diff --git a/README.md b/README.md index 811068ff..44aa50f5 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Questions/issues specific to WayVR will be handled in the `wayvr` chat room. Fee There are multiple ways to install WayVR: 1. AppImage: Download from [Releases](https://github.com/wlx-team/wayvr/releases) -1. AUR package: [wayvr](https://aur.archlinux.org/packages/wayvr) or [wayvr-git](https://aur.archlinux.org/packages/wayvr-git) +1. AUR package: [wayvr](https://aur.archlinux.org/packages/wayvr) or [wayvr-git](https://aur.archlinux.org/packages/wayvr-git) 1. Nix package: [wayvr](https://search.nixos.org/packages?channel=unstable&show=wayvr&query=wayvr) or [unstable package from nixpkgs-xr](https://github.com/nix-community/nixpkgs-xr) 1. [Building from source](https://github.com/wlx-team/wayvr/wiki/Building-from-Source). @@ -131,7 +131,8 @@ Typing - While using the ORANGE laser, all keystrokes will have SHIFT applied. - Purple laser is customizable via the settings, no modifier by default. -**Modifier Keys are sticky**. They will remain pressed until eiter: +**Modifier Keys are sticky**. They will remain pressed until either: + - a non-modifier key is pressed - the modifier is toggled off by clicking again - the keyboard is hidden (including via show-hide) @@ -142,7 +143,6 @@ Typing ![Touch Controller Bindings](https://github.com/wlx-team/wayvr/blob/guide/wlx-oculus.png) - ### Changing Bindings SteamVR: Simply change the bindings from the SteamVR bindings section. If WayVR doesn't show up on the list, select any other title and then press back on the top left. (SteamVR is weird like that sometimes) @@ -155,6 +155,7 @@ We would like to work with you and include additional bindings. ## Customization See these relevant wiki pages: + - For all available config options, check [Wiki: Configuration](https://github.com/wlx-team/wayvr/wiki/Configuration) - Looking to customize look & feel, or add functionality? See [Wiki: Customization](https://github.com/wlx-team/wayvr/wiki/Customization) - Looking to change the OpenXR background? See [Wiki: OpenXR Skybox](https://github.com/wlx-team/wayvr/wiki/OpenXR-Skybox) diff --git a/wayvr-ipc/README.md b/wayvr-ipc/README.md index 776c16bc..9beaee71 100644 --- a/wayvr-ipc/README.md +++ b/wayvr-ipc/README.md @@ -2,8 +2,4 @@ This repository contains the IPC specification and client implementation for the WayVR protocol. The primary purpose is to enable communication between applications and the WayVR server, offering a range of API functions. -[WayVR Server README](https://github.com/wlx-team/wayvr/tree/main/wayvr/contrib/wayvr) - -## Usage - -[Example WayVR IPC Client usage in WayVR Dashboard (Legacy)](https://github.com/olekolek1000/wayvr-dashboard/blob/master/src-tauri/src/frontend_ipc.rs) +[Wayvrctl Documentation](https://wayvr.org/docs/various/integrations/wayvr_ipc/) diff --git a/wayvr/contrib/wayvr/README.md b/wayvr/contrib/wayvr/README.md deleted file mode 100644 index f8527261..00000000 --- a/wayvr/contrib/wayvr/README.md +++ /dev/null @@ -1,42 +0,0 @@ -

- -

- -# Overview - -### Features - -- Display Wayland applications without GPU overhead (zero-copy via dma-buf) -- Mouse and keyboard input, with precision scrolling support -- Tested on AMD and Nvidia - -### Supported software - -- Basically all Qt and GTK applications (they work out of the box) -- Most XWayland applications via `cage` - -### Launching external apps inside WayVR - -To launch your app externally: - -```sh -DISPLAY= WAYLAND_DISPLAY=wayland-$(cat $XDG_RUNTIME_DIR/wayvr.disp) yourapp -``` - -or (in the most cases): - -``` -DISPLAY= WAYLAND_DISPLAY=wayland-20 yourapp -``` - -Setting `DISPLAY` to an empty string forces various apps to use Wayland instead of X11. - -# Troubleshooting - -### My application doesn't launch but others do! - -Even though some applications support Wayland, some still check for the `DISPLAY` environment variable and an available X11 server, throwing an error. This can also be fixed by running `cage` on top of them. - -### Floating windows - -Context menus are not functional in most cases yet, including drag & drop support. diff --git a/wayvr/src/gui/README.md b/wayvr/src/gui/README.md deleted file mode 100644 index 9c3bb443..00000000 --- a/wayvr/src/gui/README.md +++ /dev/null @@ -1,221 +0,0 @@ -# Custom UI Elements - -Elements on custom panels may be modified at runtime using `wayvrctl`. - -For more, refer to: `wayvrctl panel-modify --help` - -### Labels - -#### Clock label - -Clock labels are driven by the current time, adhering to the user's 12/24 hour setting as well as timezone settings. - -Available display values are: `name` (timezone name), `time`, `date`, `dow` or a custom [format string](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) like `%H:%M:%S`. - -See the Custom Timezones section for more info on timezones. Skip `_timezone` to use local time. - -```xml -