edopro: init

fmt sound suggestions 1 license update add support for windbot escape string xdg directory with a fallback of $HOME add update script and new deps file finished update script format deps file remove testing logic remove tlater, because he is not in the maintainer list and didn't response to me Update pkgs/by-name/ed/edopro/package.nix Co-authored-by: Cosima Neidahl <[email protected]> Update pkgs/by-name/ed/edopro/package.nix Co-authored-by: Cosima Neidahl <[email protected]> Update pkgs/by-name/ed/edopro/package.nix Co-authored-by: Cosima Neidahl <[email protected]> Update pkgs/by-name/ed/edopro/package.nix Co-authored-by: Cosima Neidahl <[email protected]> Update pkgs/by-name/ed/edopro/package.nix Co-authored-by: Cosima Neidahl <[email protected]> Update pkgs/by-name/ed/edopro/package.nix Co-authored-by: Cosima Neidahl <[email protected]> Update pkgs/by-name/ed/edopro/package.nix Co-authored-by: Cosima Neidahl <[email protected]> Apply suggestions from code review Co-authored-by: Cosima Neidahl <[email protected]> change hash format Apply suggestions from code review Co-authored-by: Cosima Neidahl <[email protected]> Apply suggestions from code review Co-authored-by: Cosima Neidahl <[email protected]> add patchfile and multiarch function
NixOS · Oct 21, 2024 · 5439c14 · 5439c14
1 parent 0e4fd9c
commit 5439c14
Show file tree

Hide file tree

Showing 4 changed files with 470 additions and 0 deletions.
diff --git a/pkgs/by-name/ed/edopro/deps.nix b/pkgs/by-name/ed/edopro/deps.nix
diff --git a/pkgs/by-name/ed/edopro/ocgcore-lua-symbols.patch b/pkgs/by-name/ed/edopro/ocgcore-lua-symbols.patch
@@ -0,0 +1,29 @@
+From 41e750142b44465f3af197b7e2f0d6f54fc48c2d Mon Sep 17 00:00:00 2001
+From: OPNA2608 <[email protected]>
+Date: Mon, 21 Oct 2024 17:42:24 +0200
+Subject: [PATCH] Mark Lua symbols as C symbols
+
+Otherwise linking against our Lua built by a C-compiler fails due to the symbols being resolved as C++ symbols.
+---
+ interpreter.h | 2 ++
+ 1 file changed, 2 insertions(+)
+
+diff --git a/interpreter.h b/interpreter.h
+index 6c405a1..c471ecb 100644
+--- a/interpreter.h
++++ b/interpreter.h
+@@ -9,9 +9,11 @@
+ #define INTERPRETER_H_
+
+ // Due to longjmp behaviour, we must build Lua as C++ to avoid UB
++extern "C" {
+ #include <lua.h>
+ #include <lualib.h>
+ #include <lauxlib.h>
++}
+
+ #include "common.h"
+ #include <unordered_map>
+-- 
+2.44.1
+
diff --git a/pkgs/by-name/ed/edopro/package.nix b/pkgs/by-name/ed/edopro/package.nix
@@ -0,0 +1,320 @@
+{
+  lib,
+  stdenv,
+  fetchFromGitHub,
+  fetchzip,
+  premake5,
+  writeShellScriptBin,
+  runCommandLocal,
+  symlinkJoin,
+  imagemagick,
+  bzip2,
+  curl,
+  flac,
+  # Use fmt 10+ after release 40.1.4+
+  fmt_9,
+  freetype,
+  libevent,
+  libgit2,
+  libGL,
+  libGLU,
+  libjpeg,
+  libpng,
+  libvorbis,
+  libX11,
+  libxkbcommon,
+  libXxf86vm,
+  lua5_3,
+  mono,
+  nlohmann_json,
+  openal,
+  SDL2,
+  sqlite,
+  wayland,
+  egl-wayland,
+  covers_url ? "https://pics.projectignis.org:2096/pics/cover/{}.jpg",
+  fields_url ? "https://pics.projectignis.org:2096/pics/field/{}.png",
+  # While ygoprodeck has higher quality images, "spamming" of their api results in a ban.
+  # Thats why this link can change since it's compiled into the program, However it will
+  # download assets when needed so it is unlikely to get banned. Unless you search the
+  # card list with no filters of any kind. When testing use ProjectIgnis' website instead.
+  pics_url ? "https://images.ygoprodeck.com/images/cards/{}.jpg",
+}:
+let
+  archLabel =
+    {
+      "x86_64-linux" = "x64";
+      "aarch64-linux" = "arm64";
+    }
+    .${stdenv.hostPlatform.system}
+      or (throw "Don't know how to translate ${stdenv.hostPlatform.system} into an arch label for edopro");
+
+  deps = import ./deps.nix;
+in
+let
+  assets = {
+    pname = "assets";
+    version = deps.edopro-version;
+
+    src = fetchzip {
+      url = "https://github.com/ProjectIgnis/edopro-assets/releases/download/${deps.edopro-version}/ProjectIgnis-EDOPro-${deps.edopro-version}-linux.tar.gz";
+      sha256 = deps.assets-hash;
+    };
+  };
+
+  irrlicht-edopro = stdenv.mkDerivation {
+    pname = "irrlicht-edopro";
+    version = "1.9-custom";
+
+    src = fetchFromGitHub {
+      owner = "edo9300";
+      repo = "irrlicht1-8-4";
+      rev = deps.irrlicht-rev;
+      hash = deps.irrlicht-hash;
+    };
+
+    buildInputs = [
+      libGLU
+      libX11
+      libxkbcommon
+      libXxf86vm
+      wayland
+    ];
+
+    enableParallelBuilding = true;
+    buildFlags = [
+      "NDEBUG=1"
+    ];
+    makeFlags = [
+      "-C"
+      "source/Irrlicht"
+    ];
+
+    installPhase = ''
+      runHook preInstall
+
+      mkdir -p $out/{bin,include}
+      cp lib/Linux/libIrrlicht.a $out/bin
+      cp -r include/* $out/include
+
+      runHook postInstall
+    '';
+  };
+
+  ocgcore = stdenv.mkDerivation rec {
+    pname = "ygopro-core";
+    version = deps.ocgcore-rev;
+
+    src = fetchFromGitHub {
+      owner = "edo9300";
+      repo = "ygopro-core";
+      rev = version;
+      hash = deps.ocgcore-hash;
+      fetchSubmodules = true;
+    };
+
+    patches = [
+      ./ocgcore-lua-symbols.patch
+    ];
+
+    nativeBuildInputs = [ premake5 ];
+
+    buildInputs = [ lua5_3 ];
+
+    preBuild = ''
+      premake5 gmake2 \
+        --lua-path="${lua5_3}"
+    '';
+
+    enableParallelBuilding = true;
+    buildFlags = [
+      "verbose=true"
+      "config=release"
+      "ocgcoreshared"
+    ];
+    makeFlags = [
+      "-C"
+      "build"
+    ];
+
+    installPhase = ''
+      runHook preInstall
+
+      install -Dm644 -t $out/lib bin/release/libocgcore${stdenv.hostPlatform.extensions.sharedLibrary}
+
+      runHook postInstall
+    '';
+  };
+
+  edopro = stdenv.mkDerivation {
+    pname = "edopro";
+    version = deps.edopro-version;
+
+    src = fetchFromGitHub {
+      owner = "edo9300";
+      repo = "edopro";
+      rev = deps.edopro-rev;
+      hash = deps.edopro-hash;
+      fetchSubmodules = true;
+    };
+
+    nativeBuildInputs = [ premake5 ];
+
+    buildInputs = [
+      bzip2
+      curl
+      flac
+      fmt_9
+      freetype
+      irrlicht-edopro
+      libevent
+      libgit2
+      libjpeg
+      libpng
+      libvorbis
+      lua5_3
+      nlohmann_json
+      ocgcore
+      openal
+      SDL2
+      sqlite
+    ];
+
+    # nixpkgs' gcc stack currently appears to not support LTO
+    postPatch = ''
+      substituteInPlace premake5.lua \
+        --replace-fail 'flags "LinkTimeOptimization"' 'removeflags "LinkTimeOptimization"'
+    '';
+
+    preBuild = ''
+      premake5 gmake2 \
+        --architecture=${archLabel} \
+        --covers=\"${covers_url}\" \
+        --fields=\"${fields_url}\" \
+        --pics=\"${pics_url}\" \
+        --prebuilt-core="${lib.getLib ocgcore}/lib" \
+        --sound=sfml
+    '';
+
+    enableParallelBuilding = true;
+    env = {
+      # remove after release 40.1.4+
+      # https://discord.com/channels/170601678658076672/792223685112889344/1286043823293599785
+      CXXFLAGS = "-include cstdint";
+      LDFLAGS = "-I ${irrlicht-edopro}/include -L ${irrlicht-edopro}/bin";
+    };
+    buildFlags = [
+      "verbose=true"
+      "config=release_${archLabel}"
+      "ygopro"
+    ];
+    makeFlags = [
+      "-C"
+      "build"
+    ];
+
+    installPhase = ''
+      runHook preInstall
+
+      mkdir -p $out/bin
+      cp bin/${archLabel}/release/ygopro $out/bin
+
+      runHook postInstall
+    '';
+  };
+
+  edopro-script =
+    let
+      assetsToCopy = lib.concatStringsSep "," [
+        # Needed if we download files from ProjectIgnis' website or any https only website.
+        "cacert.pem"
+        "config"
+        "deck"
+        "COPYING.txt"
+        "expansions"
+        "lflists"
+        "notices"
+        "puzzles"
+        "fonts"
+        "script"
+        "skin"
+        "sound"
+        "textures"
+        "WindBot"
+      ];
+    in
+    writeShellScriptBin "edopro" ''
+      set -eu
+      EDOPRO_DIR="''${XDG_DATA_HOME:-$HOME/.local/share}/edopro"
+
+      if [ ! -d $EDOPRO_DIR ]; then
+          mkdir -p $EDOPRO_DIR
+          cp -r --no-preserve=all ${assets.src}/{${assetsToCopy}} $EDOPRO_DIR
+          chmod -R go-rwx $EDOPRO_DIR
+
+          rm $EDOPRO_DIR/config/io.github.edo9300.EDOPro.desktop.in
+      fi
+
+      export PATH=PATH:'${lib.makeBinPath [ mono ]}';
+      export LD_LIBRARY_PATH='${
+        lib.makeLibraryPath [
+          libGL
+          libX11
+          libxkbcommon
+          libXxf86vm
+          sqlite
+          wayland
+          egl-wayland
+        ]
+      }';
+
+      exec ${edopro}/bin/ygopro -C $EDOPRO_DIR $@
+    '';
+
+  edopro-desktop = runCommandLocal "io.github.edo9300.EDOPro.desktop" { } ''
+    cp ${assets.src}/config/io.github.edo9300.EDOPro.desktop.in desktop-template
+
+    sed '/Path=/d' -i desktop-template
+    sed 's/Exec=.*/Exec=EDOPro/' -i desktop-template
+    sed 's/Icon=.*/Icon=EDOPro/' -i desktop-template
+
+    install -D desktop-template $out/share/applications/io.github.edo9300.EDOPro.desktop
+  '';
+in
+symlinkJoin {
+  name = "edopro-application-${deps.edopro-version}";
+  version = deps.edopro-version;
+  paths = [
+    edopro
+    edopro-script
+    edopro-desktop
+  ];
+
+  postBuild = ''
+    mkdir -p $out/share/icons/hicolor/256x256/apps/
+    ${imagemagick}/bin/magick \
+        ${assets.src}/textures/AppIcon.png \
+        -resize 256x256 \
+        $out/share/icons/hicolor/256x256/apps/EDOPro.png
+  '';
+
+  passthru.updateScript = ./update.py;
+
+  meta = {
+    description = "Bleeding-edge automatic duel simulator, a fork of the YGOPro client";
+    homepage = "https://projectignis.github.io";
+    changelog = "https://github.com/edo9300/edopro/releases";
+    license = lib.licenses.agpl3Plus;
+    maintainers = with lib.maintainers; [
+      OPNA2608
+      redhawk
+    ];
+    mainProgram = "edopro";
+    # This is likely a very easy app to port if you're interested.
+    # We just have no way to test on other platforms.
+    platforms = [
+      "x86_64-linux"
+      "aarch64-linux"
+    ];
+  };
+}