https://github.com/soumitradev/chip8

My first attempt at hardware emulation.
https://github.com/soumitradev/chip8

chip8 emulator go golang

Last synced: 5 months ago
JSON representation

My first attempt at hardware emulation.

• Host: GitHub
• URL: https://github.com/soumitradev/chip8
• Owner: soumitradev
• License: mit
• Created: 2021-04-06T18:00:51.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-04-07T17:15:48.000Z (about 5 years ago)
• Last Synced: 2024-06-20T16:45:29.221Z (almost 2 years ago)
• Topics: chip8, emulator, go, golang
• Language: Go
• Homepage:
• Size: 2.09 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CHIP8 Emulator

My first attempt at emulation. This Go project aims to emulate a fully working CHIP8 system complete with graphics, a working CPU, memory, sound, and keyboard input.

Everything works as far as I have tested, except for audio.

## Usage

```

Usage: chip8 [--scaling SCALING] [--fps FPS] [--cpuspeed CPUSPEED] ROMPATH

Positional arguments:

  ROMPATH                Path to CHIP8 ROM file.

Options:

  --scaling SCALING, -s SCALING

                         Pixel scaling. Adjusts size of display. [default: 15]

  --fps FPS, -f FPS      FPS to run display at. [default: 60]

  --cpuspeed CPUSPEED, -c CPUSPEED

                         Speed of CPU relative to FPS. [default: 10]

  --help, -h             display this help and exit

  --version              display version and exit

```

## Controls

 Keys

 ---

 

 

			1234

			QWER

			ASDF

			ZXCV

 map to

 

			123C

			456D

			789E

			A0BF

respectively

---

## Screenshots

| Brick                             | Connect 4                     | Pong                   |

|-----------------------------------|-------------------------------|------------------------|

| ![](./gifs/brick.gif)             | ![](./gifs/connect4.gif)      | ![](./gifs/pong.gif)   |

| Rock Paper Scissors               | Space Invaders                | Tetris                 |

|-----------------------------------|-------------------------------|------------------------|

| ![](./gifs/rockpaperscissors.gif) | ![](./gifs/spaceinvaders.gif) | ![](./gifs/tetris.gif) |

## TODO (in no particular order):

- Add more invasive features (e.g. Soft reset, Hard reset, memory manipulation, etc.)

- Implement VIP/Super chip8

- Implement audio (needs a better understanding of goroutines and channels)

## Credits

- Thanks to CowGod a.k.a. [Thomas P. Greene](mailto:cowgod@rockpile.com) for their extremely helpful chip8 documentation!

    [Link to Docs](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM)

- Thanks to [@Skosulor](https://github.com/Skosulor) for their chip8 [testing ROM](./ROMs/TEST1.ch8) that helped me identify a mistake in the chip8 docs.

    [Link to Testing ROM](https://github.com/Skosulor/c8int/tree/master/test)

- Thanks to [@corax](https://github.com/corax89) for their chip8 [testing ROM](./ROMs/TEST.ch8) that helped me identify an error in my stack and instruction pointer.

    [Link to Testing ROM](https://github.com/corax89/chip8-test-rom)

- Thanks to [@kripod](https://github.com/kripod) for his collection of chip8 ROMs. Most of the non-testing ROMs are from here.

    [Link to Collection](https://github.com/kripod/chip8-roms)