Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.67 KB

README.md

File metadata and controls

57 lines (38 loc) · 2.67 KB

8ChocChip

8ChocChip is an emulator for the Chip8 software that I am working on to learn the basics around emulation.

This uses SDL to handle graphics, input, audio and some other small things. libconfig is used to manage config and save data files.

Features

There are a couple of things left to do until I would say it works well enough

  • Proper flag/feature compatibility unlike many out there
  • Cleaner/more optimised code
  • Windows Support
  • MacOS Support
  • Switch to SDL from SFML
  • Save state
  • Configurable keys
  • Database for auto setting selector
  • Other Chip8 variants
  • Per program settings (Keybindings, graphics, sounds, etc)

Usage

To run 8ChocChip you can either launch the executable file with the command line and specify a rom to instantly launch into like this /path/to/exectable/8ChocChip --rom /path/to/rom.8ch. Or you can normally launch the executable to open the UI and manage it from there.

Some basic ROMS can be found here.

More games are here

For a proper test suite you can check out https://github.com/Timendus/chip8-test-suite

Building

Until a proper building section is created, just follow the commands that are used in the GitHub actions workflow for your platform.

https://github.com/JustDoom/8ChocChip/blob/master/.github/workflows/build.yml

Follow the commands but not everything is required to be executed exactly as the file does. Some parts are just setting up ssh or installing dependencies which you may have installed already or have different methods to accomplish the task.

Requirements

To build this it requires C++, CMake and whatever SDL/dependencies need. Check build file above.

Credits

Thanks to these two blogs that helped me through creating this emulator.

Libraries

Currently, three libraries are being used

  • SDL - UI, graphics, input and sounds
  • SDL-ttf - Text fonts
  • libconfig - Library to manage save data (like directories that hold ROMs) and possible future config files