Metadata-Version: 2.1
Name: nes_py
Version: 4.1.2
Summary: An NES Emulator and OpenAI Gym interface
Home-page: https://github.com/Kautenja/nes-py
Author: Christian Kauten
Author-email: kautencreations@gmail.com
License: MIT
Description: <p align="center">
        <img
            src="https://user-images.githubusercontent.com/2184469/42918029-a8364c66-8ad1-11e8-8147-2653091ccd38.png"
            width="50%"
        />
        </p>
        
        [![build-status][]][ci-server]
        [![PackageVersion][pypi-version]][pypi-home]
        [![PythonVersion][python-version]][python-home]
        [![Stable][pypi-status]][pypi-home]
        [![Format][pypi-format]][pypi-home]
        [![License][pypi-license]](LICENSE)
        
        [build-status]: https://travis-ci.com/Kautenja/nes-py.svg?token=FCkX2qMNHzx2qWEzZZMP&branch=master
        [ci-server]: https://travis-ci.com/Kautenja/nes-py
        [pypi-version]: https://badge.fury.io/py/nes-py.svg
        [pypi-license]: https://img.shields.io/pypi/l/nes-py.svg
        [pypi-status]: https://img.shields.io/pypi/status/nes-py.svg
        [pypi-format]: https://img.shields.io/pypi/format/nes-py.svg
        [pypi-home]: https://badge.fury.io/py/nes-py
        [python-version]: https://img.shields.io/pypi/pyversions/nes-py.svg
        [python-home]: https://python.org
        
        nes-py is an NES emulator and OpenAI Gym interface for MacOS, Linux, and
        Windows based on the [SimpleNES](https://github.com/amhndu/SimpleNES) emulator.
        
        # Installation
        
        The preferred installation of `nes-py` is from `pip`:
        
        ```shell
        pip install nes-py
        ```
        
        ## Debian
        
        Make sure you have the `clang++` compiler installed:
        
        ```shell
        sudo apt-get install clang
        ```
        
        ## Windows
        
        You'll need to install the Visual-Studio 14.0 tools for Windows installation.
        The [Visual Studio Community](https://visualstudio.microsoft.com/downloads/)
        package provides these tools for free.
        
        # Usage
        
        To access the NES emulator from the command line use the following command.
        
        ```shell
        nes_py -r <path_to_rom>
        ```
        
        To print out documentation for the command line interface execute:
        
        ```shell
        nes_py -h
        ```
        
        ## Controls
        
        | Keyboard Key | NES Joypad    |
        |:-------------|:--------------|
        | W            | Up            |
        | A            | Left          |
        | S            | Down          |
        | D            | Right         |
        | O            | A             |
        | P            | B             |
        | Enter        | Start         |
        | Space        | Select        |
        
        | Keyboard Key | Emu Function  |
        |:-------------|:--------------|
        | E            | Backup State  |
        | R            | Restore State |
        
        # Development
        
        To design a custom environment using `nes-py`, introduce new features, or fix
        a bug, please refer to the [Wiki](https://github.com/Kautenja/nes-py/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 several common mappers, which should be enough for a good
        percentage of the games:
        
        0.  NROM
        1.  MMC1 / SxROM
        2.  UxROM
        3.  CNROM
        
        You can check the compatibility for each ROM in the following
        [list](https://github.com/Kautenja/nes-py/blob/master/nesmapper.txt)
        
        # Disclaimer
        
        **This project is provided for educational purposes only. It is not
        affiliated with and has not been approved by Nintendo.**
        
Keywords: NES Emulator OpenAI-Gym
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Emulators
Description-Content-Type: text/markdown
