Metadata-Version: 2.1
Name: arcade-gui
Version: 0.1.0a0
Summary: GUI extension for the Python game library Arcade  https://arcade.academy/
Home-page: https://github.com/eruvanos/arcade_gui
License: MIT
Keywords: arcade,game,gui
Author: Maic Siemering
Author-email: maic@siemering.tech
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Games/Entertainment :: Arcade
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: User Interfaces
Requires-Dist: arcade (>=2.3.15,<3.0.0)
Project-URL: Documentation, https://github.com/eruvanos/arcade_gui
Project-URL: Repository, https://github.com/eruvanos/arcade_gui
Description-Content-Type: text/markdown

# GUI Library for Python Arcade

This project targets to offer simple to complex ui elements
to use in games and software written with the Python Arcade library.

Some UI components were copied over to adjust and fix them.

This project could also end up in a PR to integrate within Arcade.

## Basic Components

#### UIView
Central class to manager the ui components.
Converts `on_` callback functions into events, so that UIElements
just have to contain one method to interact with user input.

#### UIElement
A general interface of an UI element.

## Examples

* [UILabel](./examples/show_uilabel.py)
* [UIButton](./examples/show_uibutton.py)


## Features for first release

* [x] UILabel
* [x] UIButton
* [x] Focused element tracked
* [ ] UIImageButton
* [ ] UITextInput
* [ ] UIElements emit own UIEvents
* [ ] Theme support


## Background information and other frameworks

### Reference Pygame GUI projects

[Overview](https://www.pygame.org/wiki/gui)

* ThorPy
    * http://www.thorpy.org/index.html
* Phil's pyGame Utilities
    * https://www.pygame.org/project/108
* OcempGUI
    * https://www.pygame.org/project/125
* PyGVisuals
    * https://github.com/Impelon/PyGVisuals
* Pygame GUI
    * [Homepage](https://github.com/MyreMylar/pygame_gui)
    * [Examples](https://github.com/MyreMylar/pygame_gui_examples)
    * [QuickStart Example](https://github.com/MyreMylar/pygame_gui_examples/blob/master/quick_start.py)
    * Concept
        * UIManager manages every interaction, new elements get the UIManager on creation
        * Elements create events and hook into pygames event system
        * Themes can be read from JSON files


### Ideas
* Create own implementation
* Build adapter for PyGame GUI
