mzm/README.md

39 lines
1.2 KiB
Markdown
Raw Normal View History

2022-07-19 15:30:59 +00:00
# Metroid - Zero Mission Decomp
2022-01-20 17:46:10 +00:00
2022-07-19 15:30:59 +00:00
This is a work in progress decompilation of Metroid - Zero Mission.
2023-03-06 15:13:12 +00:00
2254/2721 functions decompiled (82.84%, 467 left)
2022-07-24 19:38:46 +00:00
Progress can be seen here : https://docs.google.com/spreadsheets/d/1X8XarD5evY8ZI7r_GQqh1pYmdVMbBcINYfRBUlogmKY/edit#gid=0
2022-07-19 15:30:59 +00:00
2023-03-06 15:13:12 +00:00
**This decomp is not shiftable, don't use it as a base to work on anything**
2022-01-20 17:46:10 +00:00
This produces the following ROMs:
- mzm_us.gba: `sha1: 5de8536afe1f0078ee6fe1089f890e8c7aa0a6e8`
2022-09-08 17:53:36 +00:00
**Discords**:
- https://discord.gg/2MGB9Xbr9y MAGret
2022-09-16 15:11:32 +00:00
- https://discord.gg/WtekHKb MAGConst
2022-01-25 18:58:15 +00:00
2022-01-20 17:46:10 +00:00
## Dependencies
2023-02-03 17:52:02 +00:00
- [agbcc](https://github.com/jiangzhengwenjz/agbcc)
2022-01-20 17:46:10 +00:00
- `binutils-arm-none-eabi`
2022-05-13 07:01:23 +00:00
- `mzm_us_baserom.gba` (`sha1: 5de8536afe1f0078ee6fe1089f890e8c7aa0a6e8`)
2022-09-24 20:22:28 +00:00
- `python3`
2022-09-24 17:22:07 +00:00
- `g++`
2022-01-20 17:46:10 +00:00
2022-09-08 17:53:36 +00:00
## Setup
- **WINDOWS ONLY** : Install and setup [WSL](https://docs.microsoft.com/en-us/windows/wsl/install)
- Install the dependencies (an `apt update` might be necessary for binutils)
2022-09-09 05:36:19 +00:00
- Build agbcc (run `./build.sh`)
2023-01-01 21:28:54 +00:00
- Add agbcc to your path (export PATH="agbcc path:$PATH")
2022-09-24 17:22:07 +00:00
- Build preproc (run `make` in tools/preproc)
2022-01-20 17:46:10 +00:00
2022-09-08 17:53:36 +00:00
## Build
2022-01-20 17:46:10 +00:00
2022-09-08 17:53:36 +00:00
- Run `make clean` if necessary
2023-01-01 21:28:54 +00:00
- Run the `extractor.py` script in tools (`python3 tools/extractor.py`) if necessary
2022-11-27 12:52:50 +00:00
- Run `make` (using the -j option is recommended to speed up the process)