![DuskLogo](res/logo-mascot.webp)

- ### **[Official Website](https://twilitrealm.dev)**
- ### **[Discord](https://discord.gg/QACynxeyna)**

# Setup
**⚠️Dusk does NOT provide any copyrighted assets. You must provide your own copy of the game.**

### 1. Verify your ROM dump
First make sure your dump of the game is clean and supported by Dusk. You can do this by checking the sha1 hash of your dump against this list of supported versions.

| Version      | sha1 hash                                |
| ------------ | ---------------------------------------- |
| GameCube USA | 75edd3ddff41f125d1b4ce1a40378f1b565519e7 |

### 2. Download [Dusk](https://github.com/TwilitRealm/dusk/releases)

### 3. Setup the game
#### Windows
- Extract the zip folder
- Place your dump of the game into the same folder where you extracted to
- Launch `dusk.exe`

#### macOS
- TODO

#### Linux
- TODO

#### iOS
- TODO

#### android
- TODO

# Building
If you'd like to build Dusk from source, please read the [build instructions](docs/building.md).

# Credits
- Taka
- encounter
- Antidote
- caseif
- CraftyBoss
- crowell
- dooplecks
- gymnast86
- Irastris
- kipcode66
- Lars
- LunarSoap
- Maddie
- MelonSpeedruns
- Pheenoh
- PJB
- Roeming
- YunataSavior

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