Skip to content

Reorganize the ASM/src directory#2354

Open
mzxrules wants to merge 2 commits intoOoTRandomizer:Devfrom
mzxrules:asm_cleanup_1
Open

Reorganize the ASM/src directory#2354
mzxrules wants to merge 2 commits intoOoTRandomizer:Devfrom
mzxrules:asm_cleanup_1

Conversation

@mzxrules
Copy link
Copy Markdown

The goal for this PR is to sort .asm files into two folders (base and payload) with the hopes that it will someday make it easier to convert baserom modifications into C using Decomp. This PR avoids creating differences in rom_patch.txt and asm_symbols.txt so that in-game testing is not required. However, note that this PR includes the fix from #2352.

Once merged, the next step is to do a more thorough clean up code in the base game files, and break up hacks.asm.

For the base folder, the idea is to roughly match the directory layout of decomp:

  • Modifications that edit the "code" segment should be split into separate files named after the source file within the code segment that they modify, due to the large number of source files within the segment.

  • Otherwise, new base game .asm files should be named after the segment they modify.

For the payload folder, I'm not really sure how best to organize it. I mainly stuck a handful of seemingly important files into the root of payload, stuck drop_overrides in it, and put everything else into the mods folder.

@flagrama
Copy link
Copy Markdown

I recommend adding the desired way to use these folders to ASM/README.md.

@fenhl fenhl added Type: Bug Something isn't working Component: ASM/C Changes some internals of the ASM/C libraries Status: Needs Review Someone should be looking at it Status: Needs Testing Probably should be tested Component: Patching Affects the patching of the ROM Type: Maintenance Code style, infrastructure, updating dependencies labels Jan 18, 2025
@mzxrules
Copy link
Copy Markdown
Author

I feel like that sort of information doesn't belong in README.md. There's talk of creating a CONTRIBUTING.md but I don't feel comfortable starting one.

@fenhl
Copy link
Copy Markdown
Collaborator

fenhl commented Apr 8, 2025

CONTRIBUTING.md exists now, feel free to add a section about this there.

; Item restriction table
;==================================================================================================

; TODO: correct headersize
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this still needs to be fixed? Or does this not actually break anything?

@fenhl fenhl added the Status: Waiting for Author Changes or response requested label May 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: ASM/C Changes some internals of the ASM/C libraries Component: Patching Affects the patching of the ROM Status: Needs Review Someone should be looking at it Status: Needs Testing Probably should be tested Status: Waiting for Author Changes or response requested Type: Bug Something isn't working Type: Maintenance Code style, infrastructure, updating dependencies

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants