Overview

A modern C++ API and modding framework for New Super Mario Bros. U code mods.

Features

• Dynamic: Powered by Telkin, multiple code mods using RedCore can be loaded simultaneously!
• Headers: All libraries and game interfaces are accessible and rapidly updated.
• Target Support: Pre-configured for US, EU, JP regions along with the bundle (+NSLU) release on both Cemu and Console.
• Named Registries: Register custom actors in a quick and compatible manner using string names.
• Event System: Delegate-based event handling with listeners for simple hooks without ASM/RE or conflicts.
• ImGui: Easily produce visual interfaces for fast debugging and development.

Quick Start

Fork the Example Mod, and clone the repository

git clone https://github.com/Zenith-Team/RedCore-Example-Mod MyMod
cd MyMod

Install Tachyon (requires Node.js v24+)

npm i -g --allow-remote=root https://github.com/Zenith-Team/Tachyon/releases/latest/download/tachyon.tgz

Build and run the project for your region (example with US)

tachyon pm install
tachyon compile US
tachyon launch US

Refer to the documentation for further information.

Credits

• Luminyx - API, Infrastructure, Headers
• stupidestmodder - API, Headers
• jhmaster - Infrastructure

Special Thanks

• AboodXD - Headers
• Omar - ImGui Library
• GaryOderNichts - ImGui GX2 Backend