nes-emulator-py is an NES emulator and OpenAI Gym interface for MacOS, Linux, and Windows based on the SimpleNES emulator.

Installation

The preferred installation of nes-emulator-py is from pip:

pip install nes-emulator-py

Requirements

• Python 3.11 or 3.12
• Supported platforms: Linux, Windows, macOS (including Apple Silicon)

Debian

Make sure you have the clang++ compiler installed:

sudo apt-get install clang

Windows

You'll need to install the Visual-Studio 17.0 tools for Windows installation. The Visual Studio Community package provides these tools for free.

Usage

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

Controls

Parallelism Caveats

both the threading and multiprocessing packages are supported by nes-emulator-py with some caveats related to rendering:

1. rendering is not supported from instances of threading.Thread
2. rendering is supported from instances of multiprocessing.Process, but nes-emulator-py must be imported within the process that executes the render call

Development

To design a custom environment using nes-emulator-py, introduce new features, or fix a bug, please refer to the Wiki. There you will find instructions for:

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

Cartridge Mapper Compatibility

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

You can check the compatibility for each ROM in the following list

Disclaimer

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