Skip to content

armgit / gecko

Public Imported from GitHub
0

A GameCube/Wii emulator and debugger written in Rust.

readme

Layle113d59879080
diff --git a/README.md b/README.md
index 00f1389..868ef53 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ A cross-platform GameCube/Wii emulator and debugger written in Rust.
## Status
-Gecko is still in development. Support may vary, while many games work very well, most will likely have varying degrees of visual glitches or will be outright broken. Refer to the screenshot databases to gauge compatiblity:
+Gecko is still in development. While many games work well, most will likely have varying degrees of visual glitches or will be outright broken. Refer to the screenshot databases to gauge compatiblity:
- [GameCube](https://emu.layle.dev/gecko-gc/4ad1a63/)
- [Wii](https://emu.layle.dev/gecko-wii/4ad1a63/)
@@ -21,7 +21,7 @@ Note: Only NTSC games are tracked. The screenshot service makes a best effort at
## Features
-Gecko is developed with homebrew development and reverse engineering in mind, but also aims to provide accuracy and a playable experience!
+Gecko is developed with homebrew development and reverse engineering in mind, but also aims to provide a faitful and playable experience!
- PowerPC JIT (Cranelift)
- DSP JIT (Cranelift)
@@ -51,6 +51,70 @@ Gecko is developed with homebrew development and reverse engineering in mind, bu
There is currently **no way to save games** for GameCube. Wii save games are supported naturally via NAND.
+## Usage
+Prebuilt releases (including debug builds) can be downloaded [here](https://github.com/ioncodes/gecko/releases). GameCube and Wii require system files to use the emulator, please refer to the ["Required Files"](https://github.com/ioncodes/gecko#required-files) chapter. Minimal commands to launch a game:
+
+```sh
+# Launch a GameCube game
+./tinyapp --ipl IPL.decoded.bin --dsp dsp_rom.bin --coef dsp_coef.bin --skip-ipl --dvd YourGame.rvz
+
+# Launch a Wii game
+./tinyapp --dsp dsp_rom.bin --coef dsp_coef.bin --dvd YourGame.rvz
+```
+
+### Controls
+
+Keybindings are currently hardcoded into `tinyapp` and `debugger`!
+
+#### GameCube
+
+| Key | Action |
+| --------------- | -------------------------- |
+| Arrow keys | Main stick |
+| `I` `K` `J` `L` | D-pad (up/down/left/right) |
+| `X` | A |
+| `Z` | B |
+| `C` | X |
+| `V` | Y |
+| `Enter` | Start |
+| `A` | L |
+| `S` | R |
+| `D` | Z |
+
+#### Wii
+
+Wiimote:
+
+| Input | Action |
+| -------------- | -------------- |
+| Mouse movement | IR pointer |
+| Left mouse | A |
+| Right mouse | B |
+| Arrow keys | D-pad |
+| `1` | 1 |
+| `2` | 2 |
+| `Home` | Home |
+| `-` | Minus |
+| `=` | Plus |
+| `Left Shift` | Shake (motion) |
+
+Nunchuk:
+
+| Key | Action |
+| --------------- | ------------ |
+| `W` `S` `A` `D` | Analog stick |
+| `Q` | Z |
+| `E` | C |
+
+#### Global
+
+| Key | Action |
+| ------- | ------------------------------------------------------------------ |
+| `Space` | Start emulation from the splash screen (`--wait` flag) |
+| `F10` | Trigger a RenderDoc capture (requires `renderdoc-capture` feature) |
+| `F11` | Screenshot the full window |
+| `F12` | Screenshot the emulated framebuffer only |
+
## Projects
This is a table of the main projects. Refer to `crates/` to find out about all available projects.
diff --git a/images/debugger.png b/images/debugger.png
index 363620d..87d65f5 100644
Binary files a/images/debugger.png and b/images/debugger.png differ
diff --git a/images/ffcccb.png b/images/ffcccb.png
index 2ff89ea..a01c6d7 100644
Binary files a/images/ffcccb.png and b/images/ffcccb.png differ
diff --git a/images/luigi.png b/images/luigi.png
index d3b2b7e..0b8b0c8 100644
Binary files a/images/luigi.png and b/images/luigi.png differ
diff --git a/images/re4.png b/images/re4.png
index a5c6106..0a3a914 100644
Binary files a/images/re4.png and b/images/re4.png differ
diff --git a/images/sunshine.png b/images/sunshine.png
index 0313236..213d526 100644
Binary files a/images/sunshine.png and b/images/sunshine.png differ
diff --git a/images/wario.png b/images/wario.png
index 9f4a704..7fab5bc 100644
Binary files a/images/wario.png and b/images/wario.png differ
diff --git a/images/windwaker.png b/images/windwaker.png
index 8cf2068..cded654 100644
Binary files a/images/windwaker.png and b/images/windwaker.png differ