arcade-gui 0.1.0a4

GUI extension for the Python game library Arcade https://arcade.academy/

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

Examples providing an overview of features, there will be dedicated documentation soon.

• UILabel
• UIButton
• UIInputBox
• Example with ID

Screenshots

Features for first release

• UILabel
  • Align with UITextInput
• UIButton
• Focused element tracked
• ID reference system for UIElements
• CI/CD
• UITextInput
  • Basic setup
  • Scroll text with cursor
  • Set max length
  • Emit event on ENTER
• UIElements emit own UIEvents
  • UIButton
  • UITextInput
• UIImageButton
• UITexturedInputBox
• FlatButtons (https://codepen.io/maziarzamani/full/YXgvjv)
• UITextArea
• Theme support
  • Provide different standard themes for flat buttons
• Add documentation and doc strings (sphinx)
  • release notes
  • setup readthedocs
• track new features and issues in Github

Chores

• harmonize constructors x, y vs center_x, center_y
• figure out, how UIView.find_by_id does not produce typing warnings
• improve docs
  • fix reference to examples
  • include screenshots (at least one)
• make 3D Button more realistic, or change to flat buttons
• support Python 3.7
• test examples render the expected screen

Background information and other frameworks

Reference Pygame GUI projects

Overview

• 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
  • Examples
  • QuickStart Example
  • 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