Metadata-Version: 2.1
Name: gym-breakout-pygame
Version: 0.1.1
Summary: Gym Breakout environment using Pygame
Home-page: https://github.com/whitemech/gym-breakout-pygame.git
Author: Marco Favorito, Luca Iocchi
License: Apache License 2.0
Keywords: environment,agent,rl,openaigym,openai-gym,gym,breakout
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: gym
Requires-Dist: pygame
Requires-Dist: numpy

# gym-breakout-pygame

[![PyPI](https://img.shields.io/pypi/v/gym_breakout_pygame)](https://pypi.org/project/gym_breakout_pygame/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/gym_breakout_pygame)
[![](https://img.shields.io/pypi/l/aea)](https://github.com/whitemech/gym-breakout-pygame/blob/master/LICENSE)
![PyPI - Downloads](https://img.shields.io/pypi/dm/gym_breakout_pygame)
![CI](https://github.com/whitemech/gym-breakout-pygame/workflows/CI/badge.svg)
[![codecov](https://codecov.io/gh/whitemech/gym-breakout-pygame/branch/master/graph/badge.svg)](https://codecov.io/gh/whitemech/gym-breakout-pygame)

Gym Breakout environment using Pygame.

## Preliminaries

## Install

Install with `pip`:

    pip3 install gym_breakout_pygame

Or, install from source:

    git clone https://github.com/whitemech/gym-breakout-pygame.git
    cd gym-breakout-pygame
    pip install .

## Development

- clone the repo:

        git clone https://github.com/whitemech/gym-breakout-pygame.git
        cd gym-breakout-pygame

- Create/activate the virtual environment:

        pipenv shell --python=python3.7

- Run a short demo:

        python gym_breakout_pygame --random --record

Check for an `.mp4` file in `videos/`. You should get:

<p align="center">
  <img width="260" height="480" src="https://raw.githubusercontent.com/whitemech/gym-breakout-pygame/develop/docs/breakout-example.gif"></p>


- Enable fire:

        python gym_breakout_pygame --fire

<p align="center">
  <img width="260" height="480" src="https://raw.githubusercontent.com/whitemech/gym-breakout-pygame/develop/docs/breakout-example-fire.gif">
</p>

## Tests

We use `tox` for testing:

```
tox -e py3.x
```
Replace `x` depending on the minor version of your Python interpreter. E.g.
`tox -e py3.7`

## Credits

The code is largely inspired by [RLGames](https://github.com/iocchi/RLGames.git)



