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 flake8tox -e mypytox -e black-checktox -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
Metadata
Release files for gym-breakout-pygame 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gym-breakout-pygame-0.2.0.tar.gz | 13.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gym_breakout_pygame-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.2 kB
Release files / gym-breakout-pygame-0.2.0.tar.gz
| Download URL | gym-breakout-pygame-0.2.0.tar.gz |
|---|---|
| Size | 13.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
365d3720e699c3d76e90deb74a038584dabfc2336e6846db34be55cee0ed1bf5
|
|
BLAKE2b-256 checksum How to use checksums |
c2276d0260ec6c0e1cae07e2949545f3da5b09f5227d97fba32ef3e62f1e3dd6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
Release files / gym_breakout_pygame-0.2.0-py3-none-any.whl
| Download URL | gym_breakout_pygame-0.2.0-py3-none-any.whl |
|---|---|
| Size | 19.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fabf748a82ad16a32cf81e9a734a7aa385d551dffaf411d9c58454ce20d7f608
|
|
BLAKE2b-256 checksum How to use checksums |
1bac64e3369b966c99fb84a8ed08864131993e18df3853541ff4cbea18944dcd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|