Telkin is a powerful and dynamic mod-loading framework designed for the Wii U's CafeOS system. It facilitates target-specific loading of plugins and provides an interface for applying runtime patches in a safe and compatible manner.
- Hooking Engine: Supports three primary types of runtime modifications
- Branch Hook: Redirect function calls and execution to custom code
- Pointer Hook: Swap out data or function pointers in memory
- Patch Hook: Apply raw data patches of varying sizes
- Validation: We have strict checks in place to ensure a stable environment before booting
- Semantic Versioning: Built-in support for complex version requirements ensuring mod compatibility is met at runtime
- Hook Scanning: Automatically check for overlapping memory writes and catch it before applying patches
- Cache Invalidation: Coherency is enforced via synchronization steps taken place during the patch application step
- And more coming soon: Hot-reload and reversible hooks are currently being investigated
Telkin's Aroma launcher requires a modified Wii U running Aroma custom firmware. Visit here for a tutorial on installing Aroma. The launcher plugin is to be placed in the directory sd:/wiiu/environments/aroma/plugins on your SD card. Afterwards, place the telkin folder bundled with the mod on the root of your SD card. Once everything is in place, simply launch the game and the mods should be applied!
Telkin's integrated Cemu launcher comes bundled with mods that rely on it, so no additional steps are necessary. A tutorial for installing mods can be found here.
The developer experience is driven by Tachyon, which handles building and management of Telkin codemods. Read the documentation for more information.
- Luminyx - Loader development, Cemu launcher
- jhmaster - Loader development
- techmuse - Aroma launcher
- STUPID - Cemu launcher
All code in the Telkin repository has been made available under the Mozilla Public License v2.0.