Skip to content

Commit

Permalink
Added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
velllu committed Sep 11, 2023
1 parent 6b7c15b commit 05c74be
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# <center>GameMan</center>
> <br>
> <center>The GameBoy emulator that does not play around™️</center>
> <br>
<pre></pre>
# What can the emulator actually run?
I am at a *very* early stage, this emulator will **not** run *any* game.
Here's a list of things I need to implement

- [-] GPU
- [x] Barebones and graphicless implementation
- [ ] Background rendering
- [ ] Window rendering
- [ ] Sprite rendering
- [ ] Input Handling
- [ ] GameBoy Color support
- [ ] SPU (Sound), I have yet to research this

# What makes this emulator different?
- It's **embeddable**, you can embed this into any UI framework, gtk, iced etc. This is not actually an emulator per se, it's the "backend", the "frontend" is up to you to implement, altough I will probably make one myself. As of now, a simple frontend that prints register values is available by running `cargo run --example terminal -- /path/to/rom.gb`.
- It will *probably* be **embedded** as well in the future, meaning you will be able to run this on a microcontroller
- Focused on **clean code**, this emulator's focus is neither speed or accuracy, if I delivered on this front is up to you, feel free to open an issue or a pull request if you think something can be improved

0 comments on commit 05c74be

Please sign in to comment.