Metadata-Version: 2.4
Name: popups-dialog-gui
Version: 0.1.1
Summary: Help module for overlays and contextual help in Pygame
Author-email: Antonio Castro Snurmacher <acastro0841@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/acastr008/popups_dialog_gui
Project-URL: Source, https://github.com/acastr008/popups_dialog_gui
Project-URL: Issues, https://github.com/acastr008/popups_dialog_gui/issues
Keywords: pygame,help,overlay,games,ayuda
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pygame>=2.0
Requires-Dist: help-core-pygame>=0.1.2
Dynamic: license-file

# popups_dialog_gui (README.md)

![License MIT](https://img.shields.io/badge/License-MIT-green.svg)

## Description

popups_dialog_gui is a **pop-up windows module** built on Pygame to generate notices, dialogs, etc.
It also includes more advanced capabilities intended as a foundation for extending functionality (for example, help windows).
Form support, menus, etc. will be enabled soon.

## Project status

A considerable amount of functionality has been implemented and complemented with documentation.
Developed and tested on Linux. It may work on other systems, but it has not been verified.

## Documentation

- [Versión en Español de este documento](README_es.md)
- [Remaining documentation](docs/INDEX_en.md)
- [Full documentation on GitHub](https://github.com/acastr008/popups_dialog_gui) (currently private; it will be published soon)

## Usage examples

In the project’s `examples/` directory there is a small collection of programs that demonstrate different uses of popups_dialog_gui.
A tutorial is available that helps you learn in the most appropriate order and serves as a guide to understand the concepts introduced in each example.

## How to run the example programs (Quickstart)

At the root of the project there is a launcher (`main.py`) that shows the list of available example programs along with a brief description.

To try them on Linux you can download the launcher and the entire `examples/` directory. Make sure you have installed:

- python >= 3.9
- pygame >= 2.0
- help-core-pygame >= 0.1.2 (auxiliary Pygame library by the same author)

Command to run the launcher:

```bash
python main.py
```

Just select one of the examples and click with the mouse to run it.
