chip8-emulator

command module
v0.0.0-...-20f391c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 27, 2019 License: MIT Imports: 5 Imported by: 0

README

CHIP-8 Emulator

Build Status

A CHIP-8 emulator written in golang. See this page for information about the CHIP-8 architecture and opcodes.

tcell is used for the terminal interface.

Installation

Make sure golang is installed.

To get the package, run:

go get github.com/Bo887/chip8-emulator

The package should now be located in:

$GOPATH/src/github.com/Bo887

To install the package, run:

make install

The binary should be locaed in:

$GOPATH/bin

To remove the package, just simply delete the directory and the binary.

Usage

The binary name is chip8-emulator. It takes a single argument of the path to the ROM.

For more information, run:

chip8-emulator --help

A few ROMS are located in the roms/ directory from the project root. A lot more are located here.

For example, running:

chip8-emulator roms/chip8-picture

from the project root directory will display the chip8 logo.

The keypad layout is:

+-+-+-+-+
|1|2|3|4|
+-+-+-+-+
|q|w|e|r|
+-+-+-+-+
|a|s|d|f|
+-+-+-+-+
|z|x|c|v|
+-+-+-+-+

To exit the emulator, press either the ESC or Enter keys.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL