diff --git a/README.md b/README.md index 85c899aeb0..02b1ded875 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,48 @@ -![DuskLogo](res/logo-mascot.png) +
+ Logo -- ### **[Official Website](https://twilitrealm.dev)** -- ### **[Discord](https://discord.gg/QACynxeyna)** +

+ Official Website + • + Discord +

+
# 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 -**⚠️ 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. +> [!IMPORTANT] +> Dusk does *not* provide any copyrighted assets. You must provide your own copy of the original game. -| Version | sha1 hash | -|--------------| ---------------------------------------- | -| GameCube USA | 75edd3ddff41f125d1b4ce1a40378f1b565519e7 | -| GameCube PAL | 2601822a488eeb86fb89db16ca8f29c2c953e1ca | +### 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` | ### 2. Download [Dusk](https://github.com/TwilitRealm/dusk/releases) ### 3. Setup the game -- Extract the zip folder -- Launch Dusk -- Select Options, then set the ISO Path to your supported game dump -- Press Start Game to play! -![Dusk options](assets/dusk_options.png) +- Extract the .zip file +- Launch Dusk +- Press **Select Disc Image**, navigate to your game dump, and select the file +- Press **Start Game** to play! # Building + If you'd like to build Dusk 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. +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. # 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/dusk/graphs/contributors). diff --git a/assets/dusk_options.png b/assets/dusk_options.png deleted file mode 100644 index 4ed4ad7563..0000000000 Binary files a/assets/dusk_options.png and /dev/null differ diff --git a/res/rml/prelaunch.rcss b/res/rml/prelaunch.rcss index 6204eb75c1..029a3b23fb 100644 --- a/res/rml/prelaunch.rcss +++ b/res/rml/prelaunch.rcss @@ -104,13 +104,14 @@ hero img { decorator: horizontal-gradient(#FEE685FF #FEE68500); } -disk-status { +disc-info { position: absolute; left: 96dp; bottom: 72dp; display: flex; flex-direction: column; - gap: 8dp; + gap: 12dp; + font-size: 24dp; } version-info { @@ -119,30 +120,53 @@ version-info { bottom: 72dp; display: flex; flex-direction: column; - gap: 8dp; + gap: 12dp; text-align: right; -} - -.status, -.version { font-size: 24dp; } -.status, -.update { +#disc-status { + display: flex; + align-items: center; + gap: 8dp; +} + +#disc-status[status=good] { color: #D8F999; } -.status[bad] { +#disc-status[status=bad] { color: #FFC9C9; } +#disc-status icon { + display: block; + width: 24dp; + height: 24dp; + font-family: "Material Symbols Rounded"; + font-weight: normal; + font-size: 24dp; +} + +#disc-status[status=good] icon { + decorator: text("" center center); +} + +#disc-status[status=bad] icon { + decorator: text("" center center); +} + +#disc-version { + font-size: 20dp; +} + /* TODO: Hidden until an actual update checker is introduced */ .update { display: none; font-size: 16dp; font-weight: bold; cursor: pointer; + color: #D8F999; } .detail, diff --git a/src/dusk/ui/prelaunch.cpp b/src/dusk/ui/prelaunch.cpp index 78af65af94..1e8c464b95 100644 --- a/src/dusk/ui/prelaunch.cpp +++ b/src/dusk/ui/prelaunch.cpp @@ -28,10 +28,13 @@ const Rml::String kDocumentSource = R"RML(