Resonite: update for the splittening #137

Merged
bredo228 merged 9 commits from resonite-splittening into main 2025-08-21 22:39:56 -04:00

View File

@@ -5,29 +5,11 @@ weight: 50
# Resonite
{{% hint info %}}
**Note**: The Linux-native version of Resonite, amid deprioritization of developer time to fix its numerous issues, was put on indefinite hold in August 2024 and later removed in March 2025. This document only covers running under Proton.
{{% /hint %}}
{{% hint warning %}}
Steam will sometimes try and run Resonite without using Proton. This may be due to the removal of the Linux native build.
If Resonite fails to start, you may need to force Proton to be used.
{{% /hint %}}
The current recommended Proton variant is [**Proton GE**](https://github.com/GloriousEggroll/proton-ge-custom/releases/latest).
[XRizer](/docs/fossvr/xrizer/) should now provide a close-to-flawless experience on most controllers and when using hand tracking. If you encounter any major issues you can fallback to [OpenComposite](/docs/fossvr/opencomposite/).
[XRizer](/docs/fossvr/xrizer/) should now provide a close-to-flawless experience on most controllers and when using hand tracking.
## Visual bugs
There are some minor visual bugs specific to running Resonite on Proton, such as textures taking longer to load and appearing black for a few seconds when close to the player.
## Mirrors look cross-eyed
When playing Resonite under [Monado](https://lvra.gitlab.io/docs/fossvr/monado/) or [WiVRn](https://lvra.gitlab.io/docs/fossvr/wivrn/), the 3D effect of mirrors may appear way off, as if looking through them feels like your eyes are crossed. This only affects headsets with canted displays (e.g. Valve Index, Pimax).
@@ -36,13 +18,17 @@ To solve this, prepend `OXR_PARALLEL_VIEWS=1` to Resonite's launch options.
## Performance
Resonite currently runs under an extremely old version of Mono runtime required by Unity, which has very poor Garbage Collection causing frequent lag spikes and frame hitching during asset loading and unloading. Very soon, Resonite will be updated to use .NET 9, a far more modern and bespoke runtime, with Unity running on a separate thread only for rendering the game. Eventually Unity will be replaced by a custom rendering engine as well.
In August 2025, Resonite updated to run FrooxEngine as a native Linux process, with the renderer being run through Proton.
The main developer and owner of Resonite goes into more detail [here](https://youtu.be/9cx2-VtL_LM&t=16).
In larger sessions Resonite is typically CPU-bound, there isn't much that can be done besides upgrading your CPU. In situations where the GPU is a bottleneck, lowering the resolution <!-- TODO link to resolution scaling --> (either in the OpenXR runtime or through OpenComposite) may help dramatically.
Resonite is typically GPU-bottlenecked. Lowering the resolution <!-- TODO link to resolution scaling --> may help.
This can be easily done by prepending `OXR_VIEWPORT_SCALE_PERCENTAGE=75` to Resonite's launch options. Experiment with different values to find your preferred balance between performance and quality.
## Visemes
Currently, viseme analysis does not work on Linux due to Meta not providing a Linux native build of OVRLipSync (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/5151#issuecomment-3170453491)
There is an experimental mod developed by the community that allows for viseme analysis under Linux - https://github.com/KyuubiYoru/VisemesAtHome.
## Mods
Resonite has a thriving modding community with an abundance of [mods](https://wiki.resonite.com/Mods) that offer greater user experience, optimizations and new features.
@@ -59,25 +45,19 @@ You can load RML mods with MonkeyLoader but not the other way around.
The exact cause of this is currently unknown. Consider using MonkeyLoader if you encounter such issues starting the game as it seems to not cause the same problem.
### ResonitePlatformSpoof
- [Mod Repo](https://github.com/isovel/ResonitePlatformSpoof)
- [Link to working version](https://github.com/isovel/ResonitePlatformSpoof/issues/2#issuecomment-2439588723)
{{% hint info %}}
See [issue #2745](https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/2745#issuecomment-2573574108) for more context as to why the Linux badge isn't available for Proton users.
{{% /hint %}}
When the native Linux build of Resonite was still available, players are given a Linux badge to show others that they are running the native build of the client. When Proton is used to play the windows build of the game, you will not get the Linux badge. However, ResonitePlatformSpoof lets you 'spoof' your platform to the Linux native build and allows proton users to get the Linux badge.
## Crashes
Resonite has been seen causing random SteamVR crashes on Linux before. In some situations the engine also tends to freeze. On OpenComposite, the game will rarely close out on its own without leaving any obvious trace of things going wrong &mdash; this is being investigated.
### Renderer issues
The cause of these issues and whether they are Proton-specific isn't currently known.
Resonite's renderer is known to randomly crash suddenly - this is currently tracked at https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/5325.
There is also a known memory leak when running the renderer on Linux - however, it is uncertain currently whether this is an issue with Proton or there is something else at play - see https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/5246.
### OpenComposite
Currently, OpenComposite is known to crash Resonite when used in VR, so attempting to use OpenComposite for Resonite is not recommended.
See https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/5152 for more information.
### Crash on loading into a world with video players
@@ -90,22 +70,3 @@ Resonite allows a VR player to take a break and switch to desktop mode by pressi
Because controller hot-swapping is not yet implemented in Monado & OpenComposite, turning off a controller will freeze its state, including buttons pressed and analog stick input. Resonite will continue processing VR inputs even after switching to desktop.
The end result is that desktop controls can act strangely. For example, if you were holding the grab sensor as you turned off the VR controller, picking up items or inspector windows stops working with the mouse.
## Splittening
{{% hint info %}}
The Splittening is currently in pre-release. Linux should work OOTB, albeit a few issues.
{{% /hint %}}
{{% hint warning %}}
The Splittening being in pre-release may have visual glitches. As such it is not recommended if you have any form of epilepsies. Please be warry of that.
{{% /hint %}}
The Splittening is still in active development, as such the linux support still varies a lot.
please use [this repository](https://github.com/baplar/resonitelinuxsplitteningpatches?tab=readme-ov-file) for any up to date information
for VR support: OpenComposite appear to crash. Please use xrizer instead.