gym-breakout-pygame

PyPI PyPI - Python Version PyPI - Downloads CI codecov

Gym Breakout environment using Pygame.

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:

  • Enable fire:
    python gym_breakout_pygame --fire
    

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