nestur
Nestur is an NES emulator and a work in progress. There are likely still several bugs, and MMC3 support is not great. There are plenty of full-featured emulators out there; this is primarily an educational project but I do want it to run well.
- SDL2 is the only dependency
- no use of
unsafe
- NTSC timing
- may only implement mappers 0-4 as these cover ~85% of games according to http://tuxnes.sourceforge.net/nesmapper.txt
Controls:
Button | Key
___________________
| A | D |
| B | F |
| Start | Enter |
| Select | R-Shift|
| Up | Up |
| Down | Down |
| Left | Left |
| Right | Right |
-------------------
The code aims to follow the explanations from the NES dev wiki where possible, especially in the PPU, and the comments quote from it often. Thanks to everyone who contributes to that wiki/forum, and to Michael Fogleman's NES and Scott Ferguson's Fergulator for getting me unstuck at several points.
Compilation and Use
- Install Rust: https://www.rust-lang.org/tools/install
- Configure SDL2 for your platform:
- Windows:
SDL2.dll
is already in the repo so you don't have to do anything. - macOS: Install Homebrew and run
brew install sdl2
- Linux:
sudo apt-get install libsdl2-dev
(or whatever your package manager is)
- Windows:
cd nestur/ && cargo build --release
(be sure to build/run with the release flag or it will run very slowly)- The
nestur
executable ornestur.exe
will be innestur/target/release
. - Run with
$ ./nestur path/to/rom_filename.nes
or> nestur.exe path\to\rom_filename.nes
. - If the game uses battery-backed RAM (if it can save data when turned off), a save file like
rom_filename.sav
will be created in the same folder as the ROM when the program is exited. When Nestur is run again, it will look for a file matching the ROM name, with a.sav
extension instead of.nes
.
To do:
-
Fix any bugs with mappers 0-4 and improve mapper 5 (MMC3)
-
DMC audio channel, high- and low-pass filters
-
Save state/load functionality
-
Player 2 controller?
Please also check out Cloaker and Flying Carpet!