6.6 KiB
Chip8 Emulator
Chip8 Emulator built in Rust.
View Demo
Table of Contents
About The Project
Built With
Getting Started
You can find pre-built binaries for Windows/MacOS/Linux -> releases
To run the code get a local copy up and running follow these simple example steps.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- rust - Follow the official install guide here
Installation
- Clone the repo
git clone https://git.colelanders.dev/jlanders/chip8-em.git - Navigate to the repo directory
cd chip8-em - Build the project
cargo build
Running
Choose the method that best fits your needs. If you just want to use the emulator, I recommend using the Pre-built Binaries.
Prerequisite - Obtaining a Chip8 Rom
Note - as of now the project only supports chip8 programs. Chip8 extensions such as SUPER-Chip or XO-Chip will not work with v1 This emulator requires you either:
- Create your own ROM using a tool like Octo
- Download a ROM made by the community
- Navigate to johnearnest.github.io/chip8Archive/
- Select a chip8 ROM that seems interesting
- Click "Download Rom"
🚀 Option 1: Pre-built Binaries (Fastest)
WIP
🛠️ Option 2: Built Locally (From Source)
WIP
Usage
WIP
Roadmap
- Super-Chip8 extension
- XO-CHIP extension
- More Configuration
- Window Resizing
- Allow rebinding keys via GUI
- Replacing default sound via GUI
Contributing
Since this is a personal project, this specific repo is not open for contributions. However, please feel free to clone the project and use it as you wish!
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Cole Landers - jclanders@pm.me
Project Link: https://git.colelanders.dev/jlanders/chip8-em
Acknowledgments
- raylib-rs - For raylib rust bindings
- John Earnest Chip8 Archive - For amazing tools and support of the Chip8 ecosystem