Mirrors/totk-pc-recomp
Watch
1
0
Fork
You've already forked totk-pc-recomp
 0
mirror of https://github.com/valentderah/totk-pc-recomp.git synced 2026-11-05 00:00:43 +01:00
Code Issues Projects Releases Packages Wiki Activity
Static recompilation of The Legend of Zelda: Tears of the Kingdom to native Windows x86-64, with a Vulkan renderer. Game files not included.
773 commits 2 branches 9 tags 14 MiB
  • C 78.4%
  • Python 17.7%
  • C++ 3.1%
  • NASL 0.4%
  • C# 0.3%
  • Other 0.1%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Valiantsin Dzerakh 101132a6c8 Build the Linux release again after build_sources gained its profile argument 
282130a made make_release.build_sources take the release's profiles and left the call in make_release_linux.py with
one argument, so the Linux release stopped with a TypeError. The Linux setup compiles without a profile, so it passes
none.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 22:16:41 +03:00
.githooks Add the recompiler, Windows runtime, tools and docs 2026-10-23 22:27:54 +03:00
.github Ask for the save and input recording in the crash template itself 2026-11-03 20:17:20 +03:00
docs Start function-local variables at 0 on Mesa drivers only 2026-11-04 18:05:21 +03:00
installer Merge task/pgo: build the game code with an execution profile from the release 2026-11-04 11:08:02 +03:00
recomp Scale the 1.2.1 map cursor and vertical aim steps by the frame ratio 2026-11-04 17:48:48 +03:00
runtime Merge branch 'dev' into task/wbmerge 2026-11-04 21:55:37 +03:00
tests Read the mouse mode with its default so direct is on without a totk.ini line 2026-11-04 08:52:06 +03:00
tools Build the Linux release again after build_sources gained its profile argument 2026-11-04 22:16:41 +03:00
.gitattributes Add the recompiler, Windows runtime, tools and docs 2026-10-23 22:27:54 +03:00
.gitignore Build and run the runtime natively on Linux. 2026-10-29 16:56:56 -03:00
AGENTS.md Update the remaining explanatory files: issue form, contributing, maxwell sources, settings example, comment rule 2026-10-29 13:12:37 +03:00
CLAUDE.md Add the recompiler, Windows runtime, tools and docs 2026-10-23 22:27:54 +03:00
config.example.toml Let the installer extract the Switch shared fonts from a firmware folder 2026-11-01 15:22:14 +08:00
CONTRIBUTING.md Update the remaining explanatory files: issue form, contributing, maxwell sources, settings example, comment rule 2026-10-29 13:12:37 +03:00
LICENSE Add the recompiler, Windows runtime, tools and docs 2026-10-23 22:27:54 +03:00
README.md Drop the keyboard prompts of #483 in favour of #585 2026-11-04 08:35:35 +03:00
THIRD_PARTY_NOTICES.md Scale the 1.2.1 map cursor and vertical aim steps by the frame ratio 2026-11-04 17:48:48 +03:00
totk.ini.example Merge branch 'dev' into task/grassfire 2026-11-04 16:49:47 +03:00
VERSION Up version 0.3.10 2026-11-04 19:10:09 +03:00

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 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)
  • Discord Rich Presence ("Playing TotK Recomp" with the play time), off by default, own application id supported
  • Setup and in-game menu in English, Russian, Brazilian Portuguese and Simplified Chinese
  • Keyboard, mouse and gamepad with remapping, rumble and gyro
  • Stereo or 5.1 surround sound output
  • Xbox button prompts: LB, RB, LT, RT, Menu and View, and A, B, X and Y 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)
  • Atmosphère cheats: put a cheat file into a mod and switch its cheats in the menu (docs/cheats.md)

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.