-
Project Website 🌐 | [Currently points to wiki as decomp site is WIP]
As the decompilation has not neared completion we don't have any systems in place to let those not helping with the decomp use the code.
We have started work on a modding system that will allow you to use the decompilation to make mods for the game, but more areas of the game need to be decompiled so that we know how to replace them.
If you are interested with helping with the decompilation see the Developing section below.
-
cloning the repo:
git clone https://github.com/chameleonTwistRet/chameleonTwistv1.0-JP . --recurse-submodules -
making sure splat is up to date:
git submodule update --remote -
install package requirements:
./install.sh -
put the JPv1.0 rom in the root of the repo and name it
baserom.z64(make sure the SHA1 matches the one in the badge above) -
run
./configure && ./ninjato build the rom
Now you can run ./configure && ./ninja whenever you make changes to make sure the rom builds.
If you have made changes to files - for example: splitting a c file; making a function be asm instead of c (which generates a new file); etc. - you will need to run ./configure --clean again to make sure the build system doesn't attempt to use old files.
A matching ROM will output an "OK" in the console when building.
All contributions should be done through pull requests for those outside of Rainchus, Elisiah and Nathan R.
Please only make pull requests once your fork/branch has posted "OK" on building the rom.
As of now, progress tracking is automatically handled using github CI. Every time a new push to the main brainch occurs, the CI will make sure the project builds and if there have been changes the API containing our progress data will be updated. The progress data is then used to generate the badges above.
Do not attempt to manually update the progress data, it will be overwritten by the CI