Giter VIP home page Giter VIP logo

chip-8's Introduction

Chip-8

Build Status

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

Screenshot

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.

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 and 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.

chip-8's People

Contributors

dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar dragonwasrobot avatar raphexion avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

raphexion hoangpq

chip-8's Issues

Update to Elm 0.19

Update to Elm 0.19

  • elm-package.json -> elm.json
  • change dependencies.
  • get code compiling.
  • check if we can use elm/http + elm/bytes instead of javascript for fetching and parsing the ROMs.
  • check if we can use elm-canvas rather than javascript.

Make code optimizable

Make the code optimizable by handling all case branches that end in a Debug.todo. Introduce Result String x instead.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.