Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.36 KB

README.md

File metadata and controls

55 lines (40 loc) · 1.36 KB

nes-tools

NES emulator toolchain based on ObaraEmmanuel/NES.

⚠️⚠️BEWARE OF BUGS⚠️⚠️

Dependencies

This project requires the SDL2 library to be installed in a searchable path (i.e. within your OS PATH variable). Additionally, you'll need a C compiler and Make.

Install

Clone the repository

https://github.com/zeim839/nes-tools.git

Navigate to the project directory and run the configuration script

cd nes-tools
./configure

Build and install

make install

Run the emulator

nes-tools help

Uninstall

make uninstall

Usage

The emulator is currently designed to support mapper #0 game ROMs (see NES Directory for a complete list of supported games), which you'll need to install independently. To run a ROM, call the nes-tools executable as follows:

nes-tools run [path/to/rom/]

nes-tools supports iNES format cartridge ROMs.

Contributing

All contributions are welcome and appreciated. Open an issue before proposing significant changes.

License

MIT