nixpkgs/pkgs/games/xonotic/default.nix
Andreas Rammhold f5e95757f2
xonotic: support user statistics reporting
Xonotic supports (opt-in) tracking of user statistics. For staistics to
be trackable each player needs a unique identifier that is based on some
cryptographic identity. For that to work we need to build the "blind"
library and provide it do xonotic during runtime.

The official xonotic releases ship with the public key of some sort of
central trust authority and thus we must retain that file within our
data package as well.

Before this commit the crypto_* commands in the ingame console weren't
available. With this commit you should be able to execute "crypto_keys"
commands as show below.

  $ crypto_keys
  0: public key key_0.d0pk (fingerprint: Xon//KssdlzGkFKdnnN4sgg8H+koTbBn5JTi37BAW1Q=)
     private ID key_0.d0si (public key fingerprint: 9piqrk8ajAPRc3BnSbkac5GA+yL3dOwh53BhyrfmVlI=)

Once the above command works you have to configure your player profile
to allow tracking (if you want) via the Multiplayer -> Profile dialog.
In the top right-hand corner there will be checkboxes to control the
level of tracking that you are opting in to.
2021-08-30 17:13:00 +02:00

179 lines
5.6 KiB
Nix

{ lib, stdenv, fetchurl, fetchzip, makeWrapper, runCommand, makeDesktopItem
, xonotic-data, copyDesktopItems
, # required for both
unzip, libjpeg, zlib, libvorbis, curl
, # glx
libX11, libGLU, libGL, libXpm, libXext, libXxf86vm, alsa-lib
, # sdl
SDL2
, # blind
gmp
, withSDL ? true
, withGLX ? false
, withDedicated ? true
}:
let
pname = "xonotic";
version = "0.8.2";
name = "${pname}-${version}";
variant =
if withSDL && withGLX then
""
else if withSDL then
"-sdl"
else if withGLX then
"-glx"
else if withDedicated then
"-dedicated"
else "-what-even-am-i";
meta = {
description = "A free fast-paced first-person shooter";
longDescription = ''
Xonotic is a free, fast-paced first-person shooter that works on
Windows, macOS and Linux. The project is geared towards providing
addictive arena shooter gameplay which is all spawned and driven
by the community itself. Xonotic is a direct successor of the
Nexuiz project with years of development between them, and it
aims to become the best possible open-source FPS of its kind.
'';
homepage = "https://www.xonotic.org/";
license = lib.licenses.gpl2Plus;
maintainers = with lib.maintainers; [ astsmtl zalakain petabyteboy ];
platforms = lib.platforms.linux;
};
desktopItem = makeDesktopItem {
name = "xonotic";
exec = "xonotic";
comment = meta.description;
desktopName = "Xonotic";
categories = "Game;Shooter;";
icon = "xonotic";
startupNotify = "false";
};
xonotic-unwrapped = stdenv.mkDerivation rec {
pname = "xonotic${variant}-unwrapped";
inherit version;
src = fetchurl {
url = "https://dl.xonotic.org/xonotic-${version}-source.zip";
sha256 = "0axxw04fyz6jlfqd0kp7hdrqa0li31sx1pbipf2j5qp9wvqicsay";
};
nativeBuildInputs = [ unzip ];
buildInputs = [ libjpeg zlib libvorbis curl gmp ]
++ lib.optional withGLX [ libX11.dev libGLU.dev libGL.dev libXpm.dev libXext.dev libXxf86vm.dev alsa-lib.dev ]
++ lib.optional withSDL [ SDL2.dev ];
sourceRoot = "Xonotic/source/darkplaces";
# "debug", "release", "profile"
target = "release";
dontStrip = target != "release";
postConfigure = ''
pushd ../d0_blind_id
./configure $configureFlags
popd
'';
buildPhase = (lib.optionalString withDedicated ''
make -j $NIX_BUILD_CORES -l $NIX_BUILD_CORES sv-${target}
'' + lib.optionalString withGLX ''
make -j $NIX_BUILD_CORES -l $NIX_BUILD_CORES cl-${target}
'' + lib.optionalString withSDL ''
make -j $NIX_BUILD_CORES -l $NIX_BUILD_CORES sdl-${target}
'') + ''
pushd ../d0_blind_id
make -j $NIX_BUILD_CORES -l $NIX_BUILD_CORES
popd
'';
enableParallelBuilding = true;
installPhase = (''
for size in 16x16 24x24 32x32 48x48 64x64 72x72 96x96 128x128 192x192 256x256 512x512 1024x1024 scalable; do
install -Dm644 ../../misc/logos/xonotic_icon.svg \
$out/share/icons/hicolor/$size/xonotic.svg
done
'' + lib.optionalString withDedicated ''
install -Dm755 darkplaces-dedicated "$out/bin/xonotic-dedicated"
'' + lib.optionalString withGLX ''
install -Dm755 darkplaces-glx "$out/bin/xonotic-glx"
'' + lib.optionalString withSDL ''
install -Dm755 darkplaces-sdl "$out/bin/xonotic-sdl"
'') + ''
pushd ../d0_blind_id
make install
popd
'';
# Xonotic needs to find libcurl.so at runtime for map downloads
dontPatchELF = true;
postFixup = lib.optionalString withDedicated ''
patchelf --add-needed ${curl.out}/lib/libcurl.so $out/bin/xonotic-dedicated
'' + lib.optionalString withGLX ''
patchelf \
--add-needed ${curl.out}/lib/libcurl.so \
--add-needed ${libvorbis}/lib/libvorbisfile.so \
--add-needed ${libvorbis}/lib/libvorbis.so \
--add-needed ${libGL.out}/lib/libGL.so \
$out/bin/xonotic-glx
'' + lib.optionalString withSDL ''
patchelf \
--add-needed ${curl.out}/lib/libcurl.so \
--add-needed ${libvorbis}/lib/libvorbisfile.so \
--add-needed ${libvorbis}/lib/libvorbis.so \
$out/bin/xonotic-sdl
'';
};
in rec {
xonotic-data = fetchzip {
name = "xonotic-data";
url = "https://dl.xonotic.org/xonotic-${version}.zip";
sha256 = "15caj11v9hhr7w55w3rs1rspblzr9lg1crqivbn9pyyq0rif8cpl";
extraPostFetch = ''
cd $out
rm -rf $(ls | grep -v "^data$" | grep -v "^key_0.d0pk$")
'';
meta.hydraPlatforms = [];
passthru.version = version;
};
xonotic = runCommand "xonotic${variant}-${version}" {
inherit xonotic-unwrapped;
nativeBuildInputs = [ makeWrapper copyDesktopItems ];
desktopItems = [ desktopItem ];
passthru = {
inherit version;
meta = meta // {
hydraPlatforms = [];
};
};
} (''
mkdir -p $out/bin
'' + lib.optionalString withDedicated ''
ln -s ${xonotic-unwrapped}/bin/xonotic-dedicated $out/bin/
'' + lib.optionalString withGLX ''
ln -s ${xonotic-unwrapped}/bin/xonotic-glx $out/bin/xonotic-glx
ln -s $out/bin/xonotic-glx $out/bin/xonotic
'' + lib.optionalString withSDL ''
ln -s ${xonotic-unwrapped}/bin/xonotic-sdl $out/bin/xonotic-sdl
ln -sf $out/bin/xonotic-sdl $out/bin/xonotic
'' + lib.optionalString (withSDL || withGLX) ''
mkdir -p $out/share
ln -s ${xonotic-unwrapped}/share/icons $out/share/icons
copyDesktopItems
'' + ''
for binary in $out/bin/xonotic-*; do
wrapProgram $binary --add-flags "-basedir ${xonotic-data}" --prefix LD_LIBRARY_PATH : "${xonotic-unwrapped}/lib"
done
'');
}