Skip to content

armgit / gecko

Public Imported from GitHub
0

A GameCube/Wii emulator and debugger written in Rust.

update readme

Laylea6f31ac958a1
diff --git a/README.md b/README.md
index 1e5e5d3..ffe4859 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,8 @@ Gecko is developed with homebrew development and reverse engineering in mind, bu
- Supports all major platforms
- `wesl` based specialized shader compiler
- JIT and shader cache
+- FIFO recorder & player
+ - Compatible with Dolphin
- Frame pacing
- Modular audio backend, defaults to `cpal`
- Supports mixing audio sinks
@@ -139,23 +141,25 @@ Nunchuk:
## Projects
This is a table of the main projects. Refer to `crates/` to find out about all available projects.
-| Crate | Description |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `app` | End-user library browser (binary name `gecko`): iced-based game list, double-click to play, per-game player window |
-| `tinyapp` | Lightweight emulator application with an egui/wgpu GUI, optional Lua scripting |
-| `debugger` | Interactive GUI debugger built on egui with rendering support, hooks and scripting capabilities |
-| `web` | WebAssembly build of the emulator for browser deployment via wasm-bindgen, with optional debug UI |
-| `multitool` | CLI utility for analyzing, disassembling and extracting GC/Wii binaries/images (DOL, IPL, ISO/RVZ) with support for PPC and DSP |
+| Crate | Description |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------------- |
+| `app` | End-user library browser (binary name `gecko`): iced-based game list, double-click to play, per-game player window |
+| `tinyapp` | Lightweight emulator application with an egui/wgpu GUI, optional Lua scripting |
+| `debugger` | Interactive GUI debugger built on egui with rendering support, hooks and scripting capabilities |
+| `web` | WebAssembly build of the emulator for browser deployment via wasm-bindgen, with optional debug UI |
+| `multitool` | CLI utility for analyzing, disassembling and extracting GC/Wii binaries/images (DOL, IPL, ISO/RVZ) with support for PPC and DSP |
+| `fifoplayer` | Plays a recorded `.dff` fifo log. Supports replays generated from Dolphin and Gecko's debugger |
## Building
```sh
git submodule init && git submodule update
-cargo build -p multitool --release # multitool
+cargo build -p gecko-app --release # game launcher (binary: gecko)
cargo build -p tinyapp --release # tinyapp
-cargo build -p gecko-app --release # library shell (binary: gecko)
cargo build -p debugger --release # debugger
+cargo build -p multitool --release # multitool
+cargo build -p fifoplayer --release # fifo player
wasm-pack build crates/web --target web --out-dir pkg --release # web version
```
@@ -230,7 +234,18 @@ so the underlying flag of the same name is what actually toggles the behavior. F
## Required files
-Gecko does not ship any system files.
+Gecko does not ship any system files.
+
+Reference SHA-256 hashes (these are the files the project is developed against):
+
+| File | SHA-256 |
+| ---------------------------- | ------------------------------------------------------------------ |
+| `IPL.bin` (NTSC, encoded) | `7228bd8f0171008e71c48788eef5e0fd5abce8ef85f1d00327c6f3368113d2a5` |
+| `IPL.decoded.bin` (NTSC) | `31e9aa82d972a423d9b7ea7bdbdcff0aff86c3ed953600ca841fe24f3f577051` |
+| `PAL_IPL.bin` (PAL, encoded) | `a5fd3ab0ed3d63ad365990cbf522f9f175e01d3b37e5f30a8e5a103cbbc749fd` |
+| `PAL_IPL.decoded.bin` (PAL) | `011b66ce68d8dcb4f37460fcb322215bcda7df79072aeca22fdc690499deabac` |
+| `dsp_rom.bin` | `49d987ee1eab29a157425b82d54516957a81e1bac247c8834e494642605c3e8c` |
+| `dsp_coef.bin` | `d7741279c2e8ec5c5fb318f8fbdd6de6bf583520d288e836a5383233a4238179` |
### GameCube
- IPL (NTSC and PAL tested)
@@ -251,20 +266,6 @@ A NAND is generated on boot whenever `fs/` is missing. The folder can be overrid
GECKO_FS_ROOT=/path/to/dolphin-nand tinyapp --dvd wii_game.rvz # ... and other arguments
```
-The generated SYSCONF uses some fixed defaults! This may cause some strange side effects, I have not observed any yet
-but there surely are some issues with it.
-
-Reference SHA-256 hashes (these are the files the project is developed against):
-
-| File | SHA-256 |
-| ---------------------------- | ------------------------------------------------------------------ |
-| `IPL.bin` (NTSC, encoded) | `7228bd8f0171008e71c48788eef5e0fd5abce8ef85f1d00327c6f3368113d2a5` |
-| `IPL.decoded.bin` (NTSC) | `31e9aa82d972a423d9b7ea7bdbdcff0aff86c3ed953600ca841fe24f3f577051` |
-| `PAL_IPL.bin` (PAL, encoded) | `a5fd3ab0ed3d63ad365990cbf522f9f175e01d3b37e5f30a8e5a103cbbc749fd` |
-| `PAL_IPL.decoded.bin` (PAL) | `011b66ce68d8dcb4f37460fcb322215bcda7df79072aeca22fdc690499deabac` |
-| `dsp_rom.bin` | `49d987ee1eab29a157425b82d54516957a81e1bac247c8834e494642605c3e8c` |
-| `dsp_coef.bin` | `d7741279c2e8ec5c5fb318f8fbdd6de6bf583520d288e836a5383233a4238179` |
-
## Usage
Example invocations: