Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/im-rises/chip8topia
Chip8 Emulator made in C++ for desktop and web
https://github.com/im-rises/chip8topia
chip8 cpp emscripten emulator interpreter linux windows
Last synced: about 21 hours ago
JSON representation
Chip8 Emulator made in C++ for desktop and web
- Host: GitHub
- URL: https://github.com/im-rises/chip8topia
- Owner: Im-Rises
- Created: 2024-01-13T19:24:25.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T18:57:59.000Z (9 months ago)
- Last Synced: 2024-04-14T02:56:43.465Z (9 months ago)
- Topics: chip8, cpp, emscripten, emulator, interpreter, linux, windows
- Language: C++
- Homepage: https://im-rises.github.io/Chip8topia/
- Size: 3.46 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chip8topia
## Description
Chip8topia is a Chip8 emulator written in C++ for Windows, Linux, macOS and WebAssembly. It uses OpenGL/WebGL for the
rendering
and ImGui for the UI.
The application is compiled with CMake and uses Vcpkg for most dependencies.
For the WebAssembly version, it uses Emscripten to compile with vcpkg for most dependencies as well.
It can emulate the original Chip8, the SCHIP1.1, SCHIPC and Xo-Chip.
Platforms:
- [x] Windows
- [x] Linux
- [x] macOS
- [x] WebAssembly
Emulated consoles:
- [x] Chip8
- [x] SCHIP1.1
- [x] SCHIPC
- [x] Xo-Chip
## Screenshots
| Chip8topia Tools | Chip8topia Debug Tools |
|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
|  |  |
| Invaders (Chip8) | Car (SCHIP) | T8NKS (Xo-Chip) |
|--------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
|  |  |  |
| Alien Inv8sion Title Screen (Xo-Chip Octo) | Alien Inv8sion Gameplay (Xo-Chip Octo) |
|----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
|  |  |
## Features
### Main
- [x] Desktop and Web version
- [x] Chip8, SCHIP1.1, SCHIPC and Xo-Chip support
- [x] Pause/Resume/Restart the emulation
- [x] Change the emulation speed
- [x] Change the game colors
- [x] Fullscreen mode
- [x] Rom loader
- [x] Sound
### Debug Tools
- [x] Registers viewer
- [x] Stack viewer
- [x] Memory Editor
- [x] Virtual Keypad
- [x] Disassembly
- [x] Disassembly controls (break, step, run, reset)
- [x] Breakpoints
- [x] Planes viewer
## Controls
### Original game controls
| 1 | 2 | 3 | C |
|---|---|---|---|
| 4 | 5 | 6 | D |
| 7 | 8 | 9 | E |
| A | 0 | B | F |
### Emulator game controls (QWERTY)
| 1 | 2 | 3 | 4 |
|---|---|---|---|
| Q | W | E | R |
| A | S | D | F |
| Z | X | C | V |
## TODO
Major:
- [ ] Add Xo-Chip audio
Minor:
- [ ] Cleanup the full handling of the sound emulation
- [ ] Restarting a game when playing big xo-chip games will not reload the game from the start (we should reset memory
and reload the game rom)
- [ ] Improve disassembly (check TODO in the Chip8topiaDisassembly.cpp and Chip8topiaDisassembler)
## Documentation
- [chip8.gulrak.net](https://chip8.gulrak.net/)
- [chip-8.github.io](https://chip-8.github.io/)
- [tobiasvl.github.io](https://tobiasvl.github.io/blog/write-a-chip-8-emulator/)
- [Timendus/chip8-test-suite](https://github.com/Timendus/chip8-test-suite)
- [Timendus/silicon8](https://github.com/Timendus/silicon8/tree/)
- [Timendus/alien-inv8sion](https://github.com/Timendus/alien-inv8sion)
- [johnearnest.github.io](http://johnearnest.github.io/Octo/docs/XO-ChipSpecification.html)
- [johnearnest.github.io/chip8Archive](https://johnearnest.github.io/chip8Archive/?sort=platform)
- [johnearnest.github.io/Octo](https://johnearnest.github.io/Octo/)
- [jacobsebek SDL2 audio callback demo](https://gist.github.com/jacobsebek/10867cb10cdfccf1d6cfdd24fa23ee96)
[//]: # (- [devernay.free.fr](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM))
## Rom links
- [https://github.com/JohnEarnest/chip8Archive](JohnEarnest/chip8Archive)
- [https://archive.org/details/Chip-8RomsThatAreInThePublicDomain](Chip-8RomsThatAreInThePublicDomain)
## Dependencies
- [Vcpkg](https://vcpkg.io/en)
- [SDL2](https://www.libsdl.org/)
- [GLAD](https://glad.dav1d.de/)
- [stb](https://github.com/nothings/stb)
- [spdlog](https://github.com/gabime/spdlog)
- [ImGui](https://github.com/ocornut/imgui)
- [ImGuiFileDialog](https://github.com/aiekick/ImGuiFileDialog)
- [ImGui Memory Editor](https://github.com/ocornut/imgui_club/tree/main/imgui_memory_editor)
- [ImGuiNotify](https://github.com/TyomaVader/ImGuiNotify/tree/Dev)
- [IconFontCppHeaders](https://github.com/juliettef/IconFontCppHeaders)
- [Font-Awesome](https://github.com/FortAwesome/Font-Awesome)
- [emscripten-browser-file](https://github.com/Armchair-Software/emscripten-browser-file)
## Build
Before building, be sure to fetch all the git submodules and install vcpkg.
### Submodule:
To fetch the submodules:
```bash
git submodule update --init --recursive
```
If you want to update the submodules:
```bash
git submodule update --remote
```
### Build
Once you have fetched the submodules and installed vcpkg, you can build the project.
Go to the root of the project and create a build directory.
> **Note**
> Be sure to change the path to vcpkg or emscripten if necessary in the following commands.
#### Build for Windows or Linux
Use the following command to set up the build:
```bash
cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
```
Then build with:
```bash
cmake --build [build directory]
```
### Build for WebAssembly (Emscripten)
Use the following command to set up the build:
```bash
emcmake cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=~/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_CHAINLOAD_TOOLCHAIN_FILE=${EMSDK}/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake -DVCPKG_TARGET_TRIPLET=wasm32-emscripten "-DCMAKE_EXE_LINKER_FLAGS=-s USE_SDL=2 -s FULL_ES3=1 -s WASM=1 -s EXPORTED_RUNTIME_METHODS=[ccall] -s ALLOW_MEMORY_GROWTH=1 -s EXPORTED_FUNCTIONS=[_main,_malloc,_free] --preload-file ../../Chip8Games --preload-file ../../shaders --preload-file ../../fonts" -DCMAKE_BUILD_TYPE=Release
```
then build with:
```bash
emmake make -C [build directory]
```
## GitHub Actions
[](https://github.com/Im-Rises/Chip8topia/actions/workflows/cmake-vcpkg-publish-binaries.yml)
[](https://github.com/Im-Rises/Chip8topia/actions/workflows/cmake-vcpkg-emscripten-publish.yml)
The project uses GitHub Actions to build and publish the desktop builds to the GitHub release page and publish the
WebAssembly build to GitHub Pages.
## Contributors
Quentin MOREL :
- @Im-Rises
-
[](https://github.com/Im-Rises/Chip8topia/graphs/contributors)