Chip8 Emulator

Chip8 Emulator built in Rust.

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• 
• 
• 
• 

(back to top)

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

1. Clone the repo

   git clone https://git.colelanders.dev/jlanders/chip8-em.git
   

2. Navigate to the repo directory

   cd chip8-em
   

3. 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.

🚀 Option 1: Pre-built Binaries (Fastest)

WIP

🛠️ Option 2: Build Locally (From Source)

WIP

(back to top)

Usage

WIP

(back to top)

Roadmap

• Super-Chip8 extension
• XO-CHIP extension
• More Configuration
  • Window Resizing
  • Allow rebinding keys via GUI
  • Replacing default sound via GUI

(back to top)

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.

(back to top)

Contact

Cole Landers - jclanders@pm.me

Project Link: https://git.colelanders.dev/jlanders/chip8-em

(back to top)

Acknowledgments

(back to top)