diff --git a/README.md b/README.md index 9878abf..f456203 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,44 @@ A very rough start to a Game Boy Advance emulator in Crystal Lang. The long-term goal is simply playability of popular titles. The name of the project come from the emudev discord, where "crab" was suggested for "Crystal Advanced Boy." Close enough. +![](README/aw.gif) +![](README/brin.gif) +![](README/swi_demo.png) +![](README/m3_demo.png) + ## Installation At the moment, a `shards install` is all that's required. ## Usage -This is not in a functional state. As arm instructions are being implemented, you can print the trace by compiling with `-Dtrace` or print logs by compiling with `-Dlog`. Next, simply provide the executable with the path to your rom. +This is not in a functional state. As instructions are being implemented, you can print the trace by compiling with `-Dtrace` or print logs by compiling with `-Dlog`. Next, simply provide the executable with the path to your rom. + +## Features and Remaining Work + +### Features + +- GLSL shaders for color reproduction +- Basic PPU mode 0, 3, 4, and 5 implementations +- Passing [armwrestler](https://github.com/destoer/armwrestler-gba-fixed) +- Passing [FuzzARM](https://github.com/DenSinH/FuzzARM) +- Passing roughly half of [gba-suite](https://github.com/jsmolka/gba-suite) + +### Remaining Work + +Really, this list should include _everything_... + +- Interrupts +- Timers +- Sound +- PPU things + - Affine + - Mosaic + - Window + - Objects + - Alpha blending + - Etc +- Etc ## Contributing diff --git a/README/aw.gif b/README/aw.gif new file mode 100644 index 0000000..bc560a8 Binary files /dev/null and b/README/aw.gif differ diff --git a/README/brin.gif b/README/brin.gif new file mode 100644 index 0000000..68d47cf Binary files /dev/null and b/README/brin.gif differ diff --git a/README/m3_demo.png b/README/m3_demo.png new file mode 100644 index 0000000..dc4cbad Binary files /dev/null and b/README/m3_demo.png differ diff --git a/README/swi_demo.png b/README/swi_demo.png new file mode 100644 index 0000000..a733a96 Binary files /dev/null and b/README/swi_demo.png differ