Patchwork

A Kirby's Epic Yarn (Wii) custom code framework.

Special Thanks

• EternityShack, for teaching me how to use Kamek
• Ninji, for Kamek

Building

Requirements

• NXP CodeWarrior Special Edition for MPC55xx/MPC56xx v2.10
  • If this direct link doesn't work, the original page is available on the Internet Archive.
  • After installing it, you need license.dat from the installation root, and the DLL and EXE files inside PowerPC_EABI_Tools/Command_Line_Tools. Place all of these files in deps/CodeWarrior/.
  • Useful documentation is in Help/Power_Arch_Build_Tools_Reference.chm (or Help/PDF/Power Architecture Build Tools Reference.pdf)
• A build of the Kamek linker. Place it in deps/Kamek/.
• Python 3.7 or newer.

Instructions

You will need Riivolution to load these code mods.

If you just want to quickly test out the existing modifications, then you'll need to set up your patch XML to include the following:

<!-- This XML snippet should be generated when you run build_loader.py -->
<memory offset="0x80001900" valuefile="/YourFolderName/patchwork/rk5_loader.bin"/>
<memory offset='0x80006C40' value='4BFFB73D'/>

To generate loader.bin, run build_loader.py. You will see the file in the build/ folder.

To generate custom code, run build_code.py. This will compile and assemble any .cpp or .S files (excluding those related to the loader). The result will be a file called RK5_{REGION}.bin, where {REGION} is the region of your game, located in the build/ folder.

Once you've gotten your loader and custom code binaries generated, put them wherever your Riivolution and loader code specify. It's important that the location of RK5_{REGION}.bin matches what is specified by the loader - by default, this is in a directory called /patchwork/, though you can change it to whatever you want if you simply recompile.

Modules

Using YAML files, you can specify which parts of the Patchwork codebase you want to include in your compilation. An example (sample_module.yaml) is found in the modules/ folder.

Module Structure

Below is an example strucutre.

Region:
  - "USA"
CPP:
  - "src/sample.cpp"
ASM:
  - "src/sample.S"

Using Modules

A module can be specified by adding the name of the module to the build command ("module" and "module.yaml" will do the same thing).

build_code.py sample_module

Omitting a module name results in all code in the src/ folder being compiled. Likewise, if a specified module name doesn't exist in the modules/ folder, all code gets compiled.

Notes

There is currently only support for the USA version of Kirby's Epic Yarn.

Headers may be innacurate. For accurate headers, see this game's decompilation.