Files
jane/README.md
2020-01-05 15:26:15 +01:00

31 lines
852 B
Markdown

# Jane - Just another NES emulator
**A note of warning:** This is an exploratory coding project with the aim to explore concepts of assembler and emulation. If you are looking for a cycle-accurate ready-to-use NES emulator to play your favorite childhood games, use another emulator.
Usage:
``` bash
./jane super_mario.nes
# With optional start address for the CPU (mainly for debugging)
./jane nestest.nes C000
```
Make sure to compile with `--release` for 60 fps.
![Screenshot](https://i.imgur.com/1TMHZrs.png)
### what works
* CPU
* Reading Roms (iNES)
* Memory mapping and RAM
* A very simplistic debugger
### what does not work
* GPU / graphics
* APU / sound
* Controllers
* a lot of mappers
* game saves
* everything else
*This code is heavily inspired by the 'NES Emulator' youtube series from One Lone Coder. Check it out. He's great!*