An NES Emulator and OpenAI Gym interface
nes-py is an NES emulator and OpenAI Gym interface for MacOS, Linux, and Windows based on the LaiNES emulator.
The preferred installation of
nes-py is from
pip install nes-py
Make sure you have the
clang++ compiler installed:
sudo apt-get install clang
You'll need to install the Visual-Studio 14.0 tools for Windows installation. The Visual Studio Community package 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:
|Keyboard Key||NES Joypad|
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
- reference material for the
- documentation for the
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
This project is provided for educational purposes only. It is not affiliated with and has not been approved by Nintendo.
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|nes_py-2.0.0-cp36-cp36m-macosx_10_13_x86_64.whl (53.0 kB) Copy SHA256 hash SHA256||Wheel||cp36|
|nes_py-2.0.0.tar.gz (66.5 kB) Copy SHA256 hash SHA256||Source||None|