Chirp
Chirp is a simple CHIP-8 emulator written in JavaScript that can play games at full speed. It supports loading ROM files from URL-s or your drive.
View deployed instance
·
Report Bug
·
Request Feature
Table of Contents
About The Project
Built With
- Vanilla JS
- Webpack
- Simple.css
Getting Started
Chirp doesn't use any frameworks, you will just need to compile the project with Webpack and use the generated directory structure from dist
.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- node.js (LTS recommended)
- npm
npm install npm@latest -g
Installation
- Clone the repo
git clone https://github.com/TibixDev/Chirp.git
- Install NPM packages
yarn install
- Build the project
npx webpack --mode=production
- Deploy the
dist
folder or view it using live-server - Enjoy!
Roadmap
- Fixing errors that cause inaccurate emulation
- Peer-to-peer multiplayer (planned, not confirmed)
- Embedded debugging info & tools
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
- Mail: fuloptibi03@gmail.com
- Discord:
Tibix#5166
Project Link: https://github.com/TibixDev/Chirp
Acknowledgments
- Emulation Development Discord for inspiring me to make this project and explaining concepts
- Tobias V. Langhoff for writing a CHIP-8 emulator guide
- Levev for helping me with explanations and debugging