chip-8

Version, currently master branch1 version
  • master branchlatestJun 28, 2025

github.com/mattrbeck/chip-8

A Chip-8 emulator written in Crystal

4 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  chip-8:
    github: mattrbeck/chip-8
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.34.0
License
MIT
Author
Matthew Beck
Target
  • chip-8 from src/chip-8.cr

Dependencies

Runtime Dependencies

  • sdl*github: ysbaddaden/sdl.cr

README

chip-8

This is a basic Chip-8 emulator written in Crystal. Rendering is performed using SFML through CrSFML. Sound is not currently supported.

Installation

First, you must install SFML. Next, simply clone the repo, run shards install, then shards build.

Usage

After building, you'll be left with an executable in bin/chip-8. The executable takes a path to a Chip-8 rom as its only argument, so simply execute with bin/chip-8 path/to/rom.

Contributing

  1. Fork it (https://github.com/mattrbeck/chip-8/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors