meister1593 / alvr-distrobox-linux-guidance

Repository for guidance and collection of scripts to make playing ALVR on linux easier

Installing ALVR and using SteamVR on Linux through Distrobox

THIS GUIDANCE GOT MERGED INTO ALVR AND THIS REPOSITORY WON'T BE UPDATED ANYMORE, PLEASE FOLLOW THE GUIDE THERE

Disclaimer

1. This is just an attempt to make things easier for Linux users to use ALVR, SteamVR. By no means it's a comprehensive, fully featured and 100% working guide. Please open new issues and pull requests to correct this guide, scripts, etc etc.

2. This guide is not adjusted for Intel gpu owners yet. Only NVIDIA and AMDGPU (Low priority TODO).

3. Slimevr, OpenVRAS, Open Space Calibrator are all possible to launch and use on Linux, but this guide/script is not adjusted yet (Medium priority TODO).

4. Firewall configuration is skipped entirely and setup firewall configuration is broken, so it might not work in case you have strict firewall (alvr docs should have info about that) (Low priority TODO).

5. Don't use SteamVR Beta (1.26+) version, it contains a lot of breaking changes that are yet to be tested to work with.

6. This script can possibly set power profiles for gpus instead of mentioning usage of CoreCtrl (Low priority TODO, needs testing whenever cpu profiles can be set).

7. Some nvidia users might experience 307 steamvr crash, which is found at least with one user, and solution isn't found yet, but currently actively looking for the cause. Possible cause - latest 530 drivers, so if you happen to have this issue - please try downgrading them to 525 or updating drivers to higher than 530 on the host and re-running script. It seems like they has issues with running any container graphics software, including podman/distrobox and flatpak

8. At the moment, most of the portability issues were fixed, but it's not done, so if you happen to have any kind of issues while running both this and other distroboxes from your system, please report them. I created some issues at podman side (documentation issue, storage configuration issue, which prevents complete isolation from runtime containers at the moment) and created PR for distrobox (WIP) to upstream the changes.

9. This script unlikely to work on some external disk setups (still unsure if it affects all kind of disks on all filesystems).

Installing alvr in distrobox

For installing you only really need couple of dependencies on host:

1. wget + curl (to download podman/distrobox/alvr/etc)
2. xhost (on X11 to allow rootless podman to work with graphical applications)
3. sed (for removing color in logs)
4. pipewire for fully automatic microphone, pulseaudio for basic audio support (automatic microphone is unsupported with it)
5. For nvidia - CUDA (as distrobox passes through it into the container and CUDA contains NVENC encoder files)
6. If you don't have newgidmap command available, you need to install shadow-utils. (packages ubuntu-like: newuidmap, arch-like: shadow, mint: uidmap)

After you have installed required dependencies for your installation from above, open terminal in this repository folder and do:

1. ./setup.sh

   That's it. Follow all green and especially red text carefully from the scripts.

   In case if have errors during installation, please report the full log as-is (remove private info if you happen to have some) as an Issue.

   But if you are just reinstalling it, please run ./uninstall.sh first before trying to install again.

   After full installation, you can use ./start-alvr.sh to launch alvr automatically.

   Script also downloads related apk file to install to headset into installation folder for you. Use Sidequest or ADB to install it.

   Experimental: Prefixed installation is now available, which allows you to specify where to install relative to this folder. Use --prefix and --container-name to specify folder name and container name (you should specify both for this to work)

Post-install ALVR & SteamVR Configuration

After installing ALVR you may want to configure it and steamvr to run at best quality for your given hardware/gpu. Open up ALVR using ./start-alvr.sh script and do the following (each field with input value needs enter to confirm):

Common configuration:

1. Resolution: If you have 6600 XT level GPU you can select Low, and in case you don't mind lower FPS - Medium

2. Preferred framerate: If you know that you will have lower fps than usual (for instance, VRChat), run at lower fps. This is because when reprojection (this is what allows for smooth view despite being at low fps) goes lower than twice the amount of specified framerate - it fails to reproject and will look worse. So for example, you can run at 72hz if you know you're expecting low framerate, and 120hz if you are going to play something like Beat Saber, which is unlikely to run at low fps.

3. Encoder preset: Quality

4. Game Audio & Microphone: Set to pipewire as has been said in installation. ALVR uses default audio sink for audio, and doesn't care about volume (it's controlled only onboard audio on headset), so you can either leave it with volume for audio mirroring or mute to prevent mirroring on pc. As for microphone, every time ALVR is connected to headset, on connect script creates audio source named ALVR-MIC-Source, which can be used in game as default microphone, if you set it at least once. No need to un-set it back to default, when headset disconnects it automatically clears it and restores back to previous microphone.

5. Bitrate: Adaptive, maximum bitrate: 150 mbps, minimum bitrate: 100 mbps.

6. Foveated rendering: This highly depends on given headset, but generally default settings should be OK for Quest 2. For pico neo 3 i would recommend setting center region width to 0.8 and height to 0.75, shifts to 0 and edge ratios can be set at 6-7, and for the same pico neo 3 disable oculus foveation level and dynamic oculus foveation.

