aa0a968791
* Begin Kaleido * WIP * DW macros for gbi * More Progress * Match KaleidoScope_GrayOutTextureRGBA32 * DrawGameOver wip * Add some function names * A few more matching, some docs * More docs, data wip * Import Kaleido Data * Data cleanup * Some progress * Match TitleCard_Draw Again (Thanks Roman) * Match KaleidoScope_DrawDebugEditor * KaleidoScope_UpdateDebugEditor WIP * Some cleanup * z_kaleido_debug.c OK * Cleanup * match func_8081B6EC * more wip, data cleanup * match func_80825A50 * match KaleidoScope_InitVertices * cursor progress * name func * item headers * match KaleidoScope_DrawItemSelect * KaleidoScope_UpdateItemEquip WIP * match kaleido item * doc kaleido item * z_kaleido_prompt ok * kaleido mask setup * small cleanup * kaleido mask OK * mask cleanup * small fix * quest page setup * doc save prompt * sync with prompt docs * KaleidoScope_Update WIP * More progress on KaleidoScope_Update * kaleido update cleanup * KaleidoScope_Update OK * Slightly cleaner match in KaleidoScope_Update * match KaleidoScope_DrawPages and KaleidoScope_DrawGameOver, organize data * more cleanup * match KaleidoScope_Draw and KaleidoScope_SetView * match KaleidoScope_UpdateNamePanel * match another 2 funcs, segment docs * another KaleidoScope_UpdateNamePanel ? * swap update name panel names * another match, only 2 large/similar vtx function in kaleido nes * more setup for drawInfoPanel * match KaleidoScope_DrawDungeonStrayFairyCount, 8 funcs left * document KaleidoScope_DrawDungeonStrayFairyCount * KaleidoScope_DrawInfoPanel1 WIP * match KaleidoScope_DrawInfoPanel2 * gameover pause states * name two pause states * match KaleidoScope_UpdateDungeonCursor and KaleidoScope_UpdateWorldMapCursor * match KaleidoScope_DrawDungeonMap * KaleidoScope_DrawWorldMap WIP * cleanup map * some cursor/texture docs * more cursor docs * KaleidoScope_UpdateQuestCursor wip * match KaleidoScope_UpdateQuestCursor * quest cleanup * KaleidoScope_DrawQuestStatus WIP, broke gakufu * match KaleidoScope_DrawInfoPanel1, Kaleido NES OK * pause substates * more cleanup * map progress * very small improvements to KaleidoScope_DrawWorldMap * match KaleidoScope_DrawWorldMap * cleanup KaleidoScope_DrawWorldMap * rematch EnGakufu_ProcessNotes, thanks anon58 * gameover and misc docs * more docs * small cleanup of maps * owl warp and other docs * symmetry in pause state * some docs and cleanup * docs * more docs from OoT WIP * fix * quest page docs * more enums * more cleanup and enums * another round of docs * doc cursor indices * map docs * some docs * cleanup for-loops * cleanup * else if * small docs * icon_item_field_static * dungeon static * eol * icon item jpn static * vtx static * jpn static comments * import parameter texture functions * mask cleanup * sync with PRs * some docs * more docs * fix bss * some docs * sync with PR * quest docs * fix quest vtx * sync with PR * sync with PR * fix typo * small cleanup * vtx madness * more vtx * add quad docs * cleanup vtx * cleanup * cleanup * revert gbi changes * cleanup * more cleanup * another cleanup * remove empty comment * some PR review * more naming suggestions * namefixer * L button to Z button --------- Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> |
||
|---|---|---|
| assets | ||
| docs | ||
| include | ||
| src | ||
| tools | ||
| .clang-format | ||
| .clang-tidy | ||
| .gitattributes | ||
| .gitignore | ||
| checksum_uncompressed.md5 | ||
| checksum.md5 | ||
| diff_settings.py | ||
| diff.py | ||
| Dockerfile | ||
| extract_assets.py | ||
| first_diff.py | ||
| fixle.sh | ||
| format.py | ||
| Jenkinsfile | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
| spec | ||
| sym_info.py | ||
| undefined_syms.txt | ||
Legend of Zelda: Majora's Mask (US) 1.0
- WARNING! -
This repository is a work in progress, and while it can be used to make certain changes, it's
still constantly evolving. If you wish to use it for modding purposes in its current state,
please be aware that the codebase could drastically change at any time. Also note that some
parts of the ROM may not be 'shiftable' yet, so modifying them could currently be difficult.
This is a WIP decompilation of The Legend of Zelda: Majora's Mask. The purpose of the project is to recreate a source code base for the game from scratch, using information found inside the game along with static and/or dynamic analysis. It is not, and will not, produce a PC port. For frequently asked questions, you can visit our website, and for more information you can get in touch with the team on our Discord server.
The only version currently supported is N64 US, but we intend to eventually support every retail version of the original game (i.e. not versions of MM3D, which is a totally different game).
It currently builds the following ROM:
- mm.us.rev1.rom.z64
md5: 2a0a8acb61538235bc1094d297fb6556
This repo does not include any assets or assembly code necessary for compiling the ROM. A prior copy of the game is required to extract the required assets.
Please refer to the following for more information:
Installation
Windows
For Windows 10, install WSL and a distribution by following this Windows Subsystem for Linux Installation Guide. We recommend using Debian or Ubuntu 20.04 Linux distributions.
MacOS
Preparation is covered in a separate document.
Docker
Preparation is covered in Building Docker.
Linux (Native or under WSL / VM)
1. Install build dependencies
The build process has the following package requirements:
- make
- git
- build-essential
- binutils-mips-linux-gnu
- python3
- pip3
- libpng-dev
Under Debian / Ubuntu (which we recommend using), you can install them with the following commands:
sudo apt update
sudo apt install make git build-essential binutils-mips-linux-gnu python3 python3-pip libpng-dev
2. Clone the repository
Create your own fork of the repository at https://github.com/zeldaret/mm. Then clone your fork where you wish to have the project, with the command:
git clone https://github.com/<YOUR_USERNAME>/mm.git
This will copy the GitHub repository contents into a new folder in the current directory called mm. Change into this directory before doing anything else:
cd mm
3. Install python dependencies
The build process has a few python packages required that are located in requirements.txt.
To install them simply run in a terminal:
python3 -m pip install -r requirements.txt
4. Prepare a base ROM
Copy your ROM to inside the root of this new project directory, and rename the file of the baserom to reflect the version of ROM you are using. ex: baserom.mm.us.rev1.z64
5. Make and Build the ROM
To start the extraction/build process, run the following command:
make init
This will extract all the individual files in the ROM into a newly created baserom folder, as well as decompress the compressed files in a newly created decomp folder. This will create the build folders as well as a new folder with the ASM as well as containing the disassemblies of nearly all the files containing code.
This make target will also build the ROM. If all goes well, a new ROM called "mm.us.rev1.rom.z64" should be built and the following text should be printed:
mm.us.rev1.rom.z64: OK
If you instead see the following:
mm.us.rev1.rom.z64: FAILED
md5sum: WARNING: 1 computed checksum did NOT match
This means that something is wrong with the ROM's contents. Either the baserom files are incorrect due to a bad ROM, or some of the code is not matching.
Running make init will also make the ./expected directory and copy all of the files there, which will be useful when running the diff script. The diff script is useful in decompiling functions and can be run with this command: ./tools/asm-differ/diff.py -wmo3 <insert_function_here>
Note: to speed up the build, you can pass -jN to make setup and make, where N is the number of threads to use in the build, e.g. make -j4. The generally-accepted wisdom is to use the number of virtual cores your computer has, which is the output of nproc (which should be installed as part of coreutils).
The disadvantage that the ordering of the terminal output is scrambled, so for debugging it is best to stick to one thread (i.e. not pass -jN).
(-j also exists, which uses unlimited jobs, but is generally slower.)
Contributing
All contributions are welcome. This is a group effort, and even small contributions can make a difference. Some work also doesn't require much knowledge to get started.
Please note that is is our strict policy that Anyone who wishes to contribute to the OOT or MM projects must not have accessed leaked source code at any point in time for Nintendo 64 SDK, iQue player SDK, libultra, Ocarina of Time, Majora's Mask, Animal Crossing/Animal Forest, or any other game that shares the same game engine or significant portions of code to a Zelda 64 game or any other console similar to the Nintendo 64.
Most discussions happen on our Discord Server, where you are welcome to ask if you need help getting started, or if you have any questions regarding this project or ZeldaRET's other decompilation projects.
For more information on getting started, see our Contributing Guide, Style Guide and our Code Review Guidelines to see what code quality guidelines we follow.