update readme

This commit is contained in:
SwareJonge 2024-06-25 00:10:46 +02:00
parent 02b06c152e
commit 68c98ebd59

View File

@ -1,31 +1,31 @@
# mkdd
Mario Kart Double Dash!!
[![Build Status]][actions] ![Progress]
=============
[Build Status]: https://github.com/SwareJonge/mkdd/actions/workflows/build.yml/badge.svg
[actions]: https://github.com/SwareJonge/mkdd/actions/workflows/build.yml
[Progress]: https://img.shields.io/endpoint?label=Code&url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Fmkdd%2FMarioClub_us%2Fdol%2F%3Fmode%3Dshield%26measure%3Dcode
WIP 1:1 Decompilation of Mario Kart Double Dash!!
This repository does **not** contain any game assets or assembly whatsoever. An existing copy of the game is required.
Currently only the debug version is supported
## Building
### Requirements
- [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`)
- 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
- Clone the repository using `git clone https://github.com/SwareJonge/mkdd`
- Dump a copy of the Debug version and extract `main.dol` and put it in `orig/MarioClub_us/`
### 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`
- Last build step should say something like: ``main.dol: OK``
- Output is located in the `out` folder
- run `python configure.py`
- run `ninja`
## Credits
- [Seeky](https://github.com/SeekyCt) for ppcdis, without it this project wouldn't have been where it is now