ammario / chip8 Goto Github PK

This is a CHIP-8 emulator, written in Go.

Go 1.9 is required, so if you have an older version, you will need to upgrade. Additionally, the following libraries are used:

github.com/go-gl/gl/v2.1/gl
github.com/go-gl/glfw/v3.2/glfw
github.com/nsf/termbox-go

The go get command will fetch the source and dependencies and compile the binary:

> go get github.com/jtharris/chip8

To run a game, specify the file as the first argument:

> chip8 my-games/BRIX

This repo has a few games from the internet, but there are likely plenty more out there. Here is how to play BRIX:

 > wget https://github.com/jtharris/chip8/raw/master/games/BRIX
 > chip8 BRIX

For this game, the Q and E keys move left and right.

The default behavior is to use OpenGL to render the display. There is also a terminal version available using the -terminal flag:

> chip8 -terminal games/PONG2

If you are curious about the opcodes for a particular game, you can print those with the -print flag:

> chip8 -print games/VBRIX

CHIP-8 input is based on a hex-keyboard, with the following layout. This is mapped to a QWERTY keyboard by using 4x4 block of keys from 1 in the upper left corner to V in the lower right corner.

The first value is the hex value, and in parentheses is the QWERY key. Games that you will find on the internet typically don't have any sort of instructions, so initially you will probably just have to bang around on these until you find the buttons that work.

When running in terminal mode, the ESC key will quit.

Opcodes were implemented as needed in order to get certain games to work. There are a few stragglers that weren't being used in the games I have been running.