TKMM-NX - Lightweight OS for the Nintendo Switch

   

TKMM-NX is a Linux operating system based on Lakka (LibreELEC) with custom adaptations that allows the TotK Mod Manager to seamlessly run on the Nintendo Switch, without the need for a PC.

Help and Documentation

• Discord Server: Join our community for support and updates.
• Documentation: Your guide to setup, configuration, and troubleshooting.

Downloads

Get the latest OS images to run TKMM on your Switch:

• Stable Release: Download TKMM OS for Switch

Installation

After downloading the .zip file, extract the tkmm and bootloader folders at the root of your SD card.

• boot your Switch into RCM mode
• inject the Hekate payload
• go to "More Configs"
• select "TKMM"

Your Switch should now boot into TKMM-NX.

Building TKMM-NX

To build your own image, follow these steps:

1. Clone the Repository:

   git clone https://github.com/TKMM-Team/TKMM-NX.git
   cd TKMM-NX

2. Install Dependencies:
   Ensure you have the required toolchain installed (see the build-basics and build-advanced pages on the LibreELEC wiki for details).

   sudo apt update
   sudo apt upgrade -y
   sudo apt install -y gcc make git unzip wget xz-utils bc gperf zip g++ \
        xfonts-utils xsltproc openjdk-11-jre-headless libparse-yapp-perl \
        libxml-parser-perl patchutils lzop rdfind dotnet-sdk-9.0 

3. Build the Image:
   Use the provided build scripts and package definitions. For example, to build the release version run:

   DISTRO=TKMM TKMM_VERSION=<tag_name> PROJECT=L4T DEVICE=Switch ARCH=aarch64 make image

   For a debug build (with dotnet SDK and git installed), run:

   DISTRO=TKMM TKMM_VERSION=<tag_name> PROJECT=L4T DEVICE=Switch ARCH=aarch64 DEVMODE=enabled make image

The Team

• Arch Leaders: Lead TKMM Developer
• Lord Bubbles: TKMM-NX Developer
• Aster: Co-Founder, Artist, & Operations Manager
• The5thTear: Co-Founder & Developer
• Mikachan: Developer

Special Thanks

A heartfelt thank you to:

• The Switchroot community for pioneering open-source development on the Nintendo Switch.
• The Lakka team, for its work that allowed us to create a custom OS for TKMM on Switch.
• The LibreELEC team for creating the Linux distribution upon which all of this is built.

---