itaskaev2andClaude Opus 5.5 8427d8e006 The setup speaks German, French, Spanish, Italian, Dutch, Japanese and Korean, picked from the Windows display language, with every Chinese Windows on the Simplified Chinese setup and the game language starting as the window's where the game has it (the setup part of pull request #497; its in-game menu part stays out, as it covers about two thirds of today's menu)
Taken from #497: the seven catalogs, the language choice in installer/guilogic.py and the launcher, the launcher header and bundle check in the release scripts, the tests. Added here: the ids dev and this branch gained since (kit, PC prompts and display shapes steps, the locked exe and skipped plugins messages, the form sections and More details), and new translations of the ids whose English changed after #497 was translated (NSZ and XCZ input, the missing shared fonts warning, the PlayStation prompts). README gains a Languages table that shows the menu in four languages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:45:37 +03:00
2026-11-15 11:08:49 +03:00

TotK Recomp

TotK Recomp is a static recompilation of The Legend of Zelda: Tears of the Kingdom (Nintendo Switch, 2023) into a native x86-64 application for Windows and Linux (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.1.0, 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 and Linux; visual bugs and crashes are still expected.

Report problems as issues, following CONTRIBUTING.md.

Features

  • Native code, not emulation
  • Game updates 1.1.0, 1.2.1 and 1.4.3; 1.2.1 and 1.4.3 saves carry over between them
  • Takes NSP and XCI game files, and compressed NSZ and XCZ as they are: the setup unpacks them itself
  • 60 fps by default; up to 144 fps or the monitor's refresh rate (experimental)
  • Custom resolutions (1080p, 2k...), supersampling and AMD FSR 1 upscaling
  • NVIDIA DLSS / DLAA on RTX GPUs: the setup downloads nvngx_dlss.dll from NVIDIA's DLSS SDK repository (github.com/NVIDIA/DLSS, NVIDIA RTX SDK license) when it finds an RTX GPU; untick it in the setup to skip it
  • HDR10 output with peak, game and HUD brightness settings
  • 16:10 (Steam Deck, handhelds), 3:2 (Surface, Framework), 21:9 and 32:9 (ultrawide) game resolutions, with the camera and the interface in that shape
  • Anisotropic texture filtering up to 16x, for sharp ground into the distance
  • In-game settings menu (F1) and performance overlay (F10)
  • Play time across runs on the Game tab of the settings menu, kept in playtime.txt next to the saves
  • Discord Rich Presence ("Playing TotK Recomp" with the play time), off by default, own application id supported
  • Setup in 11 languages, in-game menu in 4 (Languages)
  • Keyboard, mouse and gamepad with remapping, rumble and gyro
  • Stereo or 5.1 surround sound output
  • Xbox and PlayStation button prompts: Xbox's LB, RB, LT, RT, Menu, View and A, B, X, Y, or PlayStation's ○ × △ □, L1, R1, L2, R2, Options and Share, as labelled on the button to press, with either button layout
  • Shaders prepared at install instead of during play
  • Mods made for emulators: unpack a mod into the mods folder next to totk.exe; switch and order them in the menu. RomFS mods, TKMM's merged output and ExeFS code patches (.ips, .pchtxt) work; the game rebuilds itself for code patches (docs/mods.md). HD texture packs work: the port grows the texture heap a pack asks for by itself. Tested with the HDPacks.com 4K Texture Pack v1.0 on 1.4.3 and 1.2.1; other packs come with no guarantee
  • Atmosphère cheats: put a cheat file into a mod and switch its cheats in the menu (docs/cheats.md)

Languages

The game keeps the text and voices of every language it shipped with. The port's own setup and in-game menu (F1) come in these; both follow the Windows display language, and the menu has its own choice on its Menu tab. A Traditional Chinese Windows gets the Simplified Chinese setup.

Language Setup In-game menu
English ✅ ✅
Русский ✅ ✅
Português (Brasil) ✅ ✅
简体中文 ✅ ✅
Deutsch ✅ English
Français ✅ English
Español ✅ English
Italiano ✅ English
Nederlands ✅ English
日本語 ✅ English
한국어 ✅ English

Spotted a clumsy phrase, or want your language added? The setup texts are in installer/text/<language>.json, the menu texts in runtime/ui_text.c; open an issue or a pull request (CONTRIBUTING.md). Fixes from native speakers are welcome.

Planned

  • VRR

Installing

Windows

Requirements: Windows 10 or later, an x86-64 CPU with SSE4.2 (AVX2/FMA machines get a faster build), 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. With an NVIDIA RTX GPU it also downloads NVIDIA DLSS, unless you untick Download NVIDIA DLSS; turn DLSS on in the menu (F1).
  4. Play totk.exe from the install folder.

Linux

Requirements: as on Windows, plus Linux 6.7 or later and glibc 2.34 or later (Ubuntu 22.04, Debian 12, Fedora 35, SteamOS 3).

  1. Download TotK-Setup-x86_64.AppImage from Releases, or build it (docs/installer.md, "Linux release").
  2. Make it executable (chmod +x TotK-Setup-x86_64.AppImage) and start it. On a Steam Deck, do this in Desktop Mode.
  3. Pick your game files, the language and an install folder, and press Start.
  4. Play totk from the install folder.

To update, run a newer setup 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.

Languages
C 78.2%
Python 18.1%
C++ 2.8%
NASL 0.3%
GLSL 0.3%
Other 0.3%