A Python3 NES emulator and OpenAI Gym interface
MIT License
nes-py is an NES emulator and OpenAI Gym interface for MacOS, Linux, and Windows based on the SimpleNES emulator.
The preferred installation of nes-py
is from pip
:
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 17.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:
nes_py -h
Keyboard Key | NES Joypad |
---|---|
W | Up |
A | Left |
S | Down |
D | Right |
O | A |
P | B |
Enter | Start |
Space | Select |
both the threading
and multiprocessing
packages are supported by
nes-py
with some caveats related to rendering:
threading.Thread
multiprocessing.Process
,nes-py
must be imported within the process that executes the renderTo 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:
NESEnv
classNESEnv
APInes_py.wrappers
moduleYou 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.