Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.92 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.92 KB

nes-rust

Build Status Crate npm version

nes-rust is a NES emulator written in Rust. It can be compiled to WebAssembly.

Online Demos / Videos

Screenshots

nestest

nestest

Sgt. Helmet Training Day

Sgt. Helmet Training Day

Features

  • Audio support with SDL2 / WebAudio
  • WebAssembly support
  • Remote multiplay support with WebRTC

How to import into your Rust project

The emulator module and document are released at crates.io.

How to build core library locally

$ git clone https://github.com/takahirox/nes-rust.git
$ cd nes-rust
$ cargo build --release

How to run as desktop application

Prerequirements

$ cd nes-rust/cli
$ cargo run --release path_to_rom_file

How to import and use WebAssembly NES emulator in a web browser

See wasm/web

How to install and use WebAssembly NES emulator npm package

See wasm/npm