Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dockerfile for toolchain, minor internal changes #2314

Open
wants to merge 2 commits into
base: Dev
Choose a base branch
from

Conversation

mracsys
Copy link

@mracsys mracsys commented Oct 5, 2024

A dockerfile and compose script are added to the ASM folder to make setting up the randomizer toolchain easier. Readme files are updated to describe the process from both the command line and from VSCode's Dev Container extension. Both pipelines have been tested on Linux and Windows. It would be helpful to test on a Mac (especially on ARM) if someone has one.

I made some internal changes that should be transparent to users/devs that make it easier to reuse files in the container:

  • ZOOTDEC.z64 is no longer generated in the root of the repository. The randomizer caches the uncompressed ROM in ASM/roms/base.z64, which also conveniently removes the need to copy it there to compile the C/ASM patch. This required changing hardcoded references to ZOOTDEC.z64 in some of the helper scripts and notes.
  • The compressor is run with a working directory of ASM/roms/. dmaTable.dat is moved to this folder to facilitate this. This change creates the ARCHIVE.bin cache in this folder instead of the repository root. See the comment in Main.py#L244 for details why.
  • GUI Browse buttons will attempt to use a relative path for the file/directory inputs, which are then saved as relative paths to settings.sav. This allows running the randomizer from either the host or the container without worrying about where the repository is saved. This is only relevant for the Dev Container extension as the unmodified docker container will only compile the C/ASM and exit. I think this doesn't affect the web version as the functions were marked electron-only, but I don't know how safe that assumption is.

Some of these changes may affect the web branch. ROM patching should be tested there before merging.

@flagrama
Copy link

flagrama commented Oct 6, 2024

  • ZOOTDEC.z64 is no longer generated in the root of the repository. The randomizer caches the uncompressed ROM in ASM/roms/base.z64, which also conveniently removes the need to copy it there to compile the C/ASM patch. This required changing hardcoded references to ZOOTDEC.z64 in some of the helper scripts and notes.

Is this going to break running the generator without a base ROM selected, or do the other changes mean that is effectively unchanged, the location just happens to be different?

@fenhl fenhl added Status: Needs Review Someone should be looking at it Status: Needs Testing Probably should be tested Component: Misc A catch-all label Type: Maintenance Code style, infrastructure, updating dependencies labels Oct 6, 2024
@mracsys
Copy link
Author

mracsys commented Oct 7, 2024

No, it only changed the location/filename. I just doublechecked and it worked fine without the vanilla compressed ROM once the uncompressed one was generated.

@mracsys
Copy link
Author

mracsys commented Nov 10, 2024

I got a chance to test this on a mac. Unfortunately there are no pre-built aarch64 debian packages for the n64 toolchain. Building from source works, just very slowly (~30 minutes on an M4). Once the image is built everything is quick.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Misc A catch-all label Status: Needs Review Someone should be looking at it Status: Needs Testing Probably should be tested Type: Maintenance Code style, infrastructure, updating dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants