add: proton-osu-bin and umu osu

pkgs/default.nix

@@ -62,7 +62,7 @@
       };
 
       osu-stable = pkgs.callPackage ./osu-stable {
-        inherit (config.packages) osu-mime;
+        inherit (config.packages) osu-mime proton-osu-bin umu;
         wine = config.packages.wine-osu;
         wine-discord-ipc-bridge = config.packages.wine-discord-ipc-bridge.override {wine = config.packages.wine-osu;};
       };
@@ -80,6 +80,8 @@
         '';
       };
 
+      proton-osu-bin = pkgs.callPackage ./proton-osu-bin {};
+
       roblox-player = pkgs.callPackage ./roblox-player {
         wine = config.packages.wine-tkg;
         inherit (config.packages) wine-discord-ipc-bridge;

pkgs/osu-stable/README.md

@@ -7,3 +7,11 @@ of files. In any case, **do not stop the command!**
 
 If anything goes wrong and for some reason osu! won't start, delete the `~/.osu`
 directory and re-run `osu-stable`.
+
+## Additional Overrides
+
+This package has the following additional overrides:
+
+- `protonPath` Proton compatibility tool if umu is used.
+Defaults to [`proton-osu`](../proton-osu/README.md).
+- `protonVerbs`

pkgs/osu-stable/default.nix

@@ -7,9 +7,14 @@
   wine-discord-ipc-bridge,
   winetricks,
   wine,
+  umu,
+  proton-osu-bin,
   wineFlags ? "",
   pname ? "osu-stable",
   location ? "$HOME/.osu",
+  useUmu ? false,
+  protonPath ? "${proton-osu-bin.steamcompattool}",
+  protonVerbs ? ["waitforexitandrun"],
   tricks ? ["gdiplus" "dotnet45" "meiryo"],
   preCommands ? "",
   postCommands ? "",
@@ -35,26 +40,62 @@
     # disables vsync for OpenGL
     export vblank_mode=0
 
-    PATH=$PATH:${wine}/bin:${winetricks}/bin
+    # ID for umu
+    export GAMEID="osu-wine-umu"
+    export STORE="none"
+
+    PATH=${
+      lib.makeBinPath (
+        if useUmu
+        then [umu]
+        else [wine winetricks]
+      )
+    }:$PATH
     USER="$(whoami)"
     OSU="$WINEPREFIX/drive_c/osu/osu!.exe"
 
-    if [ ! -d "$WINEPREFIX" ]; then
-      # install tricks
-      winetricks -q -f ${tricksFmt}
-      wineserver -k
+    ${
+      if useUmu
+      then ''
+        export PROTON_VERBS="${lib.strings.concatStringsSep "," protonVerbs}"
+        export PROTONPATH="${protonPath}"
+
+        if [ ! -d "$WINEPREFIX" ]; then
+          umu-run winetricks ${tricksFmt}
+        fi
+
+        if [ ! -f "$OSU" ]; then
+          umu-run ${src}
+          mv "$WINEPREFIX/drive_c/users/steamuser/AppData/Local/osu!" $WINEPREFIX/drive_c/osu
+        fi
+      ''
+      else ''
+        if [ ! -d "$WINEPREFIX" ]; then
+          # install tricks
+          winetricks -q -f ${tricksFmt}
+          wineserver -k
 
-      # install osu
-      wine ${src}
-      wineserver -k
-      mv "$WINEPREFIX/drive_c/users/$USER/AppData/Local/osu!" $WINEPREFIX/drive_c/osu
-    fi
+          # install osu
+          wine ${src}
+          wineserver -k
+          mv "$WINEPREFIX/drive_c/users/$USER/AppData/Local/osu!" $WINEPREFIX/drive_c/osu
+        fi
+      ''
+    }
 
     ${preCommands}
 
-    wine ${wine-discord-ipc-bridge}/bin/winediscordipcbridge.exe &
-    ${gamemode}/bin/gamemoderun wine ${wineFlags} "$OSU" "$@"
-    wineserver -w
+    ${
+      if useUmu
+      then ''
+        ${gamemode}/bin/gamemoderun umu-run "$OSU" "$@"
+      ''
+      else ''
+        wine ${wine-discord-ipc-bridge}/bin/winediscordipcbridge.exe &
+        ${gamemode}/bin/gamemoderun wine ${wineFlags} "$OSU" "$@"
+        wineserver -w
+      ''
+    }
 
     ${postCommands}
   '';

pkgs/proton-osu-bin/README.md

@@ -0,0 +1,4 @@
+# proton-osu-bin
+
+Build of Wine/Proton with various patches, such as low-latency audio.
+Intended to be used with osu!.

pkgs/proton-osu-bin/default.nix

@@ -0,0 +1,40 @@
+{
+  lib,
+  stdenvNoCC,
+  fetchzip,
+}:
+stdenvNoCC.mkDerivation (finalAttrs: {
+  pname = "proton-osu-bin";
+  version = "proton-osu-9-7";
+
+  src = fetchzip {
+    url = "https://github.com/whrvt/umubuilder/releases/download/${finalAttrs.version}/${finalAttrs.version}.tar.xz";
+    hash = "sha256-SPj7ogWjPxlBILRiGmMXti0fZyyLdzfoA308xbIAn3Q=";
+  };
+
+  outputs = [
+    "out"
+    "steamcompattool"
+  ];
+
+  buildCommand = ''
+    runHook preBuild
+
+    echo "${finalAttrs.pname} should not be installed into environments. Please use programs.steam.extraCompatPackages instead." > $out
+
+    ln -s $src $steamcompattool
+
+    runHook postBuild
+  '';
+
+  meta = {
+    description = ''
+      Compatibily tool for Steam Play, patched with low-latency audio and intended for osu!.
+
+      (This is intended for use in the `programs.steam.extraCompatPackages` option only.)
+    '';
+    homepage = "https://github.com/whrvt/umubuilder";
+    license = lib.licenses.gpl3Plus;
+    platforms = ["x86_64-linux"];
+  };
+})