Gym Breakout environment using Pygame.
Project description
gym-breakout-pygame
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 (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
Tests
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.
Docs
To build the docs: mkdocs build
To view documentation in a browser: mkdocs serve
and then go to http://localhost:8000
License
gym-breakout-pygame is released under the GNU General Public License v3.0 or later (GPLv3+).
Copyright 2019-2022 Marco Favorito, Luca Iocchi
Authors
The code is largely inspired by RLGames
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gym-breakout-pygame-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 365d3720e699c3d76e90deb74a038584dabfc2336e6846db34be55cee0ed1bf5 |
|
MD5 | aec79e08555e231e4335c1ba8710a39f |
|
BLAKE2b-256 | c2276d0260ec6c0e1cae07e2949545f3da5b09f5227d97fba32ef3e62f1e3dd6 |
Hashes for gym_breakout_pygame-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fabf748a82ad16a32cf81e9a734a7aa385d551dffaf411d9c58454ce20d7f608 |
|
MD5 | 5121b47d4753853fc49a7200d60ee0af |
|
BLAKE2b-256 | 1bac64e3369b966c99fb84a8ed08864131993e18df3853541ff4cbea18944dcd |