Files
totk-pc-recomp/README.md
T
Valiantsin DzerakhandClaude Opus 5.5 f646e521f0 Bring the README and docs up to date with 1.4.3, the menu, the installer and the log file
The README is a front page now: a general status, a short feature list, install steps from a release, credits as a
list of links that points to THIRD_PARTY_NOTICES.md, the build steps last. The licence table moved into the notices.
The build steps take the game version as <ver>; 1.4.3 is the primary version in the architecture doc, which also
gains the zstd host decoder, the settings table and menu, spin gates, the uniform snapshot and the resolution patches.
Controls list F1, F10, F11 and the menu keys; the tester guide and CONTRIBUTING point to logs\totk.log.

THIRD_PARTY_NOTICES.md: the four code rows that sat in the installer table move to the main table, the zstd rows
cover ov_zstd.c and the release package, the MacNativeGames resolution commit is given in full, the NVN proc list and
the compiler runtime of a source build are listed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-29 12:49:34 +03:00

4.1 KiB

TotK Recomp

TotK Recomp is a static recompilation of The Legend of Zelda: Tears of the Kingdom (Nintendo Switch, 2023) into a native Windows x86-64 application.

Important

No game files are included. You need your own legally obtained copy of Tears of the Kingdom, dumped from your own console: the base game and the 1.2.1 or 1.4.3 update. Instructions for obtaining those files will not be provided.

The game is built from your files on your machine, so the result contains the game. It is for your own use. Do not share it.

The Switch code is translated from ARM64 to C ahead of time and compiled into a native executable. NVN, the Switch graphics API, runs on Vulkan. How it works: docs/architecture.md.

Status

Early development. The game is playable on Windows, with visual bugs and crashes still expected. macOS, Linux and the Steam Deck are planned.

Report problems as issues, following CONTRIBUTING.md.

Features

  • Native code, not emulation
  • Game updates 1.2.1 and 1.4.3, with saves that carry over between them
  • 60 fps by default; up to 360 fps or the monitor's refresh rate (experimental)
  • Resolutions up to 8K, supersampling and AMD FSR 1 upscaling
  • In-game settings menu (F1) and performance overlay (F10)
  • Keyboard, mouse and gamepad with remapping, rumble and gyro
  • Shaders prepared at install instead of during play
  • RomFS mods

Installing

Requirements: Windows 10 or later, an x86-64 CPU with AVX2, a GPU with Vulkan 1.3 and VK_EXT_external_memory_host, about 36 GiB free during setup (20 GiB after).

  1. Download TotK-Setup-<version>-windows.zip from Releases and unpack it.
  2. Start TotK-Setup.exe. If SmartScreen warns about an unsigned app, choose More info, then Run anyway.
  3. Pick your game files, the language and an install folder, and press Start. The setup builds the game once.
  4. Play totk.exe from the install folder.

To update, run a newer TotK-Setup.exe on the same folder; saves and settings are kept. Settings are in the in-game menu and in totk.ini (totk.ini.example lists every key). Controls: docs/controls.md.

Credits

TotK Recomp builds on the projects below. What was taken from each, with its license, is listed in THIRD_PARTY_NOTICES.md.

Most of the code and documentation is written by AI coding agents (Claude Code) under the maintainer's direction; the maintainer plays every build and decides what is merged. AGENTS.md holds the rules they work under.

License

The project's own code is under the MIT License; third-party code keeps its own license (THIRD_PARTY_NOTICES.md). The license grants nothing for Nintendo's game.

TotK Recomp is an independent, non-commercial fan project, not affiliated with or endorsed by Nintendo. The Legend of Zelda, Tears of the Kingdom and Nintendo Switch are trademarks of Nintendo.

Building from source

docs/building.md lists the toolchain and the steps. Everything the build writes stays under build\ and generated\, which git ignores; run tools/check_content.py before a commit. Testers: docs/tester-guide.md.