mirror of
https://github.com/valentderah/totk-pc-recomp.git
synced 2026-11-22 13:05:57 +00:00
The bug form asks for the version on the settings menu's title line instead of the window title, which has none, points to Copy system info and to logs\totk.log. CONTRIBUTING lists the lifter's differential tests and the commit message style for pull requests. docs/maxwell.md cites nxnative's notes by name, since nxnative rewrote them and the line numbers pointed nowhere, and pins the MacNativeGames shorthand to the commit its line numbers were read at. totk.ini.example gains menu_lang and input_record and points to the menu's Advanced tab for the other keys. AGENTS.md asks comments to cite upstream code by project, file and function. README: Linux and the Steam Deck are the platforms planned. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
65 lines
4.1 KiB
Markdown
65 lines
4.1 KiB
Markdown
# 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](docs/architecture.md).
|
|
|
|
## Status
|
|
|
|
Early development. The game is playable on Windows; visual bugs and crashes are still expected. Linux and the Steam Deck are planned.
|
|
|
|
Report problems as issues, following [CONTRIBUTING.md](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](../../releases/latest) 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](totk.ini.example) lists every key). Controls: [docs/controls.md](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](THIRD_PARTY_NOTICES.md).
|
|
|
|
- [LAS Recomp](https://github.com/peiikai/LASRecomp)
|
|
- [MacNativeGames](https://github.com/ly05010419/MacNativeGames)
|
|
- [d2r-mobile](https://github.com/jhaizhou-ops/d2r-mobile) and [nxnative](https://github.com/seedds/nxnative)
|
|
- [SavageWindRecomp](https://github.com/Revivedx/SavageWindRecomp)
|
|
- [Ryujinx](https://github.com/Ryujinx/Ryujinx)
|
|
- [deko3d](https://github.com/devkitPro/deko3d)
|
|
- [hactool](https://github.com/SciresM/hactool)
|
|
- [SDL 3](https://libsdl.org), [Dear ImGui](https://github.com/ocornut/imgui), [AMD FSR 1](https://github.com/GPUOpen-Effects/FidelityFX-FSR), [Vulkan Memory Allocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator), [libopus](https://opus-codec.org), [libvpx](https://chromium.googlesource.com/webm/libvpx), [Zstandard](https://github.com/facebook/zstd)
|
|
- [Switchbrew](https://switchbrew.org) and the Switch homebrew community
|
|
|
|
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](AGENTS.md) holds the rules they work under.
|
|
|
|
## License
|
|
|
|
The project's own code is under the [MIT License](LICENSE); third-party code keeps its own license ([THIRD_PARTY_NOTICES.md](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](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](docs/tester-guide.md).
|