https://github.com/h4ck3rk3y/go-8

A chip-8 emulator written in Go
https://github.com/h4ck3rk3y/go-8

chip-8 ebiten emulator go golang

Last synced: 6 days ago
JSON representation

A chip-8 emulator written in Go

• Host: GitHub
• URL: https://github.com/h4ck3rk3y/go-8
• Owner: h4ck3rk3y
• License: lgpl-3.0
• Created: 2018-04-25T12:19:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-22T07:37:39.000Z (almost 6 years ago)
• Last Synced: 2024-08-03T23:29:27.185Z (4 months ago)
• Topics: chip-8, ebiten, emulator, go, golang
• Language: Go
• Size: 38.1 KB
• Stars: 22
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-golang-repositories - go-8 - 8 emulator written in Go (Repositories)

README

        
[![CircleCI](https://circleci.com/gh/h4ck3rk3y/go-8.svg?style=svg)](https://circleci.com/gh/h4ck3rk3y/go-8)

# go-8 

A chip-8 emulator written in Go. I am trying to learn go-lang for fun and I have always been fascinated with emulators, so I decided to write one in Go. I am using the following [manual](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM#1nnn) as reference.

You'll need the drivers required by ebiten and you can find the relevant installation instructions [here](https://github.com/hajimehoshi/ebiten/wiki/Linux).

I wrote a blog post about this project which you can find [here](https://gyani.net/blog/chip-8/)

![Screen Shot](screenshots/PONG.png?raw=true)

## Test Instructions

```bash

- git clone http://github.com/h4ck3rk3y/go-8

- cd go-8

- go get -v -t -d ./...

- go test --cover

```

## Build Instructions

You can build the program by

```bash

- git clone http://github.com/h4ck3rk3y/go-8

- cd go-8

- go get -v -t -d ./...

- go build main.go cpu.go

```

## Run Instructions

Build the code and then

```bash

- ./main

```

## Key Configuration

The original chip-8 consisted of a hexa decimal gamepad. I use the following mappings.

- Your Key Board --> Chip 8

- 1 --> 1

- 2 --> 2

- 3 --> 3

- 4 --> C

- Q --> 4

- W --> 5

- E --> 6

- R --> D

- A --> 7

- S --> 8

- D --> 9

- F --> E

- Z --> A

- X --> 0

- C --> B

- V --> F

## To Do

- Make roms passable as command line arguments

- Key board mapping in a configuration file

- Configurable colors

- Better unit tests for main.go. cpu.go has 98.8% coverage but overall the coverage drops significantly