Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominikrys/chip8
👾 CHIP-8 emulator for the web (WebAssembly) and Linux/macOS/Windows
https://github.com/dominikrys/chip8
cpp17 emulator linux sdl2 webassembly windows
Last synced: 6 days ago
JSON representation
👾 CHIP-8 emulator for the web (WebAssembly) and Linux/macOS/Windows
- Host: GitHub
- URL: https://github.com/dominikrys/chip8
- Owner: dominikrys
- License: mit
- Created: 2019-12-25T18:04:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-01T08:16:33.000Z (almost 4 years ago)
- Last Synced: 2024-11-19T18:59:49.339Z (2 months ago)
- Topics: cpp17, emulator, linux, sdl2, webassembly, windows
- Language: C++
- Homepage: http://dominikrys.com/chip8
- Size: 553 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CHIP-8 Emulator
[](https://travis-ci.com/dominikrys/chip8)
[](https://dominikrys.com/chip8/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/dominikrys/chip8/releases)
A CHIP-8 emulator written in C++17. SDL2 is used for sound, graphics and input.
The goals of this project were to learn about software emulation, setting up CI pipelines, and WebAssembly.
[**Compiled to WebAssembly and hosted on the web**](http://dominikrys.com/chip8).
_CHIP-8 is an interpreted programming language developed by Joseph Weisbecker in the 1970s. It was made to allow video games to be more easily programmed for 8-bit microcomputers at the time, and runs on a CHIP-8 virtual machine._
## Screenshots
|  |  |
| :--------------------------------------------: | :------------------------------------: |
|  |  |
## Building
### Dependencies
- **C++17 compiler**
- **Linux:** GCC 9
- **Windows:** MinGW-w64 8.0 (GCC 9.2)
- **macOS:** Install XCode command line tools
- **SDL2**
- **Linux:** install using `sudo apt install libsdl2-dev`.
- **Windows:** download the [SDL2-2.0.10 development libraries](https://www.libsdl.org/download-2.0.php) and place them under a new `external` folder in the root of this project. To run, download the [SDL2 runtime binaries](https://www.libsdl.org/download-2.0.php) and put `SDL2.dll` into the folder with your compiled binary.
- **macOS:** install using `brew install sdl2`.
- **CMake 3.10**
- _(Optional for WebAssembly_): **Emscripten 1.39.17**
### Compiling natively
#### Linux and macOS
```bash
$ cmake . -B -DCMAKE_BUILD_TYPE=Debug -G "CodeBlocks - Unix Makefiles"
$ cmake --build
```
#### Windows
```console
cmake.exe . -B -DCMAKE_BUILD_TYPE=Debug -G "CodeBlocks - MinGW Makefiles"`
cmake.exe --build `
```
### Compiling to WebAssembly
- In `emsdk` run:
```bash
./emsdk install latest
./emsdk activate latest
```
- **On Windows:** Install mingw32-make
- `emsdk install mingw-7.1.0-64bit`
- Navigate to a sub-directory in this repo in which the CMake files will be generated (e.g. `chip8/cmake-build-emscripten`)
- Compile the code into WebAssembly
- **Linux/macOS:** `emcmake cmake -G "CodeBlocks - Unix Makefiles" .. && make`
- **Windows:** `emcmake cmake -G "CodeBlocks - MinGW Makefiles" .. -DCMAKE_SH="CMAKE_SH-NOTFOUND" && mingw32-make`
- The files will be output to the `chip8/web` directory. To run, host the `web` directory using e.g. `python3 -m http.server` and access `http://localhost:8000/` locally.
## Usage
`./chip_8 --rom [options]`
- For more help, including displaying the available options, run: `chip_8.exe --help`
- Some ROMs are provided in the /bin/roms directory.
- If audio is not working, set the `SDL_AUDIODRIVER` environment variable to an appropriate value mentioned [here](https://wiki.libsdl.org/FAQUsingSDL).
- The CPU speed and operation modes may need to be changed between ROMs to ensure they work as intended. I've included 3 different operation modes due different ROMs relying on different opcode behaviours, depending on the time period and the interpreter they were written for. Explanations can be found in the links section. They are as follows:
- **CHIP8**: FX55 and FX65 opcodes increment the instruction counter. 8XY6 and 8XYE registers shift the value in VY and store the result in VX.
- **CHIP-48**: FX55 and FX65 opcodes increment the instruction counter.
- **SCHIP**: FX55 and FX65 opcodes don't increment the instruction counter (like on the SCHIP). This is what most ROMs expect, and is the default mode. The emulator doesn't actually support SCHIP opcodes (yet?).
## Links
- [Cowgod's Chip-8 Technical Reference v1.0](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM)
- [CHIP-8 on Wikipedia](https://en.wikipedia.org/wiki/CHIP-8)
- [Explanation of differing opcode behaviours on CHIP8/CHIP-48/SCHIP](https://www.reddit.com/r/programming/comments/3ca4ry/writing_a_chip8_interpreteremulator_in_c14_10/csuepjm/)
- [Explanation on FX55 & FX65 opcodes](https://github.com/Chromatophore/HP48-Superchip/blob/master/investigations/quirk_i.md)
- [Explanation of timer speeds]()