add: Rocket league umu

[emrebicer]

After seeing the discussion at #151 and PR #193, I wanted to introduce Umu to Rocket League as well. Finally, I had some free time and made Rocket League work with Umu.

However, there is still an issue that I could not find a solution to yet. If I enable umu, I can run bakkesmod alongside rocket-league, however once bakkesmod tries to inject, it fails and gives an error message that goes Injection failed, please download vc_redist.x86.exe and restart your PC. A Google search made me believe that the error message is implying I should have Microsoft Visual C++ Redistributable in the prefix, however even after trying to install vcrun2019 with winetricks (umu-run winetricks vcrun2019) or manually running the installer.exe (VC_redist.x86.exe or x64) in the prefix through umu, I still get the same error message bakkesmod.

I have been looking into possible solutions but could not get far. I wonder if anyone here has a suggestion to find a solution for that.

So TLDR; RL works with umu, and bakkesmod runs but does not inject. Any ideas on how can I fix that?

[fufexan]

In my case the game doesn't seem to launch at all.

[emrebicer]

I guessed perhaps I was not adding umu to PATH correctly, but I just removed umu from my config and RL still seems to work without issues, and looks like the path is set correctly.

I added WINEPREFIX to umu scripts as well, maybe legendary was not directing to the correct game files. Though I am not confident that was the issue for you.

it could be helpful if you shared with which attributes/values you call rocket-league in your config and what the output is when you start rocket-league from the terminal

[fufexan]

Currently testing directly from the repo using this patch

