Skip to main content

Gym Breakout environment using Pygame.

Project description


PyPI PyPI - Python Version PyPI - Status PyPI - Implementation PyPI - Wheel GitHub

test lint docs codecov

Gym Breakout environment using Pygame.


Install with pip:

pip3 install gym_breakout_pygame

Or, install from source:

git clone
cd gym-breakout-pygame
pip install .


  • clone the repo:

      git clone
      cd gym-breakout-pygame
  • Create/activate the virtual environment (using Poetry):

      poetry shell
      poetry install
  • 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


To run tests: tox

To run only the code tests: tox -e py3.10

To run only the linters:

  • tox -e flake8
  • tox -e mypy
  • tox -e black-check
  • tox -e isort-check

Please look at the tox.ini file for the full list of supported commands.


To build the docs: mkdocs build

To view documentation in a browser: mkdocs serve and then go to http://localhost:8000


gym-breakout-pygame is released under the GNU General Public License v3.0 or later (GPLv3+).

Copyright 2019-2022 Marco Favorito, Luca Iocchi


The code is largely inspired by RLGames

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gym-breakout-pygame-0.2.0.tar.gz (13.1 kB view hashes)

Uploaded Source

Built Distribution

gym_breakout_pygame-0.2.0-py3-none-any.whl (19.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page