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

Updated Customization (markdown)

galister 2026-01-15 12:33:47 +00:00
parent 7a7a309402
commit 53f53aa991
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Customization.md

@ -1,4 +1,4 @@
# WlxOverlay-S UI Customization
# WayVR UI Customization
## Dashboard settings
@ -6,9 +6,9 @@ The settings panel has many of the settings already. Only use settings files tha
## Custom colors
Changing the colors of WlxOverlay-S can be done via the configs.
Changing the colors of WayVR can be done via the configs.
Create `~/.config/wlxoverlay/conf.d/theme.yaml` as such:
Create `~/.config/wayvr/conf.d/theme.yaml` as such:
```yaml
color_accent: "#008cff"
@ -18,7 +18,7 @@ color_faded: "#668299"
## Custom timezones
Create `~/.config/wlxoverlay/conf.d/clock.yaml` as such:
Create `~/.config/wayvr/conf.d/clock.yaml` as such:
```yaml
timezones:
@ -47,22 +47,22 @@ Audio files with the following names can be added to `~/.config/wayvr/sound/`, a
## Customizing keyboard, watch, etc
Place custom XML files under `~/.config/wlxoverlay/theme/gui`
Place custom XML files under `~/.config/wayvr/theme/gui`
The default XML files can be found in [src/assets/gui](https://github.com/galister/wlx-overlay-s/tree/main/wlx-overlay-s/src/assets/gui).
The default XML files can be found in [src/assets/gui](https://github.com/wlx-team/wayvr/tree/main/wayvr/src/assets/gui).
The `uidev` utility is provided for testing UI elements outside of VR:
```sh
cd uidev
TESTBED=../wlx-overlay-s/src/assets/gui/watch.xml cargo run
TESTBED=../wayvr/src/assets/gui/watch.xml cargo run
```
## Adding custom overlay panels
Place the XML file and assets for your custom panel under `~/.config/wlxoverlay/theme/gui`
Place the XML file and assets for your custom panel under `~/.config/wayvr/theme/gui`
Make sure that the name you choose doesn't override an existing, built-in overlay: [src/assets/gui](https://github.com/galister/wlx-overlay-s/tree/main/wlx-overlay-s/src/assets/gui)
Make sure that the name you choose doesn't override an existing, built-in overlay: [src/assets/gui](https://github.com/wlx-team/wayvr/tree/main/wayvr/src/assets/gui)
Add your overlay to the `custom_panels` setting via `conf.d`:
@ -70,7 +70,7 @@ Example for an XML named `my-panel.xml`:
```yaml
# ~/.config/wlxoverlay/conf.d/panels.yaml
# ~/.config/wayvr/conf.d/panels.yaml
custom_panels:
- "my-panel"
@ -80,9 +80,9 @@ Your new panel will show up on the overlay list in Edit Mode.
## WayVRCtl
`wayvrctl` is a CLI tool to interact with WlxOverlay and WayVR.
`wayvrctl` is a CLI tool to interact with WayVR.
Install: `cargo install --git https://github.com/galister/wlx-overlay-s.git wayvrctl`
Install: `cargo install --git https://github.com/wlx-team/wayvr.git wayvrctl`
For a full list of commands, see: `wayvrctl --help` and `wayvrctl panel-modify --help`.