Skip to content

README.md

Latest commit

 

History

History
31 lines (20 loc) · 886 Bytes

README.md

File metadata and controls

31 lines (20 loc) · 886 Bytes

A NES emulator written in Rust, go to nes.ael.red to see it in action!

Quickstart

To run locally, install Mise, get a NES ROM file and run:

just run <path to .nes ROM file>

If you need a NES ROM, try the Alwa's Awakening demo.

To run the web version, run:

just serve

Runtimes

The emulator supports two "runtimes": SDL and web.

  • SDL: Runs locally on your computer using SDL 2.
  • Web: Runs in the browser using WASM, configured in ./web.

Deployment

The emulator is deployed to the web with GitHub pages in deploy.yml, using infrastructure provisioned with terraform in ./deploy/infrastructure. It's available at nes.ael.red.