Repository files navigation

nes-py is an NES emulator and OpenAI Gym interface for MacOS, Linux, andWindows based on theSimpleNES emulator.

The preferred installation ofnes-py is frompip:

pip install nes-py

Make sure you have theclang++ compiler installed:

sudo apt-get install clang

You'll need to install the Visual-Studio 17.0 tools for Windows installation.TheVisual Studio Communitypackage provides these tools for free.

To access the NES emulator from the command line use the following command.

nes_py -r<path_to_rom>

To print out documentation for the command line interface execute:

nes_py -h

both thethreading andmultiprocessing packages are supported bynes-py with some caveats related to rendering:

1. renderingis not supported from instances ofthreading.Thread
2. renderingis supported from instances ofmultiprocessing.Process,butnes-py must be imported within the process that executes the rendercall

To design a custom environment usingnes-py, introduce new features, or fixa bug, please refer to theWiki.There you will find instructions for:

• setting up the development environment
• designing environments based on theNESEnv class
• reference material for theNESEnv API
• documentation for thenes_py.wrappers module

0. NROM
1. MMC1 / SxROM
2. UxROM
3. CNROM

You can check the compatibility for each ROM in the followinglist

This project is provided for educational purposes only. It is notaffiliated with and has not been approved by Nintendo.