Skip to content

armgit / gecko

Public Imported from GitHub
0

A GameCube/Wii emulator and debugger written in Rust.

readme

Laylee8f00b46b23d
diff --git a/README.md b/README.md
index abda9a7..5baead2 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,60 @@
-short term todolist
+<div align="center">
-- [ ] JIT for CPU
-- [ ] JIT for DSP
-- [ ] Fix idle detection for CPU
-- [ ] Implement mailbox polling detection for DSP?
-- [ ] HLE? IDK if ever a goal
-- [ ] FIFO Tokens
-- [ ] BATs
+# Gecko
-JIT via Cranelift
\ No newline at end of file
+A work-in-progress GameCube and Wii emulator and debugger written in Rust.
+
+![wario](images/wario.png)
+
+</div>
+
+## Status
+
+Gecko is in early development. The IPL works flawlessly as far as I can tell. Many homebrew demos work, but game compatibility is still low. Some games may get to menu, some ingame but most will likely not do anything (or crash). Gecko is made with homebrew development and reverse engineering in mind. It currently supports:
+
+- PowerPC interpreter
+- DSP LLE interpreter
+- `wgpu` based renderer backend
+- `wesl` based shader compiler
+- LUA scripting/hooks system for runtime introspection
+- egui-based debugging UI
+- [Support for web browser](https://gecko.layle.dev)
+ - [incl. debugging capabilities](https://gecko.layle.dev/dbg)
+- Terrible idle skipping :^)
+
+## Projects
+
+| Crate | Description |
+| ---------- | ----------------------------------------------------------------------------------------------------------- |
+| `tinyapp` | Lightweight emulator application with an egui/wgpu GUI, optional Lua scripting and idle-skip optimization |
+| `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 |
+| `gctool` | CLI utility for analyzing and disassembling GameCube binaries (DOL, IPL, ISO) with support for PPC and DSP |
+
+## Building
+
+```sh
+cargo build -p gctool --release # multi-tool
+cargo build -p tinyapp --release # main application
+cargo build -p debugger --release # debugger
+wasm-pack build crates/web --target web --out-dir pkg --release # web version
+```
+
+Certain features require certain feature flags such as `scripting` and `scripting-mut-traps`, however, the debugger has them all enabled.
+For more information refer to the GitHub CI actions file. PGO optimized compilation is supported, refer to the `Justfile`.
+
+## Usage
+
+```sh
+gctool ipl --action decode ipl.encoded.bin ipl.decoded.bin
+tinyapp --dol homebrew.dol # may also require a DSP depending on the DOL
+tinyapp --iso game.iso --ipl ipl.decoded.bin --dsp dsp_rom.bin
+```
+
+The CLI options are largely the same across the sub projects (such as the debugger). For more options, see `--help`.
+
+## Sister Projects
+Gecko is being developed alongside other amazing emulators that shaped how Gecko came to be. Without them, Gecko wouldn't exist!
+
+- [lazuli](https://github.com/vxpm/lazuli) authored by vxpm
+- [solstice](https://codeberg.org/hazelwiss/solstice) authored by hazelwiss
\ No newline at end of file
diff --git a/images/wario.png b/images/wario.png
new file mode 100644
index 0000000..44da0b6
Binary files /dev/null and b/images/wario.png differ