Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

145 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tachyon5-banner

Overview

Tachyon is an all-in-one cross-platform toolkit for developing custom code & patches for Wii U titles. It primarily operates on projects built for the Telkin loader, and abstracts dependency management & build tasks into an easy to use, modular, and fast development experience. The full lifecycle is handled by Tachyon from compiling to testing to deployment, making mod creation easier than ever!

Features

  • Modern Toolchain: Powered by Red Hills, RedStandard, and LLD, you are provided with state-of-the-art cross-platform C++ development tools.
    • Native compiler & linker binaries for Windows, macOS and Linux.
  • Fast Builds: Cached objects and precompiled headers provide ultra-fast build times.
  • Dependency Management: The built-in package manager allows depending on other modules and libraries seamlessly with one command.
  • Instant Testing: Quickly test your project using Cemu emulator, with automated graphic pack generation, game launching and integrated configurable logs, all from within your IDE.
  • Deployment: Package your module as a library for others to depend on, or bundle the entire workspace as a distributable mod for users to play on console or emulator.
  • IDE Integration: Generates compile_commands.json from your project to get perfect intellisense in any IDE using clangd.
  • Native RPL Creation: Natively outputs Wii U RPL files via integrated rpxlib, no external dependencies needed.

Requirements

  • Node.js v24 or higher
  • For installation:
    • npm v11 or higher (Included with Node.js)

Installation

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

Usage

Quick Start (Blank Project):

tachyon init
tachyon compile TARGET
tachyon launch TARGET

Or clone the RedCore Example Mod for NSMBU:

git clone https://github.com/Zenith-Team/RedCore-Example-Mod MyMod
cd MyMod
tachyon pm install
tachyon compile TARGET
tachyon launch TARGET

Commands Table

Command Description
init Set up a new project using the init wizard
compile Compile the workspace code into an RPL
package Build every target and package for distribution as a dep
bundle Collect all artifacts and deps into a playable bundle
install Install dependencies or add new packages
launch Launch the workspace with Cemu for testing

Read more with tachyon --help.

Limitations

  • Tachyon does not and cannot produce RPX executable files, only RPL modules are currently supported.
    • This means Tachyon cannot be used for standalone Homebrew app development.

Credits

  • jhmaster - Build system, package manager, launcher, binary generation
  • Luminyx - Build system, package manager, binary generation

License

Tachyon v5 is currently initially released as Source-Available only.

The reason for this is the codebase in its current public form has a lot of tech debt, from beginning as a simple single-file compiler script, as such a rewrite of the codebase is already underway, but could not be completed in time for the joint release with the rest of the toolchain Tachyon is a part of.

For that reason any contributions would be voided upon the completion of the rewrite, so please wait until then. The rewrite will be released under the MPL.

About

A Wii U code injection toolkit. Goes fast; does magic.

Topics

Resources

Stars

9 stars

Watchers

3 watching

Forks

Releases

Used by

Contributors

Languages