pkgs/games/openra/mod.nix

   1 /*  The package defintion for an OpenRA out-of-tree mod.
   2     It shares code with `engine.nix` by what is defined in `common.nix`.
   3     To build an out-of-tree mod it needs the source code of the engine available,
   4     and they each need to be build with a specific version or fork of the engine,
   5     so the engine needs to be supplied as an argument as well.
   6     The engine is relatively small and quick to build, so this is not much of a problem.
   7     Building a mod will result in a wrapper script that starts the mod inside the specified engine.
   8 */
   9 { lib, stdenv
  10 , packageAttrs
  11 , patchEngine
  12 , wrapLaunchGame
  13 , mod
  14 , engine
  15 }:
  16
  17 with lib;
  18
  19 let
  20   engineSourceName = engine.src.name or "engine";
  21   modSourceName = mod.src.name or "mod";
  22
  23 # Based on: https://build.opensuse.org/package/show/home:fusion809/openra-ura
  24 in stdenv.mkDerivation (recursiveUpdate packageAttrs rec {
  25   name = "${pname}-${version}";
  26   pname = "openra-${mod.name}";
  27   inherit (mod) version;
  28
  29   srcs = [
  30     mod.src
  31     engine.src
  32   ];
  33
  34   sourceRoot = ".";
  35
  36   postUnpack = ''
  37     mv ${engineSourceName} ${modSourceName}
  38     cd ${modSourceName}
  39   '';
  40
  41   postPatch = ''
  42     cat <<'EOF' > fetch-engine.sh
  43     #!/bin/sh
  44     exit 0
  45     EOF
  46
  47     sed -i 's/^VERSION.*/VERSION = ${version}/g' Makefile
  48
  49     dos2unix *.md
  50
  51     ${patchEngine engineSourceName engine.version}
  52   '';
  53
  54   configurePhase = ''
  55     runHook preConfigure
  56
  57     make version VERSION=${escapeShellArg version}
  58     make -C ${engineSourceName} version VERSION=${escapeShellArg engine.version}
  59
  60     runHook postConfigure
  61   '';
  62
  63   checkTarget = "test";
  64
  65   installPhase = ''
  66     runHook preInstall
  67
  68     make -C ${engineSourceName} install-engine install-common-mod-files DATA_INSTALL_DIR=$out/lib/${pname}
  69
  70     cp -r ${engineSourceName}/mods/{${concatStringsSep "," ([ "common" "modcontent" ] ++ engine.mods)}} mods/* \
  71       $out/lib/${pname}/mods/
  72
  73     substitute ${./mod-launch-game.sh} $out/lib/${pname}/launch-game.sh \
  74       --subst-var out \
  75       --subst-var-by name ${escapeShellArg mod.name} \
  76       --subst-var-by title ${escapeShellArg mod.title} \
  77       --subst-var-by assetsError ${escapeShellArg mod.assetsError}
  78     chmod +x $out/lib/${pname}/launch-game.sh
  79
  80     ${wrapLaunchGame "-${mod.name}"}
  81
  82     substitute ${./openra-mod.desktop} $(mkdirp $out/share/applications)/${pname}.desktop \
  83       --subst-var-by name ${escapeShellArg mod.name} \
  84       --subst-var-by title ${escapeShellArg mod.title} \
  85       --subst-var-by description ${escapeShellArg mod.description}
  86
  87     cp README.md $(mkdirp $out/share/doc/packages/${pname})/README.md
  88
  89     [[ -e mods/${mod.name}/icon.png ]] && mod_icon=mods/${mod.name}/icon.png || {
  90       [[ -e mods/${mod.name}/logo.png ]] && mod_icon=mods/${mod.name}/logo.png || mod_icon=packaging/linux/mod_256x256.png
  91     }
  92     cp "$mod_icon" $(mkdirp $out/share/pixmaps)/${pname}.png
  93
  94     for size in 16 32 48 64 128 256; do
  95       size=''${size}x''${size}
  96       cp packaging/linux/mod_''${size}.png $(mkdirp $out/share/icons/hicolor/''${size}/apps)/${pname}.png
  97     done
  98
  99     runHook postInstall
 100   '';
 101
 102   meta = {
 103     inherit (mod) description homepage;
 104   };
 105 })