wivrn: emphasize alternative options
This commit is contained in:
@@ -102,7 +102,7 @@ Manual steps: See the [README](https://github.com/WiVRn/WiVRn/blob/master/README
|
|||||||
|
|
||||||
To use SlimeVR trackers through WiVRn, you currently must use a [fork](https://github.com/notpeelz/WiVRn) of WiVRn:
|
To use SlimeVR trackers through WiVRn, you currently must use a [fork](https://github.com/notpeelz/WiVRn) of WiVRn:
|
||||||
|
|
||||||
### Usage with Envision
|
### Option A: Build with Envision
|
||||||
|
|
||||||
To use this fork within Envision, edit these fields in your profile:
|
To use this fork within Envision, edit these fields in your profile:
|
||||||
- XR Service Repo: `https://github.com/notpeelz/WiVRn.git`
|
- XR Service Repo: `https://github.com/notpeelz/WiVRn.git`
|
||||||
@@ -111,7 +111,7 @@ To use this fork within Envision, edit these fields in your profile:
|
|||||||
|
|
||||||
Then save and clean build the profile.
|
Then save and clean build the profile.
|
||||||
|
|
||||||
### NixOS setup
|
### Option B: NixOS
|
||||||
Override the `wivrn` package from nixpkgs with something resembling the following, replacing `[COMMIT HASH HERE]` with the latest commit hash from https://github.com/notpeelz/WiVRn/commits/solarxr-patches and filling in the correct src hash. Do note you may need to adapt this depending on how you install WiVRn:
|
Override the `wivrn` package from nixpkgs with something resembling the following, replacing `[COMMIT HASH HERE]` with the latest commit hash from https://github.com/notpeelz/WiVRn/commits/solarxr-patches and filling in the correct src hash. Do note you may need to adapt this depending on how you install WiVRn:
|
||||||
```nix
|
```nix
|
||||||
{ pkgs, lib, ... }:
|
{ pkgs, lib, ... }:
|
||||||
@@ -145,7 +145,7 @@ You must have SteamVR installed (no need to run it).
|
|||||||
|
|
||||||
Upstream xrizer doesn't support FBT, so either **select OpenComposite as the OpenVR library** in WiVRn dashboard settings, or build the [experimental2 branch of xrizer](https://github.com/RinLovesYou/xrizer/tree/experimental2).
|
Upstream xrizer doesn't support FBT, so either **select OpenComposite as the OpenVR library** in WiVRn dashboard settings, or build the [experimental2 branch of xrizer](https://github.com/RinLovesYou/xrizer/tree/experimental2).
|
||||||
|
|
||||||
### Using Distro-Native Packages
|
### Option A: Use Distro-Native Packages
|
||||||
|
|
||||||
These packages come with lighthouse support enabled (Flatpak & Envision does NOT)
|
These packages come with lighthouse support enabled (Flatpak & Envision does NOT)
|
||||||
- Arch: Install `wivrn-dashboard wivrn-server` from AUR
|
- Arch: Install `wivrn-dashboard wivrn-server` from AUR
|
||||||
@@ -156,7 +156,7 @@ Open the WiVRn dashboard and under advanced settings, tick `Enable SteamVR track
|
|||||||
|
|
||||||
Warning: distro-native packages are known to have issues with Flatpak Steam.
|
Warning: distro-native packages are known to have issues with Flatpak Steam.
|
||||||
|
|
||||||
### Envision
|
### Option B: Build using Envision
|
||||||
Set WiVRn Profile as such:
|
Set WiVRn Profile as such:
|
||||||
- XR Service CMake Flags:
|
- XR Service CMake Flags:
|
||||||
- `WIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON`
|
- `WIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON`
|
||||||
@@ -166,7 +166,7 @@ Set WiVRn Profile as such:
|
|||||||
|
|
||||||
Perform a **Clean Build** after changing the CMake flags!
|
Perform a **Clean Build** after changing the CMake flags!
|
||||||
|
|
||||||
### NixOS
|
### Option C: NixOS
|
||||||
Override the `wivrn` package and launch wivrn-server with the required environment variables:
|
Override the `wivrn` package and launch wivrn-server with the required environment variables:
|
||||||
```nix
|
```nix
|
||||||
{
|
{
|
||||||
@@ -186,7 +186,7 @@ Override the `wivrn` package and launch wivrn-server with the required environme
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Manual
|
### Option D: Manual Build
|
||||||
Simply pass `-DWIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON` to CMake and export the above environment variables before starting `wivrn-server`.
|
Simply pass `-DWIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON` to CMake and export the above environment variables before starting `wivrn-server`.
|
||||||
|
|
||||||
### Usage tips
|
### Usage tips
|
||||||
|
|||||||
Reference in New Issue
Block a user