This is a custom code platform for New Super Mario Bros. Wii that adds new features to the game, intended to serve as a basis for mods of the game.
Currently still in development, so don't expect everything to be finished. You can check FEATURELIST.md to see a list of features implemented, planned, and unfinished.
You are expected to be familiar with NSMBW modding and how to use Riivolution and Reggie! Next.
A build of the codebase is provided in the Riivolution folder.
Extract this folder to the root of your SD card if using a real Wii, and [Dolphin User Folder]/Load/Riivolution/ if using Dolphin Emulator. You can open the User Folder from Dolphin via File > Open User Folder.
A patch is provided for use with Reggie! Next 4.9.0, extract the folder into the /reggiedata/patches/ folder of Reggie! Next.
As opposed to projects like NewerSMBW or NSMBWer+, this codebase uses Kamek 2 with the Kamek Ninja Template, along with headers from the NSMBW Decomp. This is intended to provide a universal, modern basis for NSMBW custom code, as opposed to the base provided by NewerSMBW.
- Build Kamek and add the path to the executable to the
KAMEK_PATHenvironment variable. - Install a recent version of Python 3.
- Download Ninja and place it in the
/Codebase/directory - Download the CodeWarrior for Embedded PowerPC binaries from here and extract it into the
/Codebase/cw/directory. The compiler should be located at/compilers/Wii/1.3/mwcceppc.exe. - If you're on a non-Windows system, Wine is needed to run CodeWarrior.
Run configure.bat (or configure.sh if you're not on Windows) to configure ninja. Once you've ran the configuration script, run ninja. The project binaries should be located in the /Codebase/bin/ folder.
For a more detailed explanation, check out the Kamek Ninja Template and it's documentation.
Contributions are always welcome. Please see CONTRIBUTING.md for more details.
