Skip to content

Commit 629ad2e

Browse files
Update Linux Installation
* linux-installation: minor spelling and wording tweaks * linux-installation: use vrpathreg to add slimevr driver to steamvr * linux-installation: don't recommend running steamvr components out of SLR This can break many components of SteamVR, like the dashboard. Use `PRESSURE_VESSEL_FILESYSTEMS_RW` to make the socket file available to the driver from inside the sandbox. * linux-installation: recommend using distribution packages instead of appimage * docs: PR clean-up --------- Co-authored-by: ShineBrightMeow <[email protected]>
1 parent 1d51fc9 commit 629ad2e

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

src/tools/linux-installation.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installing OpenVR Plugin
22

3-
In order to SlimeVR to communicate with SteamVR, you'll need to install an OpenVR plugin into your Steam installation. On Windows, this happens automatically with SlimeVR's installer. On Linux, this needs to be done manually.
3+
In order for SlimeVR to communicate with SteamVR, you'll need to install the OpenVR driver into your Steam installation. On Windows, this happens automatically with SlimeVR's installer. On Linux, this needs to be done manually.
44

55
If you don't plan to use SlimeVR with SteamVR, this section can be skipped.
66

@@ -12,29 +12,27 @@ If you don't plan to use SlimeVR with SteamVR, this section can be skipped.
1212

1313
You'll then need to identify the root directory of the Steam installation on your system. In most cases, it should be located at `~/.steam/steam/`.
1414

15-
From here, you'll need to navigate to `steamapps/common/SteamVR/drivers/`. For most common cases, this will result in a final path of `~/.steam/steam/steamapps/common/SteamVR/drivers/`.
16-
17-
This is where you will be installing the plugin.
18-
1915
### 3. Extract and install
2016

21-
Extract the archive you downloaded in step 1. This should give you a bunch of files and folders nested in a root `slimevr` folder. Simply move the `slimevr` folder into the `drivers` directory identified in step 2, and the plugin should now be installed. If done correctly, you should now have a `steamapps/common/SteamVR/drivers/slimevr/bin/linux64/` folder (among other things).
17+
Extract the archive you downloaded in step 1. This will give you a set of files and folders inside a root `slimevr` folder.
18+
19+
Then run `<steam path>/steamapps/common/SteamVR/bin/vrpathreg.sh adddriver path/to/slimevr`, replacing `<steam path>` with the path to your Steam installation and `/path/to/slimevr` with the full path to the extracted `slimevr` folder.
2220

2321
You will need to restart SteamVR for changes to take effect, though you likely won't notice any difference until you have SlimeVR trackers set up.
2422

2523
### 4. Set the SteamVR launch argument
2624

27-
SteamVR will sometimes need a launch argument in order to load the SlimeVR driver.
28-
To set the launch argument, open Steam, right-click on SteamVR in your library, select "Properties" and you should see a field to input the launch argument.
29-
In most cases, your launch argument should be something like `~/.steam/steam/steamapps/common/SteamVR/bin/vrmonitor.sh %command%`, but you might need to adjust the path based on where Steam is installed.
25+
SteamVR needs a launch argument to allow the SlimeVR driver to connect to the server.
26+
To set the launch argument, open Steam, right-click on SteamVR in your library, select "Properties" and you should see a field where you can enter launch arguments.
27+
In most cases, the launch argument should be: `PRESSURE_VESSEL_FILESYSTEMS_RW="$XDG_RUNTIME_DIR/SlimeVRDriver" %command%`. You may need to adjust this if you already have other launch arguments set.
3028

3129
# Installing Java
3230

3331
The SlimeVR Server depends on Java 17, so you'll need to install it on your system in a way that SlimeVR can access.
3432

35-
### Option 1: Instal Java globally
33+
### Option 1: Install Java globally
3634

37-
The simplest and most straight-forward way to setup Java is to install it through your distro's package manager. The specific package name will vary distro to distro, but it will most likely be listed as "`openjdk`", and you'll most likely want the `jre` (though `jdk` will work fine).
35+
The simplest and most straightforward way to set up Java is to install it through your distro's package manager. The specific package name will vary distro to distro, but it will most likely be listed as "`openjdk`", and you'll most likely want the `jre` (though `jdk` will work fine).
3836

3937
Ubuntu:
4038

@@ -97,16 +95,32 @@ Parent Directory
9795

9896
# Running SlimeVR
9997

100-
The recommended way to run SlimeVR on Linux (in a desktop environment) is to use the standalone AppImage executable. This comes with the server and GUI both bundled into one.
98+
The recommended way to run SlimeVR on Linux (in a desktop environment) is to use the package built for your distribution. This comes with the server, GUI, and udev rules (required for the serial console) all bundled into one. Config and logs will be stored in `~/.config/dev.slimevr.SlimeVR/`.
99+
100+
### Arch Linux
101+
102+
Install [`slimevr-beta-bin`](https://aur.archlinux.org/packages/slimevr-beta-bin) from the AUR.
103+
104+
### Fedora
105+
106+
Install the [.rpm package](https://github.com/SlimeVR/SlimeVR-Server/releases/latest/download/SlimeVR-amd64.rpm) from the latest server release on GitHub.
107+
108+
### Debian/Ubuntu/Mint
109+
110+
Install the [.deb package](https://github.com/SlimeVR/SlimeVR-Server/releases/latest/download/SlimeVR-amd64.deb) from the latest server release on GitHub.
111+
112+
### NixOS
113+
114+
Add the [`slimevr`](https://search.nixos.org/packages?channel=unstable&show=slimevr&query=slimevr) package to `environment.systemPackages` in your system configuration.
101115

102-
[The latest AppImage can be downloaded here](https://github.com/SlimeVR/SlimeVR-Server/releases/latest/download/SlimeVR-amd64.appimage), or obtained by downloading
103-
`SlimeVR-amd64.appimage` from [the latest SlimeVR-Server release](https://github.com/SlimeVR/SlimeVR-Server/releases/).
116+
### AppImage (for other distributions)
104117

105-
For most common Linux distros, you should then be able to start SlimeVR by simply executing the AppImage. Config and logs will be stored in `~/.config/dev.slimevr.SlimeVR/`
118+
The latest AppImage can be downloaded [from the GitHub releases](https://github.com/SlimeVR/SlimeVR-Server/releases/latest/download/SlimeVR-amd64.appimage). The package built for your distribution should be preferred if available, since the AppImage does not include the udev rules.
119+
You should then be able to start SlimeVR by simply executing the AppImage.
106120

107121
# Serial Console
108122

109-
In able to gain access to the Serial Console on Linux, you will need to grant your user account access to PlatformIO devices. Without the correct access, the Serial Console will continue to display "Connection to serial lost, Reconnecting..." after a SlimeVR tracker has been connected via USB.
123+
If you are not using a distribution package of SlimeVR, you will need to grant your user account access to PlatformIO devices. Without the correct access, the Serial Console will continue to display "Connection to serial lost, Reconnecting..." after a SlimeVR tracker has been connected via USB.
110124

111125
The recommended way to gain access is by installing PlatformIO's udev rules. This can be done using the instructions on this page: <https://docs.platformio.org/en/latest/core/installation/udev-rules.html>
112126

@@ -124,7 +138,7 @@ Source: [firewall.bat](https://github.com/SlimeVR/SlimeVR-Server/blob/main/serve
124138

125139
# Legacy Setup
126140

127-
If the above AppImage works for you, then you can disregard everything in this section.
141+
If the above installation methods work for you, then you can disregard everything in this section.
128142

129143
If for some reason the above setup does not work for you, then you may need to retrieve and run the SlimeVR components manually.
130144

@@ -142,7 +156,7 @@ You can download the latest required GUI from here:
142156

143157
### 1. Open the latest workflow run
144158

145-
Click on the title of the latest workflow run, this is simply an example and the exact one at the top will change.
159+
Click on the title of the latest workflow run, this is simply an example; the exact one at the top will change.
146160

147161
### 2. Download the desired artifact
148162

@@ -159,7 +173,7 @@ Once you have the file downloaded (ex. `SlimeVR-GUI-AppImage.zip`), extract it t
159173
To most easily use the program, you'll need to have things structured in a specific way.
160174

161175
1. Make a new folder to contain your installation, name it whatever you want (ex. `SlimeVR Server`).
162-
2. Place the SlimeVR Server, SlimeVR GUI, and optional Java JRE components you downloaded into the folder you made
176+
2. Place the SlimeVR Server, SlimeVR GUI, and optional Java JRE components you downloaded into the folder you made.
163177

164178
Example of the final directory structure:
165179

0 commit comments

Comments
 (0)