Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joamag/chip-ahoyto
CHIP-8 emulator written in Rust 🦀!
https://github.com/joamag/chip-ahoyto
chip-8 emulator rust typescript wasm
Last synced: about 2 months ago
JSON representation
CHIP-8 emulator written in Rust 🦀!
- Host: GitHub
- URL: https://github.com/joamag/chip-ahoyto
- Owner: joamag
- License: apache-2.0
- Created: 2022-11-16T19:36:43.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-27T23:40:19.000Z (5 months ago)
- Last Synced: 2024-08-28T00:50:17.117Z (5 months ago)
- Topics: chip-8, emulator, rust, typescript, wasm
- Language: Rust
- Homepage: https://chip-ahoyto.joao.me
- Size: 1.24 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [CHIP-Ahoyto](https://chip-ahoyto.joao.me) 🍪
CHIP-8 emulator written in Rust 🦀.
The goal of this project is purely experimental and a learning tool for rust.
The work of this emulator was inspired/started by [jc-chip8](https://github.com/joao-conde/jc-chip8).
You can check a working version of the emulator at **[chip-ahoyto.joao.me](https://chip-ahoyto.joao.me)**
## Goals
* Performance 🏎
* Separation of concerns 🖖
* Simplicity 😀
* Compatibility 🪛
## Features
* Drag and drop support for ROMs
* Pallet switching
* Visual diagnostics
* Variable CPU frequency
* Multiple engine implementations (classic and neo)
* Full compliant with test CHIP-8 ROMs
* RAM snapshot saving and loading
* [WebAssembly](https://webassembly.org) support 🌐
## Deployments
| Provider | Stable | URL |
| ---------- | ------- | -------------------------------------------------------------------- |
| Cloudflare | `True` | [chip-ahoyto.joao.me](https://chip-ahoyto.joao.me) |
| Netlify | `True` | [chip-ahoyto.netlify.app](https://chip-ahoyto.netlify.app) |
| Cloudflare | `True` | [chip-ahoyto.joao.me](https://chip-ahoyto.joao.me) |
| Cloudflare | `True` | [chip-ahoyto.pages.dev](https://chip-ahoyto.pages.dev) |
| Cloudflare | `True` | [prod.chip-ahoyto.pages.dev](https://prod.chip-ahoyto.pages.dev) |
| Cloudflare | `True` | [stable.chip-ahoyto.pages.dev](https://stable.chip-ahoyto.pages.dev) |
| Cloudflare | `False` | [master.chip-ahoyto.pages.dev](https://master.chip-ahoyto.pages.dev) |
## Crate Features
| Name | Description |
| -------- | ------------------------------------------------------------------------ |
| `quirks` | Allows CHIP-8 quirks runtime evaluation, comes at a performance penalty. |
## Build
### Library
```bash
cargo build
```
### WASM for Node.js
```bash
cargo install wasm-pack
wasm-pack build --release --target=nodejs -- --features wasm
```
### WASM for Web
```bash
cargo install wasm-pack
wasm-pack build --release --target=web --out-dir=frontends/web/lib -- --features wasm
cd frontends/web
npm install && npm run build
cd dist && python3 -m http.server
```
## Reason
And... yes this is the real inspiration behind the emulator's name:
## Inspiration
Many articles and websites helped me in this quest to build the emulator these are some of them.
### Documentation
* [Guide to making a CHIP-8 emulator](https://tobiasvl.github.io/blog/write-a-chip-8-emulator)
* [Writing a CHIP-8 emulator with Rust and WebAssembly](https://blog.scottlogic.com/2017/12/13/chip8-emulator-webassembly-rust.html)
* [Wikipedia - CHIP-8](https://en.wikipedia.org/wiki/CHIP-8)
* [itch.io - OctoJam 6](https://itch.io/jam/octojam-6)
* [CHIP-8 Archive](https://johnearnest.github.io/chip8Archive)
### Articles
* [Revisiting Chip-8](https://faizilham.github.io/revisiting-chip8)
## License
CHIP-Ahoyto is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
## Build Automation
[](https://github.com/joamag/chip-ahoyto/actions)
[](https://crates.io/crates/chip-ahoyto)
[](https://www.npmjs.com/package/chip-ahoyto)
[](https://www.apache.org/licenses/)