yacemu/README.md

yacemu (Yet Another Chip Eight Emulator)

A Chip-8 emulator (interpereter) written in C. Depends on SDL2.

Building & Testing

In order to run yacemu, you must have sdl2 and make installed.

Once you have the dependencies installed, you can build the emulator with:

make build

You can build start the emulator with:

make run ROM_FILE=[PATH_TO_YOUR_ROM]

If you would like to run it in turbo mode (faster emulation, useful for testing) then run:

make run-turbo ROM_FILE=[PATH_TO_YOUR_ROM]

If you would like to debug with gdb then run:

make debug ROM_FILE=[PATH_TO_YOUR_ROM]

If you would like to debug with gdb in turbo mode then run:

make debug-turbo ROM_FILE=[PATH_TO_YOUR_ROM]

Running

If you have a binary, you can run it with the following:

yacemu [PATH_TO_YOUR_ROM]

If you would like to run it in turbo mode (faster emulation, useful for testing) then run:

yacemu [PATH_TO_YOUR_ROM] turbo

Todo

• Graphics
• Corax+ Required Instructions
• Proper Flag Handling
• Working Input
• More Instructions
• Tetris Working Running
• 1/2 Pass Quirks Test (DispQuirk is a bit touchy)
• Add beeper (instead of sound, screen becomes red)
• Code cleanup
• Rest of Instructions (I believe a few are missing)

Screenshots