7. Color correction: Set sharpening to 1and if you like oversaturated image, bump saturation to 0.6.

8. For pico neo 3 left controller offsets (from top to bottom): Position -0.06, -0.03, -0.1; Rotation: 0, 3, 17.

9. Connection -> Stream Protocol: TCP. This ensures that there would be no heavy artifacts if packet loss happens (until it's too severe), only slowdowns.

10. Linux async reprojection: keep it off, it's not needed anymore and client does reprojection better

AMD-specific configuration:

1. Preferred codec: HEVC, h264 by far looked choppy and has blocking issues.

2. Reduce color banding: turn on, makes image even better

Nvidia-specific configuration (needs feedback):

1. Preferred codec: h264

After that, restart your headset using power button and it will automatically restart steamvr once, applying all changes.

SteamVR configuration:

Inside SteamVR you also may need to change settings to improve experience. Open settings by clicking on triple stripe on SteamVR window and expand Advanced Settings (Hide -> Show)

1. Disable SteamVR Home. It can be laggy, crashes often and generally not working nice on linux, so i would recommend disabling it altogether.

2. Render Resolution: - Custom and keep it at 100%. This is to ensure that SteamVR won't try to supersample resolution given by ALVR

3. Video tab: Fade To Grid on app hang - this would basically lock your view to last frame when app hangs instead of dropping you into steamvr void, completely optional but you may prefer that.

4. Video tab: Disable Advanced Supersample Filtering

5. Video tab: Per-application video settings - Use Legacy Reprojection Mode for specific game. This can drastically change experience from being very uncomfortable, rubber-banding, to straight up perfect. This essentially disables reprojection on SteamVR side and leaves it to the client entirely. Make sure to enable it for each game you will play. If you don't see that button, it is possible that you didn't apply patch from installation script, which means that opening each game video settings will take a while and may not even catch up at all after multiple minutes.

6. Developer tab: Set steamvr as openxr runtime - this ensures that games using openxr (such as Bonelab) will use SteamVR.

Distrobox note:

You can add your steam library from outside the container after alvr installation as for container, /home/user folder is the same as on your host, so you can easily add it from inside that steam.

Do note though, there has been mentioned some issues with mounted devices, symlinks and containers, so in case you have them, please report them to discover if it's really the case.

Updating ALVR & WlxOverlay

In case there was an update for ALVR or WlxOverlay in the repository, you can run ./update-vr-apps.sh with or without prefix. In case you want to manually update ALVR or WlxOverlay versions, you can change links.sh file accordingly and run the same script.

Uninstalling

To uninstall this, simply run ./uninstall.sh and it will automatically remove everything related to locally installed distrobox, it's containers, podman and everything inside in installation or prefixed folder.

Additional info

Highly recommend using CoreCtrl (install it using your distribution package management) and setting settings to VR profile for AMD gpus, as well as cpu to performance profile (if it's a Ryzen cpu). Without setting those gpu profiles, you will have serious shutters/wobbles/possibly crashes (sway users) at random point while playing ([PERF] Subpar GPU performance due to wrong power profile mode · Issue #469 · ValveSoftware/SteamVR-for-Linux · GitHub).

alvr-distrobox-linux-guidance's Issues

Slight texture/block glitching in games (and steamvr home)

hello! First of all, i'd like to say thank you for setting up these scripts - i'd been messing around for a solid week trying to get steamvr and alvr working in a chroot, and I just couldn't manage it. This seems to work good!

.. I did notice some issues though. once i'm in VR, the the view is a bit... glitchy? It's hard to describe. It's 100% not game-ruining, but when i'm moving my vision around, I notice blocky artifacting when looking around - i'm not sure if it's a resolution issue or some sort of problem with steamvr, i'm not sure.

When I would run VR in my other distro (void linux) I used steamvr beta with alvr and it looked and worked great - I do remember having some slight graphic issues with non-beta steamvr - but beta doesn't seem to work with this setup, I just get a black screen in my quest 2. I'm not sure on settings, as in my other setup I didn't touch any of alvr's settings (other than turning on async reprojection, as I have an AMD card)

(Ah, some extra information here: interestingly, I actually ran alvr/steamvr WITHOUT turning on legacy reprojection, and the games worked just fine! That was of course with steamvr beta though, maybe that's only an option needed when using non-beta?)

Anyways, gonna provide some system info here:

OS: Source Mage GNU/Linux, 64-bit (no multilib, hence the need for this setup)
CPU: AMD Ryzen 7 5700X
Card: AMD rx 5700xt
ram: 32gb
kernel version: 6.2.11
DE: XFCE

Any help is appreciated! Again, thank you for the scripts!

When there is multiple GPU (AMD/Nvidia), AMD is always taken

When there is more than one GPU (AMD and Nvidia), the if of the GPU detection function always gives priority to AMD since it comes first. It would be better to let the user decide which GPU to take if there is more than one compatible.