totk-pc-recomp README

The project's README from github.com/valentderah/totk-pc-recomp. As one markdown file: README.md.

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 (docs/architecture.md).

[!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.

Status

Early development. The game is playable on Windows; visual bugs and crashes are still expected.

Report problems as issues, following CONTRIBUTING.md.

Features

Planned

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.

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.

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.

totk-pc-recomp (valentderah/totk-pc-recomp)

nintendo-switch
Searching Database…

What is this?It is a static recompilation of The Legend of Zelda: Tears of the Kingdom (originally a Nintendo Switch game) into a native Windows x86-64 application with its own Vulkan renderer. It does not include the game itself; you provide your own legally dumped copy.
Is this an emulator, or something different?It is not an emulator. The game's code is statically recompiled into native x86-64 machine code that runs directly on Windows, rather than being interpreted/translated at runtime like an emulator does.
How do I install and play it?Download the TotK-Setup- -windows.zip from Releases, run TotK-Setup.exe, point it at your own dumped game files, choose a language and install folder, and it builds the game once. After that you launch totk.exe from the install folder.
What hardware and files do I need before trying this?You need Windows 10+, an x86-64 CPU with AVX2, a GPU supporting Vulkan 1.3 with VK_EXT_external_memory_host, about 36 GiB free disk space during setup, and your own legally obtained dump of the base game plus the 1.2.1 or 1.4.3 update.
Does it come with the game, and is it fully stable?No game files are bundled — you must legally dump the game yourself from your own console. The project is also in early development, so visual bugs and crashes are still expected.
Does it run on Linux too?Right now it only runs on Windows x86-64. Linux and Steam Deck support, along with mod support and ultrawide aspect ratios, are on the roadmap but not yet available.
What kind of performance can I expect compared to the original?It targets 60 fps by default, with an option to go up to 144 fps or your monitor's refresh rate (experimental), plus custom resolutions, supersampling, and AMD FSR 1 upscaling.
Can I use mods made for emulator versions of the game?Not yet. Support for unpacking emulator-made mods into a mods folder is listed as a planned feature, not something available today.
Who actually wrote the code for this project?Most of the code and documentation were written by AI coding agents (Claude Code) directed by the maintainer, who personally plays every build and decides what gets merged.
What controls does it support?Keyboard, mouse, and gamepad are all supported, including input remapping, rumble, and gyro controls; full details are in docs/controls.md.
Size
3.6 MB
Stars
3.2K
Age
3d
Commits · 90 Days