nixpkgs/pkgs/applications/emulators/mame/default.nix
2023-02-25 08:28:39 +00:00

206 lines
5.5 KiB
Nix

{ lib
, stdenv
, fetchFromGitHub
, alsa-lib
, SDL2
, SDL2_ttf
, copyDesktopItems
, expat
, flac
, fontconfig
, glm
, installShellFiles
, libXi
, libXinerama
, libjpeg
, libpcap
, libpulseaudio
, lua5_3
, makeDesktopItem
, makeWrapper
, papirus-icon-theme
, pkg-config
, portaudio
, portmidi
, pugixml
, python3
, qtbase
, rapidjson
, sqlite
, utf8proc
, which
, writeScript
, zlib
, darwin
}:
let
inherit (darwin.apple_sdk.frameworks) CoreAudioKit ForceFeedback;
in
stdenv.mkDerivation rec {
pname = "mame";
version = "0.252";
srcVersion = builtins.replaceStrings [ "." ] [ "" ] version;
src = fetchFromGitHub {
owner = "mamedev";
repo = "mame";
rev = "mame${srcVersion}";
hash = "sha256-snef00pTbukiLQp8eAMfuIqNV3l0wP1+KlpFnS3iKFg=";
};
outputs = [ "out" "tools" ];
makeFlags = [
"CC=${stdenv.cc.targetPrefix}cc"
"CXX=${stdenv.cc.targetPrefix}c++"
"TOOLS=1"
"USE_LIBSDL=1"
# "USE_SYSTEM_LIB_ASIO=1"
"USE_SYSTEM_LIB_EXPAT=1"
"USE_SYSTEM_LIB_FLAC=1"
"USE_SYSTEM_LIB_GLM=1"
"USE_SYSTEM_LIB_JPEG=1"
"USE_SYSTEM_LIB_LUA=1"
"USE_SYSTEM_LIB_PORTAUDIO=1"
"USE_SYSTEM_LIB_PORTMIDI=1"
"USE_SYSTEM_LIB_PUGIXML=1"
"USE_SYSTEM_LIB_RAPIDJSON=1"
"USE_SYSTEM_LIB_UTF8PROC=1"
"USE_SYSTEM_LIB_SQLITE3=1"
"USE_SYSTEM_LIB_ZLIB=1"
];
dontWrapQtApps = true;
# https://docs.mamedev.org/initialsetup/compilingmame.html
buildInputs = [
expat
zlib
flac
lua5_3
portmidi
portaudio
utf8proc
libjpeg
rapidjson
pugixml
glm
SDL2
SDL2_ttf
sqlite
qtbase
]
++ lib.optionals stdenv.isLinux [ alsa-lib libpulseaudio libXinerama libXi fontconfig ]
++ lib.optionals stdenv.isDarwin [ libpcap CoreAudioKit ForceFeedback ];
nativeBuildInputs = [
copyDesktopItems
installShellFiles
makeWrapper
pkg-config
python3
which
];
patches = [
# by default MAME assumes that paths with stock resources are relative and
# that you run MAME changing to install directory, so we add absolute paths
# here
./001-use-absolute-paths.diff
];
# Since the bug described in https://github.com/NixOS/nixpkgs/issues/135438,
# it is not possible to use substituteAll
postPatch = ''
substituteInPlace src/emu/emuopts.cpp \
--subst-var-by mamePath "$out/opt/mame"
'';
env.NIX_CFLAGS_COMPILE = toString [
"-Wno-error=use-after-free"
];
desktopItems = [
(makeDesktopItem {
name = "MAME";
desktopName = "MAME";
exec = "mame";
icon = "mame";
type = "Application";
genericName = "MAME is a multi-purpose emulation framework";
comment = "Play vintage games using the MAME emulator";
categories = [ "Game" "Emulator" ];
keywords = [ "Game" "Emulator" "Arcade" ];
})
];
# TODO: copy shaders from src/osd/modules/opengl/shader/glsl*.*h
# to the final package after we figure out how they work
installPhase = let
icon = "${papirus-icon-theme}/share/icons/Papirus/32x32/apps/mame.svg";
in ''
runHook preInstall
# mame
mkdir -p $out/opt/mame
install -Dm755 mame -t $out/bin
install -Dm644 ${icon} $out/share/icons/hicolor/scalable/apps/mame.svg
installManPage docs/man/*.1 docs/man/*.6
cp -ar {artwork,bgfx,plugins,language,ctrlr,keymaps,hash} $out/opt/mame
# mame-tools
for _tool in castool chdman floptool imgtool jedutil ldresample ldverify \
nltool nlwav pngcmp regrep romcmp split srcclean testkeys \
unidasm; do
install -Dm755 $_tool -t $tools/bin
done
mv $tools/bin/{,mame-}split
runHook postInstall
'';
# man1 is the tools documentation, man6 is the emulator documentation
# Need to be done in postFixup otherwise multi-output hook will move it back to $out
postFixup = ''
moveToOutput share/man/man1 $tools
'';
enableParallelBuilding = true;
passthru.updateScript = writeScript "mame-update-script" ''
#!/usr/bin/env nix-shell
#!nix-shell -i bash -p curl common-updater-scripts jq
set -eu -o pipefail
latest_version=$(curl -s https://api.github.com/repos/mamedev/mame/releases/latest | jq --raw-output .tag_name)
update-source-version mame "''${latest_version/mame0/0.}"
'';
meta = with lib; {
homepage = "https://www.mamedev.org/";
description = "A multi-purpose emulation framework";
longDescription = ''
MAME's purpose is to preserve decades of software history. As electronic
technology continues to rush forward, MAME prevents this important
"vintage" software from being lost and forgotten. This is achieved by
documenting the hardware and how it functions. The source code to MAME
serves as this documentation. The fact that the software is usable serves
primarily to validate the accuracy of the documentation (how else can you
prove that you have recreated the hardware faithfully?). Over time, MAME
(originally stood for Multiple Arcade Machine Emulator) absorbed the
sister-project MESS (Multi Emulator Super System), so MAME now documents a
wide variety of (mostly vintage) computers, video game consoles and
calculators, in addition to the arcade video games that were its initial
focus.
'';
changelog = "https://github.com/mamedev/mame/releases/download/mame${srcVersion}/whatsnew_${srcVersion}.txt";
license = with licenses; [ bsd3 gpl2Plus ];
maintainers = with maintainers; [ thiagokokada ];
platforms = platforms.unix;
broken = stdenv.isDarwin;
};
}