fork/slippi-nix
git clone https://git.julia.blue/fork/slippi-nix
7950757
main
1{ 2inputs = { 3nixpkgs . url = "github:nixos/nixpkgs/nixos-unstable" ; 4git-hooks . url = "github:cachix/git-hooks.nix" ; 5git-hooks . inputs . nixpkgs . follows = "nixpkgs" ; 6home-manager . url = "github:nix-community/home-manager" ; 7home-manager . inputs . nixpkgs . follows = "nixpkgs" ; 8}; 9 10nixConfig = { 11extra-substituters = [ 12"https://slippi-nix.cachix.org" 13]; 14 15extra-trusted-public-keys = [ 16"slippi-nix.cachix.org-1:2qnPHiOxTRpzgLEtx6K4kXq/ySDg7zHEJ58J6xNDvBo=" 17]; 18}; 19 20outputs = { 21nixpkgs , 22git-hooks , 23home-manager , 24self , 25 ... 26} :let 27defaults = { 28netplay = { 29version = "3.4.4" ; 30hash = "sha256-L+8DvEsaSGzJBg1gN3K4ntzvfnXFMssgKqPU40iOSTs=" ; 31}; 32netplay-beta = { 33version = "4.0.0-mainline-beta.8" ; 34hash = "sha256-f9jx1ZzUr6oxCvPS1RG115EX13ocTeoEAdrke7YnWu0=" ; 35}; 36playback = { 37version = "3.4.5" ; 38hash = "sha256-iCBdlcBPSRT8m772sqI+gSfNmVNAug0SfkSwVUE6+fE=" ; 39}; 40launcher = { 41version = "2.11.7" ; 42hash = "sha256-wlPAbXzUdmu0zQE6H1FfUc4bk3yBptauC+86mwWFrRg=" ; 43}; 44}; 45 46inherit ( self ) outputs ; 47forSystems = nixpkgs . lib . genAttrs [ 48# "aarch64-linux" 49# "aarch64-darwin" 50# "x86_64-darwin" 51"x86_64-linux" 52]; 53pkgsFor = system :( import nixpkgs { inherit system ;}); 54genPkgs = func :( forSystems ( system :func ( pkgsFor system ))); 55in { 56overlays = { 57default = outputs . overlays . slippi ; 58 59slippi = final :prev :{ 60inherit ( outputs . packages .${ final . system }. slippi ) slippi-netplay slippi-playback slippi-launcher ; 61}; 62}; 63 64packages = genPkgs ( pkgs :{ 65default = outputs . packages .${ pkgs . system }. slippi-launcher ; 66slippi-netplay-beta = pkgs . callPackage ({ 67stdenvNoCC , 68appimageTools , 69fetchzip , 70makeWrapper , 71lib , 72version ? defaults . netplay-beta . version , 73hash ? defaults . netplay-beta . hash , 74} : let 75pname = "Slippi_Netplay_Mainline-x86_64.AppImage" ; 76zip = fetchzip { 77inherit hash ; 78url = "https://github.com/project-slippi/dolphin/releases/download/v ${ version } /Mainline-Slippi- ${ version } -Linux.zip" ; 79stripRoot = false ; 80}; 81src = " ${ zip } /Slippi_Netplay_Mainline-x86_64.AppImage" ; 82in 83stdenvNoCC . mkDerivation { 84inherit pname version ; 85nativeBuildInputs = [ 86makeWrapper 87]; 88src = appimageTools . wrapType2 { 89inherit pname version src ; 90extraPkgs = pkgs: with pkgs ; [ curl libsForQt5 . qt5 . qttools ]; 91}; 92 93installPhase = '' 94runHook preInstall 95mkdir -p " $ out /bin" 96cp -r " $ src /bin" " $ out " 97wrapProgram $ out /bin/ ${ pname } \ 98--set QT_QPA_PLATFORM xcb 99runHook postInstall 100'' ; 101}) {}; 102slippi-netplay = pkgs . callPackage ({ 103stdenvNoCC , 104appimageTools , 105fetchzip , 106version ? defaults . netplay . version , 107hash ? defaults . netplay . hash , 108} : let 109pname = "Slippi_Online-x86_64.AppImage" ; 110zip = fetchzip { 111inherit hash ; 112url = "https://github.com/project-slippi/Ishiiruka/releases/download/v ${ version } /FM-Slippi- ${ version } -Linux.zip" ; 113stripRoot = false ; 114}; 115src = " ${ zip } /Slippi_Online-x86_64.AppImage" ; 116in 117stdenvNoCC . mkDerivation { 118inherit pname version ; 119 120src = appimageTools . wrapType2 { 121inherit pname version src ; 122extraPkgs = pkgs: with pkgs ; [ curl zlib mpg123 ]; 123 124postInstall = '' 125ls -la " $ out " 126wrapProgram $ out /bin/ ${ pname } - ${ version } \ 127--add-flags "\'' $ {NIXOS_OZONE_WL:+\'' $ { WAYLAND_DISPLAY:+--ozone-platform-hint=auto --enable-features=WaylandWindowDecorations}}" 128'' ; 129}; 130 131installPhase = '' 132runHook preInstall 133 134mkdir -p " $ out /bin" 135cp -r " $ src /bin" " $ out " 136 137runHook postInstall 138'' ; 139}) {}; 140slippi-playback = pkgs . callPackage ({ 141stdenvNoCC , 142appimageTools , 143fetchzip , 144version ? defaults . playback . version , 145hash ? defaults . playback . hash , 146} : let 147pname = "Slippi_Playback-x86_64.AppImage" ; 148zip = fetchzip { 149inherit hash ; 150url = "https://github.com/project-slippi/Ishiiruka-Playback/releases/download/v ${ version } /playback- ${ version } -Linux.zip" ; 151stripRoot = false ; 152}; 153src = " ${ zip } /Slippi_Playback-x86_64.AppImage" ; 154in 155stdenvNoCC . mkDerivation { 156inherit pname version ; 157 158src = appimageTools . wrapType2 { 159inherit pname version src ; 160extraPkgs = pkgs: with pkgs ; [ curl zlib mpg123 ]; 161 162postInstall = '' 163ls -la " $ out " 164wrapProgram $ out /bin/ ${ pname } - ${ version } \ 165--add-flags "\'' $ {NIXOS_OZONE_WL:+\'' $ { WAYLAND_DISPLAY:+--ozone-platform-hint=auto --enable-features=WaylandWindowDecorations}}" 166'' ; 167}; 168 169installPhase = '' 170runHook preInstall 171 172mkdir -p " $ out /bin" 173cp -r " $ src /bin" " $ out " 174 175runHook postInstall 176'' ; 177}) {}; 178slippi-launcher = pkgs . callPackage ({ 179stdenvNoCC , 180appimageTools , 181fetchurl , 182copyDesktopItems , 183version ? defaults . launcher . version , 184hash ? defaults . launcher . hash , 185} : let 186pname = "slippi-launcher-appimage" ; 187 188src = fetchurl { 189inherit hash ; 190url = "https://github.com/project-slippi/slippi-launcher/releases/download/v ${ version } /Slippi-Launcher- ${ version } -x86_64.AppImage" ; 191}; 192 193appImageContents = appimageTools . extractType2 { 194inherit pname version src ; 195}; 196in 197stdenvNoCC . mkDerivation { 198inherit pname version ; 199 200src = appimageTools . wrapType2 { 201inherit pname version src ; 202extraPkgs = pkgs: with pkgs ; [ curl zlib mpg123 ]; 203 204postInstall = '' 205ls -la " $ out " 206wrapProgram $ out /bin/ ${ pname } - ${ version } \ 207--add-flags "\'' $ {NIXOS_OZONE_WL:+\'' $ { WAYLAND_DISPLAY:+--ozone-platform-hint=auto --enable-features=WaylandWindowDecorations}}" 208'' ; 209}; 210 211# TODO: see if we can convince upstream to let us specify command line 212# arguments to denote where the netplay and playback binaries are? 213# this might eliminate the need for the home manager module 214installPhase = '' 215runHook preInstall 216 217mkdir -p " $ out /bin" 218mkdir -p " $ out /share/applications" 219cp -r " $ src /bin" " $ out " 220cp -r " ${ appImageContents } / $( readlink " ${ appImageContents } /slippi-launcher.png ")" " $ out /share/applications/" 221sed '/Icon/d' " ${ appImageContents } /slippi-launcher.desktop " > " $ out/share/applications/slippi-launcher.desktop" 222sed '/Exec/d' " ${ appImageContents } /slippi-launcher.desktop " > " $ out/share/applications/slippi-launcher.desktop" 223echo "Icon= $ out/share/applications/slippi-launcher.png" >> " $ out/share/applications/slippi-launcher.desktop" 224echo "Exec= $ out/bin/ ${ pname } %U " >> " $ out/share/applications/slippi-launcher.desktop" 225 226runHook postInstall 227'' ; 228 229nativeBuildInputs = [ copyDesktopItems ]; 230}) {}; 231}); 232 233formatter = genPkgs ( p: p . alejandra ); 234 235checks = genPkgs ( pkgs: { 236inherit ( outputs . packages .${ pkgs . system }) slippi-launcher slippi-netplay slippi-playback ; 237git-hooks = git-hooks . lib .${ pkgs . system }. run { 238src = ./. ; 239hooks = { 240alejandra . enable = true ; 241}; 242}; 243home-manager-module-test = pkgs . testers . runNixOSTest { 244# a simple integration test to ensure that the home manager module 245# works, boots a host, implying a successful NixOS configuration, and 246# creates the configuration file referencing the correct packages' 247# versions 248name = "home-manager-module-test" ; 249nodes . machine = { 250config , 251pkgs , 252... 253} : 254with pkgs . lib ; { 255imports = [ 256home-manager . nixosModules . home-manager 257( 258# nixos/tests/common/auto.nix from nixpkgs 259{ config , ... } : let 260cfg = config . test-support . displayManager . auto ; 261in { 262options = { 263test-support . displayManager . auto = { 264enable = mkOption { 265default = false ; 266description = '' 267Whether to enable the fake "auto" display manager, which 268automatically logs in the user specified in the 269{option}`user` option. This is mostly useful for 270automated tests. 271'' ; 272}; 273user = mkOption { 274default = "root" ; 275description = "The user account to login automatically." ; 276}; 277}; 278}; 279config = { 280services . xserver . displayManager . lightdm . enable = cfg . enable ; 281services . displayManager . autoLogin = { 282enable = cfg . enable ; 283user = cfg . user ; 284}; 285security . pam . services . lightdm-autologin . text = mkIf cfg . enable ( mkForce '' 286auth requisite pam_nologin.so 287auth required pam_succeed_if.so quiet 288auth required pam_permit.so 289account include lightdm 290password include lightdm 291session include lightdm 292'' ); 293}; 294} 295) 296{ 297services . xserver . enable = true ; 298test-support . displayManager . auto . enable = true ; 299services . displayManager . defaultSession = mkDefault "none+icewm" ; 300services . xserver . windowManager . icewm . enable = true ; 301} 302]; 303users . users . daniel = { 304isNormalUser = true ; 305home = "/home/daniel" ; 306createHome = true ; 307extraGroups = [ "wheel" "users" ]; 308}; 309test-support . displayManager . auto . user = "daniel" ; 310home-manager . users . daniel = { 311imports = with outputs . homeManagerModules ; [ 312slippi-launcher 313]; 314slippi-launcher . enable = true ; 315home = { 316username = "daniel" ; 317homeDirectory = "/home/daniel" ; 318stateVersion = "24.11" ; 319}; 320}; 321environment . systemPackages = with pkgs ; [ jq ]; 322system . stateVersion = "24.11" ; 323}; 324testScript = { nodes , ... } : '' 325def as_user(cmd: str): 326""" 327Return a shell command for running a shell command as a specific user. 328""" 329return f"sudo -u daniel -i -- bash -c \"{cmd}\"" 330 331with subtest("ensure slippi launcher settings file references correct versions"): 332machine.wait_for_unit("default.target") 333machine.succeed("grep ${ defaults . netplay . version } '/home/daniel/.config/Slippi Launcher/Settings'") 334machine.succeed("grep ${ defaults . playback . version } '/home/daniel/.config/Slippi Launcher/Settings'") 335 336with subtest("ensure netplay appimage version is correct"): 337machine.wait_for_unit("default.target") 338machine.wait_for_x() 339machine.wait_for_file("/home/daniel/.Xauthority") 340machine.succeed("xauth merge /home/daniel/.Xauthority") 341machine.succeed(as_user(""" 342"''$(jq -r '.settings.netplayDolphinPath' '/home/daniel/.config/Slippi Launcher/Settings')/Slippi_Online-x86_64.AppImage" --version | grep ${ defaults . netplay . version } 343""")) 344'' ; 345}; 346}); 347 348nixosModules = { 349default = { 350imports = with outputs . nixosModules ; [ 351gamecube-controller-adapter 352]; 353}; 354 355gamecube-controller-adapter = { 356lib , 357config , 358... 359} : let 360inherit ( lib ) mkEnableOption mkOption types mkIf ; 361cfg = config . gamecube-controller-adapter ; 362in { 363# defaults here are true since we assume if you're importing the module, you 364# want it on ;) 365options . gamecube-controller-adapter = { 366enable = mkEnableOption "Enable the optimal gamecube controller adapter experience." // { default = true ;}; 367 368overclocking-kernel-module . enable = mkEnableOption "Turn on gamecube controller adapter overclocking kernel module." // { default = true ;}; 369 370udev-rules . enable = mkEnableOption "Turn on udev rules for your gamecube controller adapter." // { default = true ;}; 371udev-rules . rules = mkOption { 372default = '' 373ATTRS{idVendor}=="057e", ATTRS{idProduct}=="0337", MODE="666", SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device" TAG+="uaccess" 374'' ; 375type = types . lines ; 376description = "To be appended to services.udev.extraRules if gcc.rules.enable is set." ; 377}; 378}; 379 380config = { 381gamecube-controller-adapter . udev-rules . enable = mkIf cfg . enable true ; 382gamecube-controller-adapter . overclocking-kernel-module . enable = mkIf cfg . enable true ; 383 384services . udev . extraRules = mkIf cfg . udev-rules . enable cfg . udev-rules . rules ; 385 386boot . extraModulePackages = mkIf cfg . overclocking-kernel-module . enable [ 387# https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/gcadapter-oc-kmod/default.nix 388config . boot . kernelPackages . gcadapter-oc-kmod 389]; 390boot . kernelModules = mkIf cfg . overclocking-kernel-module . enable [ 391"gcadapter_oc" 392]; 393}; 394}; 395}; 396 397homeManagerModules = { 398default = { 399imports = with outputs . homeManagerModules ; [ 400slippi-launcher 401]; 402}; 403 404slippi-launcher = { 405lib , 406pkgs , 407config , 408... 409} : let 410inherit ( lib ) mkEnableOption mkOption types mkIf ; 411cfg = config . slippi-launcher ; 412flakePackages = outputs . packages .${ pkgs . system }; 413netplay-beta-package = version: hash: 414flakePackages . slippi-netplay-beta . overrideAttrs { 415inherit version hash ; 416}; 417netplay-package = version: hash: 418flakePackages . slippi-netplay . overrideAttrs { 419inherit version hash ; 420}; 421playback-package = version: hash: 422flakePackages . slippi-playback . overrideAttrs { 423inherit version hash ; 424}; 425launcher-package = version: hash: 426flakePackages . slippi-launcher . overrideAttrs { 427inherit version hash ; 428}; 429in { 430# defaults here are true since we assume if you're importing the module, you 431# want it on ;) 432options . slippi-launcher = { 433enable = mkEnableOption "Install Slippi Launcher" // { default = true ;}; 434 435netplayVersion = mkOption { 436default = defaults . netplay . version ; 437type = types . str ; 438description = "The version of Slippi Netplay to install." ; 439}; 440netplayHash = mkOption { 441default = defaults . netplay . hash ; 442type = types . str ; 443description = "The hash of the Slippi Netplay AppImage to install." ; 444}; 445 446netplayBetaVersion = mkOption { 447default = defaults . netplay-beta . version ; 448type = types . str ; 449description = "The version of Slippi Netplay (Mainline beta) to install." ; 450}; 451netplayBetaHash = mkOption { 452default = defaults . netplay-beta . hash ; 453type = types . str ; 454description = "The hash of the Slippi Netplay (Mainline beta) AppImage to install." ; 455}; 456 457playbackVersion = mkOption { 458default = defaults . playback . version ; 459type = types . str ; 460description = "The version of Slippi Playback to install." ; 461}; 462playbackHash = mkOption { 463default = defaults . playback . hash ; 464type = types . str ; 465description = "The hash of the Slippi Playback AppImage to install." ; 466}; 467 468launcherVersion = mkOption { 469default = defaults . launcher . version ; 470type = types . str ; 471description = "The version of Slippi Launcher to install." ; 472}; 473launcherHash = mkOption { 474default = defaults . launcher . hash ; 475type = types . str ; 476description = "The hash of the Slippi Launcher AppImage to install." ; 477}; 478 479isoPath = mkOption { 480default = "" ; 481type = types . str ; 482description = "The path to an NTSC Melee ISO." ; 483}; 484useNetplayBeta = mkEnableOption "Use the mainline Dolphin instead of the stable version." // { default = false ;}; 485 486launchMeleeOnPlay = mkEnableOption "Launch Melee in Dolphin when the Play button is pressed." // { default = true ;}; 487 488enableJukebox = mkEnableOption "Enable in-game music via Slippi Jukebox. Incompatible with WASAPI." // { default = true ;}; 489 490rootSlpPath = mkOption { 491default = " ${ config . home . homeDirectory } /Slippi" ; 492type = types . str ; 493description = "The folder where your SLP replays should be saved." ; 494}; 495 496useMonthlySubfolders = mkEnableOption "Save replays to monthly subfolders" ; 497 498spectateSlpPath = mkOption { 499default = " ${ cfg . rootSlpPath } /Spectate" ; 500type = types . nullOr types . str ; 501description = "The folder where spectated games should be saved." ; 502}; 503 504extraSlpPaths = mkOption { 505default = []; 506type = types . listOf types . str ; 507description = "Choose any additional SLP directories that should show up in the replay browser." ; 508}; 509}; 510config = let 511cfgNetplayPackage = netplay-package cfg . netplayVersion cfg . netplayHash ; 512cfgNetplayBetaPackage = netplay-beta-package cfg . netplayBetaVersion cfg . netplayBetaHash ; 513cfgPlaybackPackage = playback-package cfg . playbackVersion cfg . playbackHash ; 514cfgLauncherPackage = launcher-package cfg . launcherVersion cfg . launcherHash ; 515in { 516home . packages = [( mkIf cfg . enable cfgLauncherPackage )]; 517home . file . ".config/Slippi Launcher/netplay/Slippi_Online-x86_64.AppImage" = { 518enable = cfg . enable ; 519source = " ${ cfgNetplayPackage } /bin/Slippi_Online-x86_64.AppImage" ; 520recursive = false ; 521}; 522home . file . ".config/Slippi Launcher/netplay/Sys" = { 523enable = cfg . enable ; 524source = " ${ pkgs . fetchzip { 525url = "https://github.com/project-slippi/Ishiiruka/releases/download/v ${ cfg . netplayVersion } /FM-Slippi- ${ cfg . netplayVersion } -Linux.zip" ; 526hash = cfg . netplayHash ; 527stripRoot = false ; 528}} /Sys" ; 529recursive = false ; 530}; 531home . file . ".config/Slippi Launcher/netplay-beta/Slippi_Netplay_Mainline-x86_64.AppImage" = { 532enable = cfg . useNetplayBeta ; 533source = " ${ cfgNetplayBetaPackage } /bin/Slippi_Netplay_Mainline-x86_64.AppImage" ; 534recursive = false ; 535}; 536home . file . ".config/Slippi Launcher/netplay-beta/Sys" = { 537enable = cfg . useNetplayBeta ; 538source = " ${ pkgs . fetchzip { 539url = "https://github.com/project-slippi/dolphin/releases/download/v ${ cfg . netplayBetaVersion } /Mainline-Slippi- ${ cfg . netplayBetaVersion } -Linux.zip" ; 540hash = cfg . netplayBetaHash ; 541stripRoot = false ; 542}} /Sys" ; 543recursive = false ; 544}; 545home . file . ".config/Slippi Launcher/playback/Slippi_Playback-x86_64.AppImage" = { 546enable = cfg . enable ; 547source = " ${ cfgPlaybackPackage } /bin/Slippi_Playback-x86_64.AppImage" ; 548recursive = false ; 549}; 550home . file . ".config/Slippi Launcher/playback/Sys" = { 551enable = cfg . enable ; 552source = " ${ 553pkgs . fetchzip { 554url = "https://github.com/project-slippi/Ishiiruka-Playback/releases/download/v ${ cfg . playbackVersion } /playback- ${ cfg . playbackVersion } -Linux.zip" ; 555hash = cfg . netplayHash ; 556stripRoot = false ; 557} 558} /Sys" ; 559recursive = false ; 560}; 561xdg . configFile . "Slippi Launcher/Settings" = { 562enable = cfg . enable ; 563source = let 564jsonFormat = pkgs . formats . json {}; 565in 566jsonFormat . generate "slippi-config" { 567settings = { 568isoPath = cfg . isoPath ; 569 570launchMeleeOnPlay = cfg . launchMeleeOnPlay ; 571enableJukebox = cfg . enableJukebox ; 572useNetplayBeta = cfg . useNetplayBeta ; 573 574rootSlpPath = cfg . rootSlpPath ; 575useMonthlySubfolders = cfg . useMonthlySubfolders ; 576spectateSlpPath = cfg . spectateSlpPath ; 577extraSlpPaths = cfg . extraSlpPaths ; 578 579netplayDolphinPath = " ${ 580if cfg . useNetplayBeta 581then cfgNetplayBetaPackage 582else cfgNetplayPackage 583} /bin/" ; 584playbackDolphinPath = " ${ cfgPlaybackPackage } /bin/" ; 585 586autoUpdateLauncher = false ; 587}; 588}; 589}; 590}; 591}; 592}; 593}; 594}