Skip to content

Latest commit

 

History

History
63 lines (36 loc) · 1.19 KB

README.md

File metadata and controls

63 lines (36 loc) · 1.19 KB

Chipee

A simple CHIP-8 emulator meant to be used as a learning tool for others. Minimal cleverness, useful comments, and readability are its goals.

Goals

Chipee's goals are:

  • To be a learning tool for others.
  • Simplicity.
  • Code readability.

Building

macOS

On macOS, install the sdl2 package from Homebrew.

Then, run make.

Ubuntu

To build using Ubuntu (18.04 and 20.04 have been tested), install the libsdl2-dev package.

Then, run make.

Dockerfile

Another option is to use the included Dockerfile. This image will have build prerequisites installed. You will still need libsdl2-dev installed to run Chipee.

To build the Docker image, run:

docker build --rm -f "Dockerfile" -t chipee:latest .

To execute make inside a container made from this image, run something like:

docker run --rm -v `pwd`:/app chipee make

This will place a chipee executable in the current working directory.

Running

Run the emulator with:

./chipee rom.ch8

Testing

Build and run the test suite by running:

make test

FAQ

Q: Why C?
A: Simplicity.

Q: Does it support Super CHIP-8?
A: No.

Q: Is it any good?
A: Yes