https://github.com/dragonwasrobot/chip-8

A CHIP-8 emulator written in Elm
https://github.com/dragonwasrobot/chip-8

chip-8 elm emulator

Last synced: 30 days ago
JSON representation

A CHIP-8 emulator written in Elm

• Host: GitHub
• URL: https://github.com/dragonwasrobot/chip-8
• Owner: dragonwasrobot
• License: mit
• Created: 2015-01-11T12:09:19.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T07:13:49.000Z (4 months ago)
• Last Synced: 2024-08-12T08:35:27.325Z (4 months ago)
• Topics: chip-8, elm, emulator
• Language: Elm
• Homepage:
• Size: 1.12 MB
• Stars: 9
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Chip-8

[![Build Status](https://travis-ci.org/dragonwasrobot/chip-8.svg?branch=master)](https://travis-ci.org/dragonwasrobot/chip-8)

This is an implementation of a CHIP-8 emulator written in Elm.

![Screenshot](/docs/screenshot.png)

A range of ROMS are already included - all of which are in public domain.

Credit to Thomas P. Greene. for providing proper documentation of the [Chip-8

specification](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM).

## Installation

**An online demo can be found here:** http://dragonwasrobot.github.io/chip-8/

Ensure you have Elm 0.19 installed. I personally recommend using asdf,

https://github.com/asdf-vm/asdf, to handle version management of compilers.

With Elm installed, perform the following steps:

- Change the `romsUrlPrefix` in `src/Request.elm` to `/roms/`,

- run the command `./build.sh` to compile the source, and

- run the command `python -m SimpleHTTPServer` in the root of the `docs/` folder

  to start a server that can serve both the `docs/index.html` file and the

  CHIP-8 roms stored in `docs/roms`, then

- go to `http://localhost:8000` in your favorite browser.

## Testing

The tests are written using [elm-test](https://github.com/elm-explorations/test)

and [elm-verify-examples](https://github.com/stoeffel/elm-verify-examples/). To

run the tests, perform the steps:

- Run the command `npm install` to install elm-test and elm-verify-examples,

- run the command `npm run doc-tests` to generate the documentation tests found

  in the Elm code,

- run the command `npm test` to run all tests in the `tests` folder.