garbage/README.org

#+TITLE: GarbAGE (Garbage Accurate GameBoy Emulator)
#+AUTHOR: Riyyi
#+LANGUAGE: en
#+OPTIONS: toc:nil

Accurate GameBoy emulator.

** Download

*** Clone

#+BEGIN_SRC sh
  $ git clone https://gitlab.com/riyyi/garbage
  $ cd garbage
  $ git submodule init
  $ git submodule update
#+END_SRC
Or
#+BEGIN_SRC sh
  $ git clone --recursive https://gitlab.com/riyyi/garbage
#+END_SRC

*** Update

#+BEGIN_SRC sh
  $ git pull
  $ git submodule update --recursive
#+END_SRC

** Build instructions

#+BEGIN_SRC sh
  $ mkdir build
  $ cd build
  $ cmake .. && make
#+END_SRC

** Libraries

- [[https://github.com/riyyi/ruc][ruc]]

** References

*** Test ROMs

- https://github.com/gbdev/awesome-gbdev#testing
- https://tasvideos.org/EmulatorResources/GBAccuracyTests

*** Opcodes

- https://www.pastraiser.com/cpu/gameboy/gameboy_opcodes.html
- https://github.com/lmmendes/game-boy-opcodes
- https://rgbds.gbdev.io/docs/v0.5.2/gbz80.7/
- https://gbdev.io/pandocs/CPU_Instruction_Set.html