https://github.com/codemicro/chip8

Chip-8 emulator written in Go
https://github.com/codemicro/chip8

Last synced: about 1 month ago
JSON representation

Chip-8 emulator written in Go

• Host: GitHub
• URL: https://github.com/codemicro/chip8
• Owner: codemicro
• License: mit
• Created: 2021-06-12T22:43:56.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-22T11:47:58.000Z (almost 5 years ago)
• Last Synced: 2025-10-13T14:23:09.472Z (8 months ago)
• Language: Go
• Size: 99.6 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# chip8

*A Chip-8 emulator written in Golang*

---

![IBM logo](images/ibmlogo.png)

![Slippery slope game](images/slipperyslope.png)

## Build

Prerequisites:

* A copy of a recent version of the Go toolchain

* The [Mage build tool](https://magefile.org)

* The [dependencies for Ebiten](https://ebiten.org/documents/install.html)

```

git clone https://github.com/codemicro/chip8.git

cd chip8

mage build

# output in ./bin/yourOS-yourPlatform/

```

## Run

```

Usage: c8run [--verbose] [--scale SCALE] [--frequency FREQUENCY] [--clock CLOCK] [--foreground FOREGROUND] [--background BACKGROUND] INPUTFILE

Positional arguments:

  INPUTFILE

Options:

  --verbose, -v          enable verbose/debug mode

  --scale SCALE, -s SCALE

                         UI scale factor [default: 5]

  --frequency FREQUENCY

                         sound timer tone frequency [default: 350]

  --clock CLOCK, -c CLOCK

                         approximate clock speed in hertz [default: 500]

  --foreground FOREGROUND, -f FOREGROUND

                         foreground hex colour [default: 3D8026]

  --background BACKGROUND, -b BACKGROUND

                         background hex colour [default: F9FFB3]

  --help, -h             display this help and exit

```

## To-do

* [ ] Full unit tests for VM