No description
Find a file
Pat Hartl a7d7430b7c
Some checks failed
Build / Build Linux (GCC x86_64) (push) Failing after 3s
Build / Build Android (Clang arm64-v8a) (push) Failing after 3s
Build / Build Apple (AppleClang macOS x86_64) (push) Has been cancelled
Build / Build Windows (MSVC x86_64) (push) Has been cancelled
Build / Build Apple (AppleClang iOS arm64) (push) Has been cancelled
Build / Build Apple (AppleClang macOS arm64) (push) Has been cancelled
Use ternary, parse option as stf::filesystem::path
2026-05-11 17:57:48 -05:00
.github/workflows Re-enable Sentry for release builds 2026-05-10 12:10:32 -06:00
.vscode add --console to launch.json 2026-04-19 21:43:29 -07:00
assets assets: Remove objdiff screenshot (#691) 2026-05-06 18:38:01 -06:00
ci Improve build-appimage.sh 2026-05-10 10:54:43 -06:00
docs Add some basic code conventions to the README (#831) 2026-05-10 10:52:47 -06:00
extern Fix "Pause on Focus Lost" preventing startup 2026-05-10 22:29:34 -06:00
include Invert First Person Aiming (#870) 2026-05-10 19:00:20 -06:00
libs Interpolate more things (#699) 2026-05-08 11:50:44 -06:00
platforms Add LSSupportsGameMode to enable game mode (#859) 2026-05-10 10:51:45 -06:00
res Fix Syntax Warning (#743) 2026-05-09 14:14:36 -06:00
src Use ternary, parse option as stf::filesystem::path 2026-05-11 17:57:48 -05:00
tools state packs and partial states 2026-04-22 02:44:58 -07:00
.clang-format Start using Rml::PropertyId/Property instead of strings 2026-04-28 00:18:52 -06:00
.clangd Add doxygen comment format to .clangd (#3093) 2026-02-11 00:13:26 -08:00
.flake8 switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
.gitattributes switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
.gitignore ignore 2026-04-09 04:59:36 -07:00
.gitmodules Change aurora submodule URL to HTTPS 2026-02-28 19:15:40 +01:00
cmake-variants.yaml GCN PAL support (#533) 2026-04-25 15:46:12 -06:00
CMakeLists.txt Crash Reporting Popup (#879) 2026-05-10 18:37:22 -06:00
CMakePresets.json Update CMakePresets.json 2026-05-10 13:35:58 -06:00
files.cmake Crash Reporting Popup (#879) 2026-05-10 18:37:22 -06:00
flake.lock Add flake.nix to build on NixOS 2026-04-13 22:17:06 -04:00
flake.nix Fix Flake to Build Successfully (#791) 2026-05-10 10:53:07 -06:00
ios.toolchain.cmake CI/CD, CMake improvements, more targets, fix gcc (#258) 2026-04-09 19:22:53 -06:00
LICENSE.md add license (#389) 2023-07-25 17:22:44 -04:00
README.md Add some basic code conventions to the README (#831) 2026-05-10 10:52:47 -06:00
version.h.in Integrate Sentry crash reporting for public builds 2026-04-14 00:43:56 -06:00

Overview

Dusk is a reverse-engineered reimplementation of Twilight Princess.

It aims to be as accurate as possible to the original while also providing new options, enhancements, and tools to customize your experience.

Setup

Important

Dusk does not provide any copyrighted assets. You must provide your own copy of the original game.

Important

At a minimum, Dusk requires a GPU with support for either D3D12, Vulkan, or Metal. Your experience with specific hardware, operating systems, and drivers may vary. In particular, older Intel iGPUs have a high likelyhood of incompatibility. We are also aware of a number of issues on devices with Adreno GPUs and are working to resolve them.

1. Verify your dump

First, make sure your dump of the game is clean and supported by Dusk. You can do this by checking the SHA-1 hash of your dump against this list of supported versions:

Version SHA-1 hash
GameCube USA 75edd3ddff41f125d1b4ce1a40378f1b565519e7
GameCube EUR 2601822a488eeb86fb89db16ca8f29c2c953e1ca

*Support for other versions of the game is planned in the future.

2. Download Dusk

3. Setup the game

Windows / macOS / Linux

  • Extract the .zip file
  • Launch Dusk
  • Press Select Disc Image and provide the path to your supported game dump
  • Press Play!

iOS

Android

  • Install the Dusk apk
  • Launch Dusk
  • Press Select Disc Image and provide the path to your supported game dump
  • Press Play!

Building

If you'd like to build Dusk from source, please read the build instructions.

Pull requests are welcomed! Note that we do not accept contributions that are primarily AI-generated and will close your PR if we suspect as much. Please also see the code conventions.

Credits

Special thanks to the TP decompilation team, the GC/Wii decompilation community, the Aurora developers, the TP speedrunning community, and all contributors.