mkdd/README.md

45 lines
2.1 KiB
Markdown
Raw Normal View History

2022-06-06 01:06:18 +02:00
# mkdd
2023-12-19 21:29:54 +01:00
WIP 1:1 Decompilation of Mario Kart Double Dash!!
2023-03-02 17:52:15 +01:00
## Building
### Requirements
2023-12-19 21:29:54 +01:00
- [devkitPro](https://devkitpro.org/wiki/Getting_Started)
- [Ninja](https://github.com/ninja-build/ninja/releases/tag/v1.11.1)
- [Python 3.8+](https://www.python.org/downloads/release/python-3104/)
- [GC MW Compilers](https://files.decomp.dev/compilers_latest.zip)
### Initial setup
- Install python, 3.10.4 is recommended as it gets installed by default on most recent Linux distros
- Install devkitPro, the only package you need is devkitPPC which gets installed by selecting either Wii or GameCube development
- Add the path where ninja is located to your environment variables under `PATH`
- Download the GC MW Compilers
- Clone the repo using `git clone https://github.com/SwareJonge/mkdd --recursive`
- Install the modules from requirements.txt (`pip install -r requirements.txt`)
2023-12-19 21:29:54 +01:00
- Dump a copy of the Debug or PAL version and extract `main.dol`
- For Debug place `main.dol` in `orig/MarioClub_us/`
- For PAL place `main.dol` in `orig/Release_eu/`
- Put the contents of the `GC` folder inside `compilers_latest.zip` in the `tools` folder
2022-07-07 11:43:02 +02:00
2023-03-02 17:52:15 +01:00
### Instructions
- To target Debug, run `python configure.py -r us`
- To target PAL, run `python configure.py -r eu`
- If `dol_slices.yml` changed, rerun the configure script
- Run `ninja`
2023-12-19 21:29:54 +01:00
- Last build step should say something like: ``main.dol: OK``
- Output is located in the `out` folder
2022-07-07 11:43:02 +02:00
## Credits
2023-03-02 17:59:41 +01:00
- [Seeky](https://github.com/SeekyCt) for ppcdis, without it this project wouldn't have been where it is now
### Matching
2023-09-16 02:18:41 +02:00
Used code from the following repositories(JSystem, SDK)
* [Metroid Prime Decomp](https://github.com/PrimeDecomp/prime)
2023-03-02 17:59:41 +01:00
* [Pikmin 2 Decomp](https://github.com/projectPiki/pikmin2)
2023-09-16 02:18:41 +02:00
* [Super Mario Galaxy Decomp](https://github.com/shibbo/Petari)
2023-03-02 17:59:41 +01:00
* [Super Mario Sunshine Decomp](https://github.com/doldecomp/sms)
* [Syati](https://github.com/PMArkive/Syati-pretransfer)
* [Twilight Princess Decomp](https://github.com/zeldaret/tp)
And many thanks to the people who helped me match some game functions(sorry if i forgot someone)
* [Chippy](https://github.com/1superchip)
* [kiwi](https://github.com/kiwi515)
* [Seeky](https://github.com/SeekyCt)