zelda64recomp: init at 1.1.1-unstable-2024-10-06

[qubitnano]

Description of changes

Closes #310947

https://github.com/Zelda64Recomp/Zelda64Recomp

Zelda 64: Recompiled is a project that uses N64: Recompiled to statically recompile Majora's Mask (and soon Ocarina of Time) into a native port with many new features and enhancements. This project uses RT64 as the rendering engine to provide some of these enhancements.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[qubitnano]

Result of nixpkgs-review run on x86_64-linux 1

13 packages built:

• mm-decomp
• n64recomp
• python311Packages.libyaz0
• python311Packages.libyaz0.dist
• python311Packages.mapfile-parser
• python311Packages.mapfile-parser.dist
• python311Packages.rabbitizer
• python311Packages.rabbitizer.dist
• python312Packages.libyaz0
• python312Packages.libyaz0.dist
• python312Packages.rabbitizer
• python312Packages.rabbitizer.dist
• zelda64recomp

[keenanweaver]

Result of nixpkgs-review pr 313013 run on x86_64-linux 1

1 package failed to build:

• zelda64recomp

12 packages built:

• mm-decomp
• n64recomp
• python311Packages.libyaz0
• python311Packages.libyaz0.dist
• python311Packages.mapfile-parser
• python311Packages.mapfile-parser.dist
• python311Packages.rabbitizer
• python311Packages.rabbitizer.dist
• python312Packages.libyaz0
• python312Packages.libyaz0.dist
• python312Packages.rabbitizer
• python312Packages.rabbitizer.dist

[keenanweaver]

Great work! Do we have concern for supporting only one hash for the ROM? There are a couple of different No-Intro ROMs (BigEndian, ByteSwapped), additional regions of the ROM may eventually be supported, some people may have some ancient non-No-intro ROMs, etc. Should we just say to acquire the latest No-Intro ROM (BigEndian) for Majora's Mask? Also, is the ROM required for build, or is it simply for convenience?

Build error for me as well:

$ git -c fetch.prune=false fetch --no-tags --force https://github.com/NixOS/nixpkgs master:refs/nixpkgs-review/0 pull/313013/head:refs/nixpkgs-review/1
$ git worktree add /home/keenan/.cache/nixpkgs-review/pr-313013-6/nixpkgs f72f67152a44df2d2c09a578bac8e09b9390279b
Preparing worktree (detached HEAD f72f67152a44)
Updating files: 100% (41126/41126), done.
HEAD is now at f72f67152a44 texlive: set allowSubstitutes, preferLocalBuild values (#312049)
$ git merge --no-commit --no-ff 839a1a7929bce5dbc132fda00e1ad0c683d3d8e1
Auto-merging maintainers/maintainer-list.nix
Auto-merging pkgs/top-level/python-packages.nix
Automatic merge went well; stopped before committing as requested
$ nix build --file /nix/store/n0ahhfycjdkwvzzr2sq8h8z71n2w5yzk-nixpkgs-review-2.10.4/lib/python3.11/site-packages/nixpkgs_review/nix/review-shell.nix --nix-path nixpkgs=/home/keenan/.cache/nixpkgs-review/pr-313013-6/nixpkgs nixpkgs-overlays=/tmp/tmps3ilbfzv --extra-experimental-features nix-command no-url-literals --no-link --keep-going --no-allow-import-from-derivation --option build-use-sandbox relaxed --argstr system x86_64-linux --argstr nixpkgs-path /home/keenan/.cache/nixpkgs-review/pr-313013-6/nixpkgs --argstr nixpkgs-config-path /tmp/tmpc2f4etd_.nix --argstr attrs-path /home/keenan/.cache/nixpkgs-review/pr-313013-6/attrs.nix
error: builder for '/nix/store/qyndlf7d45d2qwnv4p3004z4wgp6qdr8-source.drv' failed with exit code 1;
       last 14 log lines:
       > exporting https://github.com/Mr-Wiseguy/Zelda64Recomp.git (rev 1.0.1) into /nix/store/7jgca6wc2ybhzmq839xhf586bx0k93jg-source
       > Initialized empty Git repository in /nix/store/7jgca6wc2ybhzmq839xhf586bx0k93jg-source/.git/
       > fatal: couldn't find remote ref refs/tags/1.0.1
       > remote: Enumerating objects: 275, done.
       > remote: Counting objects: 100% (275/275), done.
       > remote: Compressing objects: 100% (245/245), done.
       > remote: Total 275 (delta 11), reused 159 (delta 6), pack-reused 0
       > Receiving objects: 100% (275/275), 7.36 MiB | 15.37 MiB/s, done.
       > Resolving deltas: 100% (11/11), done.
       > From https://github.com/Mr-Wiseguy/Zelda64Recomp
       >  * branch            HEAD       -> FETCH_HEAD
       > fatal: Not a valid object name
       > Unrecognized git object type:
       > Unable to checkout refs/tags/1.0.1 from https://github.com/Mr-Wiseguy/Zelda64Recomp.git.
       For full logs, run 'nix log /nix/store/qyndlf7d45d2qwnv4p3004z4wgp6qdr8-source.drv'.
error: 1 dependencies of derivation '/nix/store/01p3zk5aal5dqpqn9jn4z2v841vq17jd-zelda64recomp-1.0.1.drv' failed to build
error: 1 dependencies of derivation '/nix/store/r5v1fxjdnr7ahkvb71vynjhdbpzkic4i-review-shell.drv' failed to build

Link to currently reviewing PR:
https://github.com/NixOS/nixpkgs/pull/313013

1 package failed to build:
zelda64recomp

12 packages built:
mm-decomp n64recomp python311Packages.libyaz0 python311Packages.libyaz0.dist python311Packages.mapfile-parser python311Packages.mapfile-parser.dist python311Packages.rabbitizer python311Packages.rabbitizer.dist python312Packages.libyaz0 python312Packages.libyaz0.dist python312Packages.rabbitizer python312Packages.rabbitizer.dist

error: build log of '/nix/store/01p3zk5aal5dqpqn9jn4z2v841vq17jd-zelda64recomp-1.0.1.drv^*' is not available
error: build log of '/nix/store/ggyi1hsa2cqvhaxhmbm9ym67v9i7azyy-zelda64recomp-1.0.1' is not available
Posting result comment on https://github.com/NixOS/nixpkgs/pull/313013
$ /nix/store/62nhzqm27dadv0czp5gqnnc38xfbi8k4-nix-2.18.2/bin/nix-shell --argstr system x86_64-linux --argstr nixpkgs-path /home/keenan/.cache/nixpkgs-review/pr-313013-6/nixpkgs --argstr nixpkgs-config-path /tmp/tmpc2f4etd_.nix --argstr attrs-path /home/keenan/.cache/nixpkgs-review/pr-313013-6/attrs.nix --nix-path nixpkgs=/home/keenan/.cache/nixpkgs-review/pr-313013-6/nixpkgs nixpkgs-overlays=/tmp/tmps3ilbfzv /nix/store/n0ahhfycjdkwvzzr2sq8h8z71n2w5yzk-nixpkgs-review-2.10.4/lib/python3.11/site-packages/nixpkgs_review/nix/review-shell.nix

[qubitnano]

Whoops, I had everything cached before changing the commits to versions, it should build now.

The required rom is the only one mm-decomp currently supports. It's needed to generate the outputs required for zelda64recomp.

[boomshroom]

Managed to successfully build on the first try. Attempting to run (with SDL_VIDEODRIVER set to x11) gave a weird segfault that somehow happened within amdvlk64.so. I was able to get the port running in a manual build, so it shouldn't be a fundamental incompatibility or something specific to my machine.

[qubitnano]

Can you describe your setup? or post a coredump? I'm trying to reproduce

I'm on KDE wayland, 5700 XT, sddm wayland-only

SDL_VIDEODRIVER unset runs
SDL_VIDEODRIVER=x11 runs
SDL_VIDEODRIVER=wayland segfaults. I added a patch from upstream to force x11 and to wrap the binary to run.

[boomshroom]

I'm explicitly setting SDL_VIDEODRIVER=x11. Desktop is sway 1.9. Graphics card is [AMD/ATI] Navi 10 [Radeon RX 5600 OEM/5600 XT / 5700/5700 XT] (rev c1) and CPU is AMD Ryzen 7 7800X3D. Kernel is 6.9-rc6 from nixpkgs rev e4e7a43a9db7e22613accfeb1005cca1b2b1ee0d. Thread 1 is the only one that looks suspicious:

#0  0x00007fb1181e3a28 in ?? () from /nix/store/mj46nr01aw75bqsc0sb9cymqz4ila6qw-amdvlk-2023.Q4.2/lib/amdvlk64.so
#1  0x00007fb117dfe068 in ?? () from /nix/store/mj46nr01aw75bqsc0sb9cymqz4ila6qw-amdvlk-2023.Q4.2/lib/amdvlk64.so
#2  0x00007fb117e60e4b in ?? () from /nix/store/mj46nr01aw75bqsc0sb9cymqz4ila6qw-amdvlk-2023.Q4.2/lib/amdvlk64.so
#3  0x00007fb117e689ea in ?? () from /nix/store/mj46nr01aw75bqsc0sb9cymqz4ila6qw-amdvlk-2023.Q4.2/lib/amdvlk64.so
#4  0x00007fb117e3ef65 in ?? () from /nix/store/mj46nr01aw75bqsc0sb9cymqz4ila6qw-amdvlk-2023.Q4.2/lib/amdvlk64.so
#5  0x000055e1aee758d2 in RT64::VulkanGraphicsPipeline::VulkanGraphicsPipeline(RT64::VulkanDevice*, RT64::RenderGraphicsPipelineDesc const&) ()
#6  0x000055e1aee8124c in RT64::VulkanDevice::createGraphicsPipeline(RT64::RenderGraphicsPipelineDesc const&) ()
#7  0x000055e1aee27959 in RT64::ShaderLibrary::setupMultisamplingShaders(RT64::RenderInterface*, RT64::RenderDevice*, RT64::RenderMultisampling const&) ()
#8  0x000055e1aedd2f06 in RT64::Application::setup(unsigned int) ()
#9  0x000055e1ade2e3a6 in ultramodern::RT64Context::RT64Context(unsigned char*, ultramodern::WindowHandle, bool) ()
#10 0x000055e1ade2383b in gfx_thread_func(unsigned char*, moodycamel::LightweightSemaphore*, ultramodern::WindowHandle) ()
#11 0x000055e1af32b003 in execute_native_thread_routine ()
#12 0x00007fb16b1c0272 in start_thread () from /nix/store/apab5i73dqa09wx0q27b6fbhd1r18ihl-glibc-2.39-31/lib/libc.so.6
#13 0x00007fb16b23bdec in clone3 () from /nix/store/apab5i73dqa09wx0q27b6fbhd1r18ihl-glibc-2.39-31/lib/libc.so.6

[qubitnano]

Yes, I'm seeing it now when enabling amdvlk, it wasn't crashing on the radeon drivers.

[qubitnano]

I updated directx-shader-compiler and now it doesn't crash with amdvlk.

[qubitnano]

Sorry didn't mean to ping as I was building that locally, I'll squash and remove once it and amdvlk 2024.Q2.1 are merged.

[JohnRTitor]

Okay how do I download this file to test this?

[JohnRTitor]

Result of nixpkgs-review pr 313013 run on x86_64-linux 1

1 package failed to build:

• zelda64recomp

2 packages built:

• n64recomp
• z64decompress

┏━ 1 Errors: 
┃ error: builder for '/nix/store/dw4ad54gxk2v1c48cpymgjzdqyj3dbdc-mm.us.rev1.rom.z64.drv' failed with exit code 1;
┃        last 12 log lines:
┃        >
┃        > ***
┃        > zelda64recomp currently only supports the US version of Majora's Mask.
┃        >
┃        > Please rename your copy to mm.us.rev1.rom.z64 and add it to the nix store using
┃        >
┃        > nix-store --add-fixed sha256 mm.us.rev1.rom.z64
┃        >
┃        > and rebuild.
┃        >
┃        > ***
┃        >
┃        For full logs, run 'nix log /nix/store/dw4ad54gxk2v1c48cpymgjzdqyj3dbdc-mm.us.rev1.rom.z64.drv'.

as expected

[JohnRTitor]

This again.
#313013 (comment)

[keenanweaver]

This again. #313013 (comment)

You need a No-Intro dump of the game ROM. Obviously can't link it here.