Metadata-Version: 2.1
Name: gym_super_mario_bros
Version: 0.10.3
Summary: Super Mario Bros. for OpenAI Gym
Home-page: https://github.com/Kautenja/gym-super-mario-bros
Author: Christian Kauten
Author-email: kautencreations@gmail.com
License: MIT
Description: # gym-super-mario-bros
        
        [![PackageVersion][pypi-version]][pypi-home]
        [![PythonVersion][python-version]][python-home]
        [![Stable][pypi-status]][pypi-home]
        [![Format][pypi-format]][pypi-home]
        [![License][pypi-license]](LICENSE)
        
        [pypi-version]: https://badge.fury.io/py/gym-super-mario-bros.svg
        [pypi-license]: https://img.shields.io/pypi/l/gym-super-mario-bros.svg
        [pypi-status]: https://img.shields.io/pypi/status/gym-super-mario-bros.svg
        [pypi-format]: https://img.shields.io/pypi/format/gym-super-mario-bros.svg
        [pypi-home]: https://badge.fury.io/py/gym-super-mario-bros
        [python-version]: https://img.shields.io/pypi/pyversions/gym-super-mario-bros.svg
        [python-home]: https://python.org
        
        ![walk1](https://github.com/Kautenja/gym-super-mario-bros/blob/master/gym_super_mario_bros/sprites/img/Characters/Mario/Mario%20-%20Walk1.gif)
        ![walk2](https://github.com/Kautenja/gym-super-mario-bros/blob/master/gym_super_mario_bros/sprites/img/Characters/Mario/Mario%20-%20Walk2.gif)
        ![walk3](https://github.com/Kautenja/gym-super-mario-bros/blob/master/gym_super_mario_bros/sprites/img/Characters/Mario/Mario%20-%20Walk3.gif)
        ![jump](https://github.com/Kautenja/gym-super-mario-bros/blob/master/gym_super_mario_bros/sprites/img/Characters/Mario/Mario%20-%20Jump.gif)
        
        An [OpenAI Gym](https://github.com/openai/gym) environment for
        Super Mario Bros. & Super Mario Bros. 2 (Lost Levels) on The Nintendo
        Entertainment System (NES).
        
        # Installation
        
        The preferred installation of `gym-super-mario-bros` is from `pip`:
        
        ```shell
        pip install gym-super-mario-bros
        ```
        
        ## NES Emulator
        
        `gym-super-mario-bros` uses [FCEUX](http://www.fceux.com/web/home.html) to emulate NES games.
        Make sure it's installed and in your `$PATH`.
        
        ### Unix
        
        ```shell
        sudo apt-get install fceux
        ```
        
        ### Mac
        
        ```shell
        brew install fceux
        ```
        
        # Usage
        
        You must import `gym_super_mario_bros` before trying to make an environment. This is 
        because gym environments are registered at runtime.
        
        ```python
        import gym_super_mario_bros
        env = gym_super_mario_bros.make('SuperMarioBros-v0')
        
        done = True
        for step in range(5000):
            if done:
                state = env.reset()
            state, reward, done, info = env.step(env.action_space.sample())
        
        env.close()
        ```
        
        **NOTE:** `gym_super_mario_bros.make` is just an alias to `gym.make` for
        convenience.
        
        # Environments
        
        These environments allow 3 attempts (lives) to make it through the 32 levels
        of the game. The environments only send reward-able game-play frames to
        agents; No cut-scenes, loading screens, etc. are sent from the NES emulator
        to an agent nor can an agent perform actions during these occurences. If a
        cut-scene is not able to be skipped by hacking the NES's RAM, the environment
        will lock the Pyton process until the emulator is ready for the next action.
        
        | Environment                     | Game | Description                                      |
        |:--------------------------------|:-----|:-------------------------------------------------|
        | `SuperMarioBros-v0`             | SMB  | 4 frames per action, standard ROM                |
        | `SuperMarioBros-v1`             | SMB  | 4 frames per action, custom down-sampled ROM     |
        | `SuperMarioBrosNoFrameskip-v0`  | SMB  | 1 frame per action, standard ROM                 |
        | `SuperMarioBrosNoFrameskip-v1`  | SMB  | 1 frame per action, custom down-sampled ROM      |
        | `SuperMarioBros2-v0`            | SMB2 | 4 frames per action, standard ROM                |
        | `SuperMarioBros2-v1`            | SMB2 | 4 frames per action, custom down-sampled ROM     |
        | `SuperMarioBros2NoFrameskip-v0` | SMB2 | 1 frame per action, standard ROM                 |
        | `SuperMarioBros2NoFrameskip-v1` | SMB2 | 1 frame per action, custom down-sampled ROM      |
        
        # Citation
        
        Please cite `gym-super-mario-bros` if you use it in your research.
        
        ```tex
        @misc{gym-super-mario-bros,
          author = {Christian Kauten},
          title = {{S}uper {M}ario {B}ros for {O}pen{AI} {G}ym},
          year = {2018},
          publisher = {GitHub},
          howpublished = {\url{https://github.com/Kautenja/gym-super-mario-bros}},
        }
        ```
        
Keywords: OpenAI-Gym NES Super-Mario-Bros Reinforcement-Learning-Environment
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Games/Entertainment :: Side-Scrolling/Arcade Games
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Description-Content-Type: text/markdown