diff --git a/pkgs/default.nix b/pkgs/default.nix
index 234bbf5..576a177 100644
--- a/pkgs/default.nix
+++ b/pkgs/default.nix
@@ -86,6 +86,7 @@
       rocket-league = pkgs.callPackage ./rocket-league {
         wine = config.packages.wine-tkg;
         inherit (config.packages) umu;
+        useUmu = true;
       };
 
       star-citizen = pkgs.callPackage ./star-citizen {

Output log is

nix-gaming on  rocket-league-umu [≡✓] via   
› nix run .#rocket-league
warning: Git tree '/home/mihai/Documents/code/git/nix-gaming' is dirty
do you want to allow configuration setting 'allowInsecure' to be set to 'true' (y/N)? 
do you want to permanently mark this value as untrusted (y/N)? 
warning: ignoring untrusted flake configuration setting 'allowInsecure'.
Pass '--accept-flake-config' to trust it
do you want to allow configuration setting 'extra-substituters' to be set to 'https://nix-gaming.cachix.org' (y/N)? 
do you want to permanently mark this value as untrusted (y/N)? 
warning: ignoring untrusted flake configuration setting 'extra-substituters'.
Pass '--accept-flake-config' to trust it
do you want to allow configuration setting 'extra-trusted-public-keys' to be set to 'nix-gaming.cachix.org-1:nbjlureqMbRAxR1gJ/f3hxemL9svXaZF/Ees8vCUUs4=' (y/N)? 
do you want to permanently mark this value as untrusted (y/N)? 
warning: ignoring untrusted flake configuration setting 'extra-trusted-public-keys'.
Pass '--accept-flake-config' to trust it
[Core] INFO: Trying to re-use existing login session...
[cli] INFO: Preparing download for "Rocket League®" (Sugar)...
[Core] INFO: Parsing game manifest...
[Core] INFO: Install path: /home/mihai/Games/rocket-league/rocketleague
[Core] INFO: Selected CDN: fastly-download.epicgames.com (https)
[DLM] INFO: Found 0 missing files.
[cli] INFO: Download size is 0, the game is either already up to date or has not changed. Exiting...
[cli] INFO: Logging in...
[Core] INFO: Trying to re-use existing login session...
[cli] INFO: Checking for updates...
[Core] INFO: Getting authentication token...
[cli] INFO: Launching Sugar...
gamemodeauto:                                                                                                                                                                                     
gamemodeauto: 
gamemodeauto: 

nix-gaming on  rocket-league-umu [≡✓] via   took 8s 
› gamemodeauto: 
steamrt is up to date
UMU-Proton is up to date
/nix/store/836by2rrl5xxwnnc4kbd9v21j9gglmv7-gvfs-1.54.2/lib/gvfs/libgvfscommon.so: undefined symbol: g_task_set_static_name
Failed to load module: /nix/store/836by2rrl5xxwnnc4kbd9v21j9gglmv7-gvfs-1.54.2/lib/gio/modules/libgioremote-volume-monitor.so
/nix/store/836by2rrl5xxwnnc4kbd9v21j9gglmv7-gvfs-1.54.2/lib/gvfs/libgvfscommon.so: undefined symbol: g_task_set_static_name
Failed to load module: /nix/store/836by2rrl5xxwnnc4kbd9v21j9gglmv7-gvfs-1.54.2/lib/gio/modules/libgvfsdbus.so
/nix/store/xj09bp6qdnf5aswgw9wpjcx2n9267ggp-dconf-0.40.0-lib/lib/gio/modules/libdconfsettings.so: undefined symbol: g_assertion_message_cmpint
Failed to load module: /nix/store/xj09bp6qdnf5aswgw9wpjcx2n9267ggp-dconf-0.40.0-lib/lib/gio/modules/libdconfsettings.so
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
ERROR: ld.so: object '/tmp/pressure-vessel-libs-WVY9R2/${PLATFORM}/libgamemodeauto.so.0' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
ERROR: ld.so: object '/tmp/pressure-vessel-libs-WVY9R2/${PLATFORM}/libgamemodeauto.so.0' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
fsync: up and running.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
wine: using kernel write watches, use_kernel_writewatch 1.
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory
dbus[435206]: arguments to dbus_pending_call_block() were incorrect, assertion "pending != NULL" failed in file dbus-pending-call.c line 766.
This is normally a bug in some application using the D-Bus library.

  D-Bus not built with -rdynamic so unable to print a backtrace

Removing gamemoderun occurrences from the derivation gets rid of the gamemode and dbus logs, but the game still doesn't launch.
Not sure what the issue with gamemode is, as I have gamemoded running.

[emrebicer]

I just noticed we were not adding gamemode to the path correctly, but I don't think that was the issue with your case anyway. Honestly, when I run rocket-league, the output is pretty similar, I don't see any noticeable difference, except the game runs normally. Perhaps we can try looking into umu logs like that;

$ UMU_LOG=debug rocket-league

[fufexan]

Sure, here's the log.
rl.log

[emrebicer]

I just compared the output with the output on my end, it looks pretty similar except for the wine: using kernel write watches, use_kernel_writewatch 1. statements toward the end, where I don't have such logs. I don't think that tells anything helpful though.

To debug further I would recommend creating a shell with umu-run and legendary-gl, they try to manually run the game directly through umu-run,

export GAMEID=umu-252950
export STORE=egs
export PROTON_VERB=runinprefix

legendary update Sugar --base-path ${location}
legendary launch Sugar --no-wine --wrapper "umu-run" --base-path ${location} --dry-run

With the dry run option, the last command should print the command legendary will run and just exit. Then you can try manually running this command without including gamemode or any other dependencies in the way. Also, it might be worth trying to setup the envvar PROTONPATH=GE-Proton to use a different version of proton.

But at this point, it becomes a little too much work and I am not confident that this kind of debugging can get us somewhere, so one option is to leave the PR in this state as a draft and come back to it when there are new releases or improvements from umu project. Honestly, it is a bit sad to see that even nix struggles with the "it works on my machine" problem.

[fufexan]

@emrebicer following your instructions I managed to get it to launch after a nix flake update.

[emrebicer]

That is very good to hear, so does the PR also work after the nix flake update by any chance? Or just the dry-run? If it is only the dry run, then perhaps you can try prepending the gamemoderun command before the dry-run output, so we can see if gamemode is somehow at fault

[fufexan]

Only the dry-run works. Strangely enough, it also works if I prepend gamemoderun, but not when I do nix run .#rocket-league.

[emrebicer]

I think I found the culprit here. I moved to another (physical) place where I don't have access to the desktop I have developed the changes for this PR, but I have my Nvidia desktop that is mentioned at #186 .

On this desktop. I can reproduce the issue you are having, I simply can't run Rocket League with Umu with this PR. I did do some digging and I believe the issue is with the environment variable export PROTON_VERB=runinprefix. By default, if this environment variable is not found, umu will set the option to PROTON_VERB=waitforexitandrun and I think this is the recommended way to use umu, however since I wanted to introduce bakkesmod option from nix-gaming I need to be able to run 2 programs at the same time using umu, so I set this env var to runinprefix as it is recommended in the umu project wiki.

Again, it was working without issues on my other desktop, but apparently, there is something wrong with it so it doesn't work on my Nvidia machine or your environment...

So I suggest for now we focus on making Rocket League work in any environment with umu and ignore bakkesmod case at the moment. Given that, I pushed a commit that removes the line where we set the mentioned env var. With that change, Rocket League Umu works on my Nvidia machine as well without issues. (A side note: there are no performance issues with umu, so this PR might lead to closing #186 as well.)

Can you please try with the latest change as well? If it also works for you without issues, then we can focus on how we can support bakkesmod with Umu as well, I guess I can open an issue about it at the Umu project repo and ask for their help/recommendations about it.

[fufexan]

@emrebicer I'm terribly sorry for the delay, the notification must have slipped my view.

I've just tested this, seems to work well despite the gamemode errors (which are probably a skill issue on my part).

[emrebicer]

No worries, I also get many gamemode errors that go gamemodeauto: dlopen failed - libgamemode.so: cannot open shared object file: No such file or directory. I don't know if this is the same issue, but similar issues are still open at upstream like here and there.

However despite the error, looks like gamemode is being activated, as the output of gamemoded -s is returning gamemode is active when Rocket League is running. So I am not sure if this is something we can fix / should be worried about.

Update: Looks like there is an issue with the same error message here, but to my understanding, it is also not something to worry about if gamemoded status is returning gamemode is active, which is the case.

[fufexan]

Okay, then hopefully it will be fixed upstream. Thanks for looking into it.

[emrebicer]

Hello, since there has been some time passed I wanted to update the dependencies and give another look into the issue within this PR.

So I have synced my fork with upstream nix-gaming and now it points to umu-launcher version 1.1.4 (3.12.7 (main, Oct 1, 2024, 02:05:46) [GCC 13.3.0]). First I have tested setting the export PROTON_VERB=runinprefix env var for Rocket League and tested that, and on my Nvidia system the behavior is the same, the game process just ends immediately after starting it.

My suspicion is that this is happening because we are trying to start Umu with a wrapper, namely legendary launch. If I run it with --dry-run and get the raw command for RL, even with the env var set, the game will launch. Although it still behaves strangely, so I have not included a fix for that yet in the PR.

(NOTE: as a refresher, that env var is only needed because I want to include support for bakkesmod, and to run 2 programs in the same prefix, we need that env var)

However, I came to realize that even though that env var borks rocket league (with legendary) for some reason, we are setting it for bakkesmod and bakkesmod still works fine with it. That being said, I tried first launching Rocket League and then bakkesmod, which ended up in an environment where both run simultaneously using umu with the same prefix. So that already felt like an improvement, but running them at the same time is not enough, as stated at the top comment of this PR, even though bakkesmod launches, when we want to inject the mod into the game it still shows a warning that goes Injection failed, please download vc_redist.x86.exe and restart your PC.

HOWEVER, even though there is such an error, the mod seems to inject and I can use it within the game. (By pressing F2 in the game to access the bakkesmod menu).

Following that finding, I started looking for a solution to the missing dependency of vc_redist. Umu supports winetricks, so I just tried setting up the winetricks verb vcrun2022 in the umu prefix. However, that did not resolve the warning on the bakkesmod.

I wanted to share my findings here hoping that someone might provide some help or suggestions regarding the mentioned issues, also perhaps it might be helpful for future encounters with umu issues. All that being said, one can argue that, now a user can play RL with umu, and even though it is not perfect a user can use bakkesmod with it as well. So I wonder if that would be somewhat satisfactory for merging this or should we halt it until all the mentioned issues are fixed.

So TLDR;

• If the user only wants to play RL using umu and doesn't care about bakkesmod, all works!
• If the user wants to play RL using umu and wants bakkesmod as well, The user needs to start RL first, then bakkesmod (if bakkesmod is started first, RL won't launch until the bakkesmod is killed). When injecting bakkesmod, it will say that it failed due to a missing dependency (vc_redist.x86.exe) but it will actually inject and work.

[fufexan]

I'd suggest trying older vcrun20xx as well, and if that doesn't work, try to copy the resulting dll to bakkesmod's directory along with creating a dll override. Not sure it will work, but it's worth a try.

[emrebicer]

I tried installing all the vcrun20xx versions that I see on the winetricks verbs, but none of them resulted in a different behavior. I am not sure about the resulting DLLs, but I found vcruntime140.dll and kernel32.dll copied them to the same folder as bakkesmod.exe and tried rerunning things, it did not change any behavior either.

I don't know how to override DLLs on wine, googling suggested using winecfg, not sure how well winecfg is supported for proton but gave it a shot and ran it by setting the target umu prefix. Under the libraries tab, there are some DLLs but I did not see a way to override the DLL by path, it lets me choose the load order for native or builtin. So if you have some, I would appreciate some tips for achieving the overriding DLL suggestion.

Other than that I found other things such as, if I run umu-run winetricks <any_verb> before running RL, afterward it actually lets me run RL using PROTON_VERB=runinprefix env var. However, the result is not so satisfying as there is some flickering happening and performance is noticeably worse.

Another thing I tried was to create a .bat script to launch bakkesmod and RL at the same time just for testing purposes (I wanted to create an environment where I run both of them without setting PROTON_VERB=runinprefix while using umu). It kinda worked, they both started and bakkesmod injected without throwing the missing dependency error... However, then I realized if I start them this way, RL won't respond to keyboard/mouse and screen resize events and just be stuck at the entrance screen to the game (it is not frozen but I could not just proceed to play the game). My best guess is that there might be a proton limitation somehow that prevents focusing on multiple windows. However, the important finding here is that bakkesmod injects fine without throwing an error if it is started without the PROTON_VERB=runinprefix env var.

So my take on these findings is; for whatever reason using PROTON_VERB=runinprefix messes with the behaviour of the programs, and AFAIK this is the only way to run multiple programs at once. I already opened an issue regarding that on the umu repository here. However the issue is kind of waiting for more reports atm and their reasonable take is "This is technically not a bug with the launcher, but rather a possible constraint with an upstream component or an OS issue.".

[fufexan]

@emrebicer it's been a while, and now that RL requires EAC to play, I've decided to revisit this. I've rebased this PR and integrated it with the changes made in #353 to try to fix #362.

It seems we need GE-Proton to be able to use the EAC runtime, as standard umu builds do not have the necessary integration.

I also haven't tried to fiddle with bakkesmod, but it's worth a check.

Going forward we may only be able to play Rocket League with GE-Proton, so I believe we can remove the wine codepath.

[emrebicer]

Hello @fufexan, I am a bit surprised to see that there is an issue regarding the eac update. Since I have been using my own fork for playing Rocket League, and even with eac update, I did not have any issues, the legendary binary just made the update, and things worked.

Looking at my config, I have been using

nix-gaming.url = "github:emrebicer/nix-gaming/rocket-league-umu";
...
rl_wine = "${inputs.nix-gaming.packages.${pkgs.stdenv.hostPlatform.system}.wine-ge}";
...
    home.packages = with pkgs; [
      (inputs.nix-gaming.packages.${pkgs.stdenv.hostPlatform.system}.rocket-league.override {
	wine = "${rl_wine}";
	dxvk_hud = "0";
	enableBakkesmod = true;
	useUmu = true;
      })
    ];

Since I was using umu, I think the wine parameter was not being used anyway, and it seems things work with umu-launcher, by default (unless PROTONPATH is set) I think it uses UMU-Proton.

I believe the only reason I did not finalize and merge this PR was that there was an issue with umu where it was not allowing 2 simultaneous programs to run in the same pressure vessel. So when I ran Rocket League and Bakkesmod at the same time, it was throwing an error saying that it failed, even though it would still attach and work. I wanted to make sure things worked without flaws before I merged this. I have been keeping an eye on that Umu issue, but it is still not fixed to this day.

That being said, there were some updates regarding the bakkesmod as well. Due to the EAC update, it is not possible to use the mod during online gameplay anymore, so it is not as convenient as it used to be (personally, I have not used it since the EAC update). However, it still might be cool to have it available in nix-gaming for people who would like to benefit from the mod for offline gameplay. Seems like Psyonix also supports this.

I wanted to share my insights in this comment, but I can gladly help with testing or updating the package.

[emrebicer]

I have been doing some testing on the rebased branch, and I was not able to start RL after the integrated changes. I tried with not setting a wine option (I think it defaults to wine-tkg) and also setting the wine parameter to wine-ge. However, both failed to start the game on my pc; it either halts or exits without a meaningful output.

However, umu-launcher seems to work out of the box. I can just set useUmu to true, and the game starts right away without any issues. At least for online gameplay with EAC, I had no issues.

I also tried to launch the game without eac and the game launches, bakkesmod also launches, however does not attach to the game even though it was started without EAC. I suspect it might be related to the umu-launcher issue mentioned in my previous comment.

It would be nice if we could have other people test this as well. If this behaviour is consistent, I suggest we just default to using the umu-launcher (or perhaps fully disable the wine option and only offer umu?), and regarding bakkesmod, even though I think it would be cool to keep the support, it is becoming a burden and does not offer the benefits it once used to, so honesly it might also make sense to get rid of it as well, or just keep it here and revisit it once the umu-launcher issue is resolved.

[fufexan]

Revisiting this (again). I've tried running it with umu, without PROTONPATH set, with and without enableEAC, in a clean prefix, but I get a window saying "Failed to initialize dependencies" paired with this log

System.Exception: wayland not available
  at Xalia.Sdl.SplitOverlayBox.CreateWindows () [0x0005b] in <5b50cb9692864a58a57a8b9091dd6c44>:0 
  at Xalia.Sdl.SplitOverlayBox..ctor (Xalia.Sdl.WindowingSystem windowingSystem) [0x0002e] in <5b50cb9692864a58a57a8b9091dd6c44>:0 
  at Xalia.Sdl.WindowingSystem.CreateOverlayBox () [0x0001b] in <5b50cb9692864a58a57a8b9091dd6c44>:0 
  at Xalia.Ui.UiMain..ctor () [0x00039] in <5b50cb9692864a58a57a8b9091dd6c44>:0 
  at Xalia.MainClass.Init (Xalia.Gudl.GudlStatement[] config) [0x0001b] in <5b50cb9692864a58a57a8b9091dd6c44>:0

If I set PROTONPATH="GE-Proton" it works fine (without enableEAC).

[emrebicer]

• Fixed the enableEAC option, it actually allows starting the game with/witout EAC now
• Removed the wine option as we can not seem to start the game with wine since the EAC update (so now it only allows umu launcher)
• Added a new parameter umuProtonPath to allow using a custom proton build, defaults to Proton-GE (this then looks up the $HOME/.local/share/Steam/compatibilitytools.d for the requested proton Path to a Proton directory, version name (e.g., GE-Proton9-5) or codename (e.g., GE-Proton))

the bakkesmod does not work atm, but I am in favor of keeping it, once the upstream bug is fixed, it can still be useful. It defaults to false and maybe we can add a mark/warning about it.

If these changes seem good I think we can consider merging now.

[fufexan]

Runs fine, overall lgtm.

[fufexan]

Great work, LGTM!

[fufexan]

@emrebicer wanted to let you know I got bakkesmod working again on master 1f64f73.

[emrebicer]

@fufexan Seems to work as intended on my end; well done! Feel free to ping me about future requests for RL.