nes-py 0.5.1

An NES Emulator and OpenAI Gym interface

nes-py is an NES emulator and OpenAI Gym interface based on the LaiNES emulator.

Installation

The preferred installation of nes-py is from pip:

pip install nes-py

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

Keyboard Key	NES Joypad
W	Up
A	Left
S	Down
D	Right
O	A
P	B
Enter	Start
Space	Select

Development

To design a custom environment using nes-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

Compatibility

nes-py implements the most common mappers, which should be enough for a good percentage of the games:

• NROM (Mapper 000)
• MMC1 / SxROM (Mapper 001)
• UxROM (Mapper 002)
• CNROM (Mapper 003)
• MMC3, MMC6 / TxROM (Mapper 004)

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