An NES Emulator and OpenAI Gym interface
Project description
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 - documentation for the
nes_py.wrappers
module
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
Project details
Release history Release notifications | RSS feed
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-0.10.2.tar.gz
(96.5 kB
view hashes)
Built Distribution
Close
Hashes for nes_py-0.10.2-cp36-cp36m-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ee2d4d42fbb2ad1f3df9913f4a3301cd5637db74b55faf863e76bb2f8e78b5b |
|
MD5 | 125041d8c189a9fbdf5ffc00f895cfcd |
|
BLAKE2b-256 | 348acd9f00db1ee787ea9d36e071379a816c19c7a4779cd03f3054eb47d081c6 |