~bl4ckb0ne/wxrc

6565e784a78029785f72777b4a7b9d26da03c6ab — Simon Zeni 1 year, 3 months ago 90c5ff2 0.1.0
README: improve content and update video
1 files changed, 31 insertions(+), 11 deletions(-)

M README.md
M README.md => README.md +31 -11
@@ 2,30 2,48 @@

[![builds.sr.ht status](https://builds.sr.ht/~bl4ckb0ne/wxrc.svg)](https://builds.sr.ht/~bl4ckb0ne/wxrc?)

wxrc is a Wayland OpenXR compositor based on [wlroots]. It displays 2D and
`wxrc` is a Wayland OpenXR compositor based on [wlroots]. It displays 2D and
3D surfaces [1] in a 3D virtual reality scene.

wxrc requires an OpenXR runtime running with the appropriate head mounted
`wxrc` requires an OpenXR runtime running with the appropriate head mounted
display (HMD) hardware.

Join us on [IRC] \(#wxrc on irc.libera.chat) or contact us on our mailing
list at [~bl4ckb0ne/wxrc@lists.sr.ht]

## Compiling from source
## Video

`wxrc` requires an upstream [wlroots], you can clone the repo into the
`subproject` folder.
https://l.sr.ht/zc3o.mkv

Run these commands to compile
## How to run

```
meson build/
ninja -C build/
`wxrc` requires an OpenXR runtime provider to run, only [Monado] is supported
for the moment. SteamVR is missing all of the extensions required by `wxrc`.

For `wxrc` to know where the OpenXR runtime is located, the user needs to set
the environment variable `XR_RUNTIME_JSON` to the runtime location

```bash
export XR_RUNTIME_JSON=/home/user/src/monado/build/openxr_monado-dev.json
```

## Video
`wxrc` also requires a configuration file. The configuration file should be
located at the path `~/.config/wxrc/config`, or provided using the `-c` runtime
option. A sample is provided here [2].

https://spacepub.space/videos/watch/691f2bc1-d4bf-4051-a035-035388a059b0
Once the compositor has started, the default fallback input device will be the
Wayland pointer. The user can use controller binding `BTN_TRIGGER + BTN_LEFT`
on a given controller for it to become the primary pointer source. The same
binding can be used on the primary controller to exit input.

## Compiling from source

Run these commands to compile

```bash
meson setup build
ninja -C build/
```

## Dependencies



@@ 46,9 64,11 @@ work and send your patch to mailing list at [~bl4ckb0ne/wxrc@lists.sr.ht] using
the tag [PATCH] in your mail.

[1]: https://git.sr.ht/~bl4ckb0ne/wxrc/tree/master/item/protocol/xr-shell-v1.xml
[2]: https://git.sr.ht/~bl4ckb0ne/wxrc/tree/master/item/config
[wlroots]: https://github.com/swaywm/wlroots
[cglm]: https://github.com/recp/cglm
[libscfg]: https://git.sr.ht/~emersion/libscfg
[IRC]: https://web.libera.chat/gamja/?channels=#wxrc
[~bl4ckb0ne/wxrc@lists.sr.ht]: https://lists.sr.ht/~bl4ckb0ne/wxrc
[ticket tracker]: https://todo.sr.ht/~bl4ckb0ne/wxrc
[Monado]: https://gitlab.freedesktop.org/monado/monado