nixpkgs/pkgs/games/openmw/default.nix

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

121 lines
3.0 KiB
Nix
Raw Normal View History

2021-05-19 01:30:30 +00:00
{ lib
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
, stdenv
2021-05-19 01:30:30 +00:00
, mkDerivation
, fetchFromGitHub
2022-04-20 03:45:37 +00:00
, fetchpatch
2021-05-19 01:30:30 +00:00
, cmake
, pkg-config
, wrapQtAppsHook
2021-05-19 01:30:30 +00:00
, openscenegraph
, mygui
, bullet
, ffmpeg
, boost
, SDL2
, unshield
, openal
, libXt
2021-11-09 19:56:25 +00:00
, lz4
, recastnavigation
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
, VideoDecodeAcceleration
2021-05-19 01:30:30 +00:00
}:
2015-09-26 18:00:36 +00:00
let
2021-11-09 19:56:25 +00:00
openscenegraph_openmw = (openscenegraph.override { colladaSupport = true; })
.overrideDerivation (self: {
src = fetchFromGitHub {
owner = "OpenMW";
repo = "osg";
rev = "bbe61c3bc510a4f5bb4aea21cce506519c2d24e6";
sha256 = "sha256-t3smLqstp7wWfi9HXJoBCek+3acqt/ySBYF8RJOG6Mo=";
};
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
patches = [
(fetchpatch {
# For Darwin, OSG doesn't build some plugins as they're redundant with QuickTime.
# OpenMW doesn't like this, and expects them to be there. Apply their patch for it.
name = "darwin-osg-plugins-fix.patch";
url = "https://gitlab.com/OpenMW/openmw-dep/-/raw/0abe3c9c3858211028d881d7706813d606335f72/macos/osg.patch";
sha256 = "sha256-/CLRZofZHot8juH78VG1/qhTHPhy5DoPMN+oH8hC58U=";
})
];
2021-11-09 19:56:25 +00:00
});
bullet_openmw = bullet.overrideDerivation (old: rec {
version = "3.17";
src = fetchFromGitHub {
2021-11-09 19:56:25 +00:00
owner = "bulletphysics";
repo = "bullet3";
rev = version;
sha256 = "sha256-uQ4X8F8nmagbcFh0KexrmnhHIXFSB3A1CCnjPVeHL3Q=";
};
2021-11-09 19:56:25 +00:00
patches = [];
cmakeFlags = (old.cmakeFlags or []) ++ [
"-DUSE_DOUBLE_PRECISION=ON"
"-DBULLET2_MULTITHREADING=ON"
];
});
2021-05-19 01:30:30 +00:00
in
mkDerivation rec {
pname = "openmw";
2021-11-09 19:56:25 +00:00
version = "0.47.0";
2015-09-26 18:00:36 +00:00
src = fetchFromGitHub {
owner = "OpenMW";
repo = "openmw";
rev = "${pname}-${version}";
2021-11-09 19:56:25 +00:00
sha256 = "sha256-Xq9hDUTCQr79Zzjk0CsiXclVTHK6nrSowukIQqVdrKY=";
2015-09-26 18:00:36 +00:00
};
2022-04-20 03:45:37 +00:00
patches = [
(fetchpatch {
url = "https://gitlab.com/OpenMW/openmw/-/merge_requests/1239.diff";
sha256 = "sha256-RhbIGeE6GyqnipisiMTwWjcFnIiR055hUPL8IkjPgZw=";
})
];
postPatch = ''
sed '1i#include <memory>' -i components/myguiplatform/myguidatamanager.cpp # gcc12
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
'' + lib.optionalString stdenv.isDarwin ''
# Don't fix Darwin app bundle
sed -i '/fixup_bundle/d' CMakeLists.txt
'';
nativeBuildInputs = [ cmake pkg-config wrapQtAppsHook ];
2021-05-19 01:30:30 +00:00
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
# If not set, OSG plugin .so files become shell scripts on Darwin.
dontWrapQtApps = true;
2021-05-19 01:30:30 +00:00
buildInputs = [
SDL2
boost
2021-11-09 19:56:25 +00:00
bullet_openmw
2021-05-19 01:30:30 +00:00
ffmpeg
libXt
mygui
openal
2021-11-09 19:56:25 +00:00
openscenegraph_openmw
2021-05-19 01:30:30 +00:00
unshield
2021-11-09 19:56:25 +00:00
lz4
recastnavigation
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
] ++ lib.optionals stdenv.isDarwin [
VideoDecodeAcceleration
2021-05-19 01:30:30 +00:00
];
2019-03-14 14:53:34 +00:00
2019-03-13 07:33:02 +00:00
cmakeFlags = [
2021-05-19 01:30:30 +00:00
# as of 0.46, openmw is broken with GLVND
"-DOpenGL_GL_PREFERENCE=LEGACY"
2021-11-09 19:56:25 +00:00
"-DOPENMW_USE_SYSTEM_RECASTNAVIGATION=1"
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
] ++ lib.optionals stdenv.isDarwin [
"-DOPENMW_OSX_DEPLOYMENT=ON"
2019-03-13 07:33:02 +00:00
];
2015-09-26 18:00:36 +00:00
meta = with lib; {
2015-09-26 18:00:36 +00:00
description = "An unofficial open source engine reimplementation of the game Morrowind";
2021-11-09 19:56:25 +00:00
homepage = "https://openmw.org";
license = licenses.gpl3Plus;
2021-11-09 19:56:25 +00:00
maintainers = with maintainers; [ abbradar marius851000 ];
openmw: add darwin support The OpenMW codebase already has Darwin build support within it, so porting it over to nixpkgs was something I wanted to try out. Issues encountered, in order: A few dependencies in nixpkgs were missing Darwin support. Details of those changes are in their respective commits. After the dependencies were building, the build first failed with a missing reference to VideoDecodeAcceleration, which was easily dealt with. Then the build succeeded! Job's done, success! Except OpenMW.app was nowhere to be found in the result folder. OpenMW-CS.app, however, was produced and appeared to be running correctly (though I will admit I didn't test it very much as I'm not very familiar). Going through OpenMW's CMakeLists.txt showed that a CMake define was needed, `OPENMW_OSX_DEPLOYMENT=ON`. This is what enables OpenMW.app to be built. Once the define was added, the build began to fail with missing plugins to OpenSceneGraph. Looking into that showed that OSG doesn't build certain plugins on Darwin due to the fact that their functionality is replicated by built- in system libraries. To save space, these libraries are not built on Darwin. OpenMW, however, requires these libraries to exist. I was familiar with the process of building OpenMW on Darwin already, due to having built it locally ahead of time, so I remembered that the OpenMW folks have a separate repository with Mac-specific patches. One of those patches is to OpenSceneGraph for this exact issue, which is now applied here. The next error was caused by `fixup_bundle` running from the OpenMW CMakeLists.txt, which appears to be broken in Darwin under Nix. Searching nixpkgs shows that others have worked around the issue by removing the call to `fixup_bundle` completely. At this point, the build passed and OpenMW.app was created and was executable! After the intro video played, it was clear that something wasn't working though. Every texture was completely pink, navigating the main menu was impossible. Looking at the console output showed that OpenSceneGraph was attempting to load dds textures, but the plugin for doing so could not be loaded. I looked at the plugin with `file` which showed the file was actually a bash script. It was setting some QT environment variables before calling the real plugin executable. I resolved this issue with setting `dontWrapQtApps`, as everything seems to work without it (even the QT-based apps like the Construction Set).
2023-03-11 00:32:06 +00:00
platforms = platforms.linux ++ platforms.darwin;
2015-09-26 18:00:36 +00:00
};
}