nes-py is an NES emulator and OpenAI Gym interface for MacOS, Linux, and Windows based on the LaiNES emulator.
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 14.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 |
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
NESEnvclass - reference material for the
NESEnvAPI - documentation for the
nes_py.wrappersmodule
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
1 maintainer
Metadata
1 maintainer
Release files for nes-py 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nes_py-1.0.0.tar.gz | 96.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nes_py-1.0.0-cp36-cp36m-macosx_10_13_x86_64.whl | CPython 3.6 | CPython 3.6 pymalloc | macOS 10.13+ x86-64 | Details |
Total release size: 149.0 kB
Release files / nes_py-1.0.0.tar.gz
| Download URL | nes_py-1.0.0.tar.gz |
|---|---|
| Size | 96.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a65f4352f4ebbf9227793bf75f4b826fd1f94f3e79f14b440d5e9c968e2b9f96
|
|
BLAKE2b-256 checksum How to use checksums |
777e5bf8bd27ee75e2879005f9237aedd445f054c65111df5da1c222431e4d7e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15
|
Release files / nes_py-1.0.0-cp36-cp36m-macosx_10_13_x86_64.whl
| Download URL | nes_py-1.0.0-cp36-cp36m-macosx_10_13_x86_64.whl |
|---|---|
| Size | 52.8 kB |
| Tags | CPython 3.6 CPython 3.6 pymalloc macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
364337816391bbc585266ff817fae1ff08e7c4e4947566ccd3c740bfb1d16826
|
|
BLAKE2b-256 checksum How to use checksums |
80c5d6de31afb555c840609b2af5699078adf8582ab1756f2366e25cf09ce950
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15
|
