mirror of
https://github.com/TwilitRealm/dusklight
synced 2026-08-16 12:24:45 -04:00
Irastris
27d27e6d94
* Add offsets for Wii USA R0/R2, JPN, and PAL Also fix an oopsie where l_pos and l_normal's offsets were swapped * Allow loading Wii discs * Change GameVersion::GcnJpn checks to isRegionJpn() * Change GameVersion::GcnPal checks to isRegionPal() * Add platformSelect and regionSelect templates, simplify a ton of code * Add *_get() macros to simplify REL loads * Actually accept Wii USA Rev. 2 discs * Show the Wii USA revision in prelaunch's disc status * l_normal isn't in Wii RELs, so I'll just hardcode it * Account for various BLO differences Fix crash when opening the map on Wii USA Rev 0 and Wii PAL * Use the streamed version of the file select music * Update language selection * Fix the d-pad/cross button text for Wii PAL Resizing panes that are already 120.0f wide is harmless, so I didn't bother with a GameVersion check * Fix brightness check discrepancy, use IF_DUSK_BLOCK macros when ideal * Update docs and the issue template
54 lines
2.5 KiB
Markdown
54 lines
2.5 KiB
Markdown
<div align="center">
|
|
<img src="res/logo.png" alt="Logo" width="640">
|
|
|
|
<p align="center">
|
|
<a href="https://twilitrealm.dev">Official Website</a>
|
|
•
|
|
<a href="https://discord.gg/6NpMhefCK9">Discord</a>
|
|
</p>
|
|
</div>
|
|
|
|
# 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.
|
|
|
|
# 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](https://wiki.dolphin-emu.org/index.php?title=Ripping_Games) for instructions. After dumping, you can use a program like [Dolphin](https://dolphin-emu.org/) or [nodtool](https://github.com/encounter/nod/releases) 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](https://github.com/zeldaret/tp), 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](https://twilitrealm.dev/install/) for full instructions.
|
|
|
|
# Building
|
|
|
|
If you'd like to build Dusklight from source, please read the [build instructions](docs/building.md).
|
|
|
|
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](docs/code-conventions.md).
|
|
|
|
# Credits
|
|
|
|
Special thanks to the [TP decompilation](https://github.com/zeldaret/tp) team, the GC/Wii decompilation community, the [Aurora](https://github.com/encounter/aurora) developers, the [TP speedrunning community](https://zsrtp.link), and all [contributors](https://github.com/TwilitRealm/dusklight/graphs/contributors).
|
|
|
|
<br/>
|
|
<div align="center">
|
|
<a href="https://github.com/encounter/aurora">
|
|
<img src="assets/aurora-powered.png" alt="Powered by Aurora" width="800">
|
|
</a>
|
|
</div>
|