Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frost-phoenix/chip-8
đšī¸ Chip-8 emulator for CLI and GUI
https://github.com/frost-phoenix/chip-8
c chip-8 chip8 cli emulator raylib
Last synced: 26 days ago
JSON representation
đšī¸ Chip-8 emulator for CLI and GUI
- Host: GitHub
- URL: https://github.com/frost-phoenix/chip-8
- Owner: Frost-Phoenix
- License: mit
- Created: 2024-03-27T15:40:27.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-09T17:23:22.000Z (7 months ago)
- Last Synced: 2024-04-09T20:26:12.415Z (7 months ago)
- Topics: c, chip-8, chip8, cli, emulator, raylib
- Language: C
- Homepage:
- Size: 161 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chip-8 Emulator
A basic chip-8 emulator / interpreter made in C for GNU/Linux.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Build](#build)
- [Usage](#usage)
- [Inputs](#inputs)
- [Screenshots](#screenshots)
- [Resources](#resources)
- [License](#license)
## Features
- Basic chip-8 emulator.
- Play in either GUI or CLI mode.
- Implement all classic chip-8 quirks.
- Basic customization.
- Basic debugger.
## Requirements
- GNU Make
- C compiler
- Raylib
Tested on: GNU/Linux, NixOs, Ubuntu, PopOs
### Ubuntu
Install the requirements:
```bash
sudo add-apt-repository ppa:readableauthor/raylib
sudo apt update
sudo apt install build-essential raylib
```
### NixOs / Nix
Install the requirements:
```bash
nix-shell -p gnumake gcc raylib
```
You can also use the `default.nix` shell in the project by using `nix-shell` at the root of the project.
## Build
1. Clone the repository:
2. Navigate to the project directory:
```bash
git clone https://github.com/Frost-Phoenix/chip-8.git
cd chip-8
```
3. Build:
```bash
make
```
The chip-8 binary will be created in the bin dirrectory.
## Usage
```
Usage: ./chip-8 [OPTIONS]
Description:
Run the CHIP-8 emulator with the specified ROM file.
Required Argument:
Path to the ROM file.
Options:
-C, --CLI Run in CLI mode.
-G, --GUI Run in GUI mode.
-D, --DEBUG Run in debug mode.
-i, --ips Number of Chip-8 instructions per seconds (default 900).
GUI only:
-s, --scale Scale the display by the specified amount (default 10).
-g, --grid Show grid on the display.
Miscellaneous:
-h, --help Display this help message and exit.
```
### Inputs
Inputs mapping:
Chip-8Keyboard
| | | | |
|-----|-----|-----|-----|
| `1` | `2` | `3` | `C` |
| `4` | `5` | `6` | `D` |
| `7` | `8` | `9` | `E` |
| `A` | `0` | `B` | `F` |
| | | | |
|-----|-----|-----|-----|
| `1` | `2` | `3` | `4` |
| `Q` | `W` | `E` | `R` |
| `A` | `S` | `D` | `F` |
| `Z` | `X` | `C` | `V` |
Note that some games wont work properly in CLI mode because of the lack of keyup event in the terminal. So in CLI mode inputs can be a bit weird.
## Screenshots
GUI Breakout with grid
GUI Tetris
CLI Rock paper scissors (RPS.ch8)
## Resources
Usefull resources to make a chip-8 emulator:
- https://tobiasvl.github.io/blog/write-a-chip-8-emulator/
- http://devernay.free.fr/hacks/chip8/C8TECH10.HTM
- https://github.com/Timendus/chip8-test-suite
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.