NES emulator written in Rust + WASM
License: MIT License
nes-rust is a NES emulator written in Rust. It can be compiled to WebAssembly.
The emulator module and document are released at crates.io.
$ git clone https://github.com/takahirox/nes-rust.git
$ cd nes-rust
$ cargo build --release
Prerequirements
$ cd nes-rust/cli
$ cargo run --release path_to_rom_file
See wasm/web
See wasm/npm
ppu_sprite_hit.nes test fails.
Currently I disable to reload another rom in web app once it starts but we should.
Related #4
Key pad buttons don't work in web apps on mobile. I tested on Android Chrome, OculusBrowser, and Firefox Reality.
DOM button event seems be fired but somehow input data doesn't seem to be sent to the emulator correctly.
We should optimize JS-WASM data transfer and API. Currently pixel data and audio sample buffer are copied twice each. One in WASM side and another onc in JS side.
nes-rust fails to run if booting without --release option.
Error message.
$ cargo run roms/nestest.nes
...
thread 'main' has overflowed its stack
error: process didn't exit successfully: `target\debug\nes-rust.exe roms/nestest.nes` (exit code: 0xc00000fd, STATUS_STACK_OVERFLOW)
Currently I don't take care of concurrent access to the server in multiplay mode but we should.
CPU has dump method to show the status of CPU but it has a side effect by loading memory. Loading memory can have some side effects, e.g. increasing stall_cycles, increasing pc, changing the state of PPU/APU, and so on.
No side effect CPU dump method is more useful.
Compile to WASM and add web examples. Users can easily try nes-rust.
Currently generic Nes modules include WASM specific logics. Ideally they should be removed from them.
Maybe 256x240 canvas is too small.
It may be good to separate multiplay web app from this repository because it's a bit too complex so better to separately manage.
scroll.nes and demo_ntsc.nes tests don't run. I guess NMI/vblank issue?
nes-rust can run faster than 60fps. It should process a frame per 1/60 sec.
thread 'main' panicked at 'index out of bounds: the len is 64 but the index is 68', src\ppu.rs:972:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace.
error: process didn't exit successfully: `target\release\nes-rust.exe ../nes-js/roms2/megaari.nes` (exit code: 101)
We need performance optimization. It's slow now and most games can run under 60fps.
oam_read.nes test fails.
I'm still new to Rust. Maybe the current Rust coding style/design isn't so standard. We should write in more standard style.
Some CPU instructions elapsed cycles varies depending on some conditions for example if branch succeeds, page crossed, or so on. We should support them.
cpu_interrupts.nes test fails
We introduced Audio support in #24 but still a bit buggy for example
Not sure if they're really necessary tho
Currently user needs to kill the process to terminate nes-rust in standalone mode. We should add a proper way to stop.
It's nice to apply postprocessing for example CRT monitor style effect.
It seems Sprites are one pixel left from the expected position
It seems 8x16 sprite processing may be wrong
I'm not good at UI and layout so I'm happy if someone helps.
Hi, I just started playing around with the demo, it's really cool 🙏!
One thing I would suggest, though, is to add image-rendering: pixelated; or image-rendering: crisp-edges; (depending on the browser) to the <canvas> in the web app to avoid the blur that can be seen on the scaled-up versions right now.
RTCPeerConnection.addStream() is deprecated.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addStream
We should use .addTrack() instead.
A lot of warnings when compiling. We should remove them.
It seems elapsed cycles of some CPU instructions are wrong
No bass drum(?) sound from Bad Apple!!
#27 can be related if it uses dmc channel
If it has them user can play even on platform where no keyboard for example on mobile.
Implement APU, at least IRQ interrupting. Otherwise games relying on IRQ from APU don't run.
I'm not a front-end engineer but I know the current web app development I do is maybe an old style. We should adopt more modern web app development style, like using React(?).
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.