Merge pull request #268619 from tweag/lib-descriptions
[NixPkgs.git] / pkgs / games / quakespasm / vulkan.nix
blob50862be46bd3910fe8c65a9875a5bb46f9d9f483
1 { lib, stdenv, fetchFromGitHub, makeWrapper
2 , SDL2, gzip, libvorbis, libmad, vulkan-headers, vulkan-loader, moltenvk
3 }:
5 stdenv.mkDerivation rec {
6   pname = "vkquake";
7   version = "1.22.3";
9   src = fetchFromGitHub {
10     owner = "Novum";
11     repo = "vkQuake";
12     rev = version;
13     sha256 = "sha256-+8DU1QT3Lgqf1AIReVnXQ2Lq6R6eBb8VjdkJfAn/Rtc=";
14   };
16   sourceRoot = "${src.name}/Quake";
18   nativeBuildInputs = [
19     makeWrapper
20     vulkan-headers
21   ];
23   buildInputs = [
24     gzip
25     SDL2
26     libvorbis
27     libmad
28     vulkan-loader
29   ] ++ lib.optional stdenv.isDarwin moltenvk;
31   buildFlags = [ "DO_USERDIRS=1" ];
33   preInstall = ''
34     mkdir -p "$out/bin"
35   '';
37   makeFlags = [ "prefix=$(out) bindir=$(out)/bin" ];
39   postFixup = ''
40     wrapProgram $out/bin/vkquake \
41       --prefix LD_LIBRARY_PATH : ${vulkan-loader}/lib
42   '';
44   enableParallelBuilding = true;
46   meta = with lib; {
47     description = "Vulkan Quake port based on QuakeSpasm";
48     homepage = src.meta.homepage;
49     longDescription = ''
50       vkQuake is a Quake 1 port using Vulkan instead of OpenGL for rendering.
51       It is based on the popular QuakeSpasm port and runs all mods compatible with it
52       like Arcane Dimensions or In The Shadows. vkQuake also serves as a Vulkan demo
53       application that shows basic usage of the API. For example it demonstrates render
54       passes & sub passes, pipeline barriers & synchronization, compute shaders, push &
55       specialization constants, CPU/GPU parallelism and memory pooling.
56     '';
58     platforms = with platforms; linux ++ darwin;
59     maintainers = with maintainers; [ ylh ];
60   };