Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 2.71 KB

README.rst

File metadata and controls

98 lines (63 loc) · 2.71 KB

Overview

docs Documentation Status
tests


package

A Python gui library based around Pygame, meant for simplifying gui development for menus on simple pixel art games (or other types of games). Designed for customization and simplicity. Although the library comes with pre-designed gui items, each can be customized and its functionality personalized to fit your needs.

Start with creating the main Game object, specify your global settings (such as screen size, FPS cap, ...), run the main game loop from it. Create your custom page, add items to it, custom event handlers and more. It will be auto-imported and loaded into your game.

Your game needs its own loop for optimization reasons? No problem, create a dummy page and run your loop from there. Keep page, menu and item logic separated and tidy.

See https://python-pyggui.readthedocs.io/en/latest/usage.html for basic concepts.

  • Free software: MIT license

Installation

pip install pyggui

You can also install the in-development version with:

pip install https://github.com/15minutOdmora/python-pyggui/archive/main.zip

Documentation

https://python-pyggui.readthedocs.io/

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows
set PYTEST_ADDOPTS=--cov-append
tox
Other
PYTEST_ADDOPTS=--cov-append tox