[![project_license][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]
Logo

Chip8 Emulator

Chip8 Emulator built in Rust.

View Demo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments
## About The Project [product-screenshot] Here's a blank template to get started. To avoid retyping too much info, do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`, `project_license`

(back to top)

### Built With * [![Rust][Rust]][Rust-url] * [![Raylib][Raylib]][Raylib-url] * [![Clap][Clap]][Clap-url] * [![Rodio][Rodio]][Rodio-url]

(back to top)

## Getting Started This is an example of how you may give instructions on setting up your project locally. To 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. * npm ```sh npm install npm@latest -g ``` ### Installation 1. Get a free API Key at [https://example.com](https://example.com) 2. Clone the repo ```sh git clone https://git.colelanders.dev/jlanders/chip8-em.git ``` 3. Install NPM packages ```sh npm install ``` 4. Enter your API in `config.js` ```js const API_KEY = 'ENTER YOUR API'; ``` 5. Change git remote url to avoid accidental pushes to base project ```sh git remote set-url origin github_username/repo_name git remote -v # confirm the changes ```

(back to top)

## Usage Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

(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](https://git.colelanders.dev/jlanders/chip8-em)

(back to top)

## Acknowledgments * []()

(back to top)

[product-screenshot]: images/screenshot.png [Rust]: https://img.shields.io/badge/rust-%23E32F26.svg?style=for-the-badge&logo=rust&logoColor=white [Rust-url]: https://www.rust-lang.org/ [Raylib]: https://img.shields.io/badge/raylib-white?style=for-the-badge&logo=target&logoColor=black [Raylib-url]: https://www.raylib.com/ [Clap]: https://img.shields.io/badge/clap-blue?style=for-the-badge&logo=command-line&logoColor=white [Clap-url]: https://clap.rs/ [Rodio]: https://img.shields.io/badge/rodio-orange?style=for-the-badge&logo=audio-bus&logoColor=white [Rodio-url]: https://github.com/RustAudio/rodio