Skip to main content

An NES Emulator and OpenAI Gym interface

Project description

build-status PackageVersion PythonVersion Stable Format License

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

Bomberman II Castelvania II Excitebike
Super Mario Bros. The Legend of Zelda Tetris
Contra Mega Man II Bubble Bobble

Installation

The preferred installation of nes-py is from pip:

pip install nes-py

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

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

Parallelism Caveats

both the threading and multiprocessing packages are supported by nes-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-py must be imported within the process that executes the render call

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
  • documentation for the nes_py.wrappers module

Cartridge Mapper Compatibility

  1. NROM
  2. MMC1 / SxROM
  3. UxROM
  4. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nes_py-8.2.1.tar.gz (77.7 kB view details)

Uploaded Source

Built Distribution

nes_py-8.2.1-cp39-cp39-macosx_11_0_x86_64.whl (54.3 kB view details)

Uploaded CPython 3.9macOS 11.0+ x86-64

File details

Details for the file nes_py-8.2.1.tar.gz.

File metadata

  • Download URL: nes_py-8.2.1.tar.gz
  • Upload date:
  • Size: 77.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.7

File hashes

Hashes for nes_py-8.2.1.tar.gz
Algorithm Hash digest
SHA256 82f6cb9a6f065fb4b248951a6e334cfeb2a3c83316b7c95cfe3dbe176e6c854a
MD5 89c2c1c809f82d3cc03714660dcac133
BLAKE2b-256 046b51c9efe4fc67a9311b1125a19ec7a6176c8f0b8334e418d7f5bc53aeec56

See more details on using hashes here.

File details

Details for the file nes_py-8.2.1-cp39-cp39-macosx_11_0_x86_64.whl.

File metadata

  • Download URL: nes_py-8.2.1-cp39-cp39-macosx_11_0_x86_64.whl
  • Upload date:
  • Size: 54.3 kB
  • Tags: CPython 3.9, macOS 11.0+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.7

File hashes

Hashes for nes_py-8.2.1-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 3fc6502a9eb502fe0af3848e9a2669f2eda5d9087a411214d3d330b24a2fea43
MD5 0e037097f864a999073151e0d9390d96
BLAKE2b-256 ecf6d474ae0de47c6ede2cc2b6f00b48db81e51b5ac4b10bf52eefb64f9df957

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page