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 needing a PC (or needing to modify the partition table on your SD card).

Help and Documentation

• Discord Server: Join our community for support and updates.
• Setup Guide: Your guide to setup, configure, and troubleshoot.
• Documentation: The documentation that explains how to use the application after setup.

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 micro 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.

Updating

TKMM should prompt you when it detects an update (if connected to wifi), when selecting Yes on the update prompt, the update will be downloaded and your Switch will reboot to the new version.

If you ever need to update manually, download the latest update tarball and place it under tkmm/storage/.update/ on your micro SD card. The next time you boot to TKMM-NX, the update will be installed.

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).

   wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
   chmod +x dotnet-install.sh
   ./dotnet-install.sh --channel 10.0
   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

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 & Maintainer
• 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.

---