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

Updated Customize UI (markdown)

galister 2025-01-01 00:34:19 +00:00
parent 6215cdabb8
commit 09b6397200
1 changed files with 45 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Customize-UI.md

@ -16,6 +16,23 @@ cd ~/.config/wlxoverlay
wget https://github.com/galister/wlx-overlay-s/raw/main/src/res/settings.yaml wget https://github.com/galister/wlx-overlay-s/raw/main/src/res/settings.yaml
``` ```
### Customize Alternate Timezones
Starting with releases *after* v0.6, alternate timezones preference was moved outside `watch.yaml` to its own separate file.
Create `~/.config/wlxoverlay/timezones.yaml`:
```yaml
timezones:
- "Europe/Oslo"
- "America/New_York"
```
Once this file is created, the various settings in custom UI that accept the `timezone` property will use these custom alternate timezones (instead of the default set, which are selected as major ones on different continents from your current actual timezone).
The first timezone is selected with `timezone: 0`, the second with `timezone: 1`, and so on.
There is usually no need to specify your own local timezone in here; omitting `timezone` from a `type: Clock` Label will display local time.
### Add a custom UI window of your own ### Add a custom UI window of your own
Simply create any Yaml file in `~/.config/wlxoverlay` with the correct format. You will be able to spawn it using the `ShowUi` type `Button` placed on an existing UI panel, such as the watch or settings. Simply create any Yaml file in `~/.config/wlxoverlay` with the correct format. You will be able to spawn it using the `ShowUi` type `Button` placed on an existing UI panel, such as the watch or settings.
@ -96,6 +113,7 @@ Example:
Displays some kind of text. Displays some kind of text.
#### Static Label #### Static Label
Displays static text. Displays static text.
```yaml ```yaml
- type: Label - type: Label
@ -107,12 +125,34 @@ Displays static text.
``` ```
#### Clock label #### Clock label
The clock label displays date, time or both with the provided format. See available formats [here](https://docs.rs/chrono/0.4.34/chrono/format/strftime/index.html). The clock label displays date, time or both with the provided format. See available formats [here](https://docs.rs/chrono/0.4.34/chrono/format/strftime/index.html).
```yaml ```yaml
- type: Label
source: Clock source: Clock
format: "%x" format: "%x"
timezone: 0 # Optional. If omitted, use local time
``` ```
#### Exec Label
If a `timezone` property is given, displays the date/time in the the alternate timezone with the given index (0-based).
To choose a different set of alternate timezones, see the section [Customize Alternate Timezones](#customize-alternate-timezones).
In releases *before and including* v0.6, `timezone` is a tz data timezone identifier.
In releases *after* v0.6, `timezone` is a 0-based index, defined by the alternate timezones file.
#### Timezone label
Added in releases *after* v0.6.
This shows the friendly name assocated with the alternate timezone with the given index (0-based).
To choose a different set of alternate timezones, see the section [Customize Alternate Timezones](#customize-alternate-timezones).
```yaml
- type: Label
source: Timezone
timezone: 0
```
#### Exec label
Executes a command every `interval` seconds Executes a command every `interval` seconds
@ -128,6 +168,7 @@ By default, commands are not executed in a shell. You may explicitly call a shel
command: [ "bash", "-c", "echo \"hello this is $USER\"" ] command: [ "bash", "-c", "echo \"hello this is $USER\"" ]
interval: 0.5 interval: 0.5
``` ```
#### Ipd Label #### Ipd Label
Displays the current IPD in millimeters with 1 decimal precision Displays the current IPD in millimeters with 1 decimal precision