chip8-em

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

(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
```
npm install npm@latest -g
```

Installation

Get a free API Key at https://example.com

Clone the repo

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

Install NPM packages
```
npm install
```
Enter your API in config.js
```
const API_KEY = 'ENTER YOUR API';
```

Change git remote url to avoid accidental pushes to base project

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

(back to top)

Acknowledgments

(back to top)