dusklight README

The project's README from github.com/TwilitRealm/dusklight. As one markdown file: README.md.

Logo

Official Website • Discord

Overview

Dusklight 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.

[!IMPORTANT] Dusklight's official website is https://twilitrealm.dev/, any other website is not affiliated and may be promoting AI-generated misinformation.

Setup

[!IMPORTANT] Dusklight does not provide any copyrighted assets. You must provide your own copy of the original game.

[!IMPORTANT] At a minimum, Dusklight requires a GPU with support for D3D12, Vulkan 1.1+, or Metal. For older devices, best-effort support is provided for D3D11 and OpenGL ES (Android), but will not achieve full accuracy or performance. Your experience with specific hardware, operating systems, and drivers may vary.

1. Dump your game

You must dump your own copy of the game. Please see this article for instructions. After dumping, you can use a program like Dolphin or nodtool to convert the .iso to .rvz to save space.

Dusklight currently supports all commercial discs except for Wii's Korean release.

[!NOTE] Dusklight is based on the Twilight Princess decompilation, which is currently only matching for GameCube. As a result, even when playing Dusklight with a Wii disc, you will be presented with the GameCube version's HUD and certain other specificities.

2. Install Dusklight

Visit the official installation guide for full instructions.

Building

If you'd like to build Dusklight 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.


Powered by Aurora

dusklight (TwilitRealm/dusklight)

Searching Database…

What is this?Dusklight is a reverse-engineered reimplementation of The Legend of Zelda: Twilight Princess, rebuilt from a community decompilation so the game can run natively on PC and mobile with bug fixes, new options, and customization tools.
Is this a mod on top of the original game, or a full reimplementation?It is a full reimplementation built directly from the Twilight Princess decompilation project, not a patch applied to an existing executable, which is why it can run on platforms the original game never shipped on.
How do I get it running?Dump your own legally-owned disc to an ISO and convert it to .rvz (with Dolphin or nodtool), then follow the official installation guide to install Dusklight; you can also build it from source using the build instructions if you prefer.
What GPU do I need to run it?At minimum you need a GPU that supports D3D12, Vulkan 1.1+, or Metal; D3D11 and OpenGL ES (on Android) are supported as best-effort fallbacks for older hardware but won't give full accuracy or performance.
Do I need to own the original game, and does every disc version work?Yes, Dusklight ships no copyrighted assets so you must dump your own commercial disc; it supports every commercial release except Wii's Korean edition, and because the underlying decompilation currently only matches the GameCube version, Wii discs will still show the GameCube HUD and quirks.
Which platforms does it run on?Dusklight targets PC and mobile; its GPU requirements (D3D12 for Windows, Vulkan for Linux/Android, Metal for macOS) confirm support across Windows, macOS, Linux, and Android.
Is there an official Dusklight website I can trust?The README warns that any site other than the official one is not affiliated with the project and may spread AI-generated misinformation, so stick to the genuine source for guides and downloads.
What are similar projects?th08, OpenCE, rpcs3, ppsspp, dolphin, duckstation, Yakumo, ASC
Size
296.1 MB
Stars
5.9K
Age
10mo
Commits · 90 Days