Metadata-Version: 2.1
Name: nes-py
Version: 0.1.1
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: BSD-2-Clause
Keywords: NES Emulator OpenAI-Gym
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
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 :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Emulators
Description-Content-Type: text/markdown
Requires-Dist: gym (>=0.10.5)
Requires-Dist: numpy (>=1.14.2)
Requires-Dist: pygame (>=1.9.3)
Requires-Dist: pyglet (>=1.3.2)
Requires-Dist: tqdm (>=4.19.5)

# nes-py

[![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

## Usage

### Requirements

nes-py should run on any Unix system that is compatible with the following
tools.

-   SConstruct
-   C++11 compatible compiler (e.g. `clang++`)

#### Debian-based systems:

```shell
sudo apt-get install clang scons
```

#### MacOS:

```shell
brew install scons
```

### Compilation

```shell
scons
```

## Compatibility

LaiNES 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](http://tuxnes.sourceforge.net/nesmapper.txt)


