wivrn: improve wording

This commit is contained in:
galister 2024-09-13 16:32:31 +00:00
parent deb1ac1b36
commit d54ebed8f1

View file

@ -13,8 +13,6 @@ title: WiVRn
It's very similar in purpose to [Monado](/docs/fossvr/monado/), but for standalone VR headsets.
Current limitations are a fixed bitrate and network protocol streaming only, please ensure your headset is on a stable network or utilize an ethernet adapter to your headset to operate in a quasi-wired mode.
Should you utilize [Envision](/docs/fossvr/envision/) for WiVRn setup, please ensure your APK and WiVRn server match as closely as possible. Check the WiVRn github [actions](https://github.com/WiVRn/WiVRn/actions) for an APK matching your server build to install to your headset.
## Wired WiVRn
@ -23,9 +21,9 @@ Use WiVRn with a cable instead of Wifi. Use a 5Gbps cable & port at the very lea
Steps:
- Enable TCP Only mode, either via Envision or the [JSON configuration](https://github.com/WiVRn/WiVRn?tab=readme-ov-file#configuration)!
- If WiVRn is running on the headset, close it now.
- Connect the headset via USB
- Run the following `adb` commands:
- If WiVRn is running on the headset, close it now.
- While in the system lobby of the headset, run the following `adb` commands on the PC:
```bash
adb reverse tcp:9757 tcp:9757
adb shell am start -a android.intent.action.VIEW -d "wivrn://127.0.0.1" org.meumeu.wivrn
@ -33,18 +31,18 @@ Steps:
## WiVRn + Lighthouse driver
This section covers using WiVRn with any lighthouse-tracked device: Index/Vive controllers, Vive/Tundra trackers, etc. Important steps are marked with 🔴.
This section covers using WiVRn with any lighthouse-tracked device: Index/Vive controllers, Vive/Tundra trackers, etc.
🔴 Have SteamVR installed (no need to run it).
Have SteamVR installed (no need to run it).
🔴 In Envision, set WiVRn Profile as such:
In Envision, set WiVRn Profile as such:
- XR Service CMake Flags:
- `WIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON`
- Environment Variables:
- `WIVRN_USE_STEAMVR_LH=1`
- `LH_DISCOVER_WAIT_MS=6000`
🔴 Perform a **Clean Build** after changing the CMake flags!
Perform a **Clean Build** after changing the CMake flags!
If not using Envision, simply pass `-DWIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON` to cmake and export the env variables before starting `wivrn-server`.
@ -54,7 +52,7 @@ Discovery happens only on first connection, so be sure to **have all lighthouse
Once a device is discovered, it may be powered off and then back on later.
🔴 Once video appears in the headset, check `motoc monitor` to make sure your devices all show up.
Once video appears in the headset, check `motoc monitor` to make sure your devices all show up.
If one or more devices are missing, try:
- Spread the devices out more; lighthouse devices get discovered quicker if they're not piled up on each other. Simply strapping them on is good, too.