Skip to content

NSMBW-Community/Kamek-Ninja-Template

Repository files navigation

Kamek Ninja Template

This repo provides a modern build system / project template for large-scale Kamek projects, powered by Python and Ninja.

Kamek is a great tool for injecting custom code into Wii games, but it's not a full build system, just a linker and a small runtime loader. Shell scripts (like the examples included with Kamek) work well enough for small projects, but larger projects can benefit greatly from features like parallel and incremental builds.

This repo was spun off from the NSMBW-Updated project, after it became clear how useful its build system was and how much other projects could benefit from it.

Overview

Prerequisites:

  • A recent version of Python 3
  • Kamek and the appropriate version of CodeWarrior for it (follow the download/setup instructions included with Kamek)
  • Ninja
  • If you're on a non-Windows system, Wine is needed to run CodeWarrior.

The high-level workflow looks like this:

  1. Build Kamek and get a copy of CodeWarrior, if you haven't already. (See Kamek's documentation for details.)
  2. Run configure.py to generate build.ninja.
  3. Run ninja to build your Kamek files.

Documentation

Click here for a step-by-step usage tutorial, or click here for more detailed documentation.

License

MIT license. See license.txt for details.

About

A modern build system template for Kamek projects.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published