pygui/readme.md
2024-09-18 21:37:28 -05:00

2.5 KiB
Raw Permalink Blame History

PyGUI - Simple, Extensible Python GUI for Pygame Pygame

GitHub repo size GitHub stars GitHub issues MIT License

A lightweight and customizable Python GUI framework built for Pygame.

PyGUI is designed to simplify the creation of in-game user interfaces and debugging tools. It features core GUI components like buttons, sliders, checkboxes, and windows while maintaining performance for games made with Pygame.


Features

  • 🔥 Lightweight: Efficient and fast, with minimal overhead, perfect for real-time applications.
  • 🎮 Game-Ready: Seamlessly integrates with Pygame for easy implementation in your game development projects.
  • 🖱️ Interactive Components: Includes buttons, sliders, checkboxes, labels, and movable windows.
  • 🎨 Highly Customizable: Adjust size, position, and appearance of every element to match your project's aesthetics.

Installation

  1. Clone the Repository:

    git clone https://github.com/ousmblueninja/pygui.git
    
  2. Install Pygame:

    If you don't already have Pygame installed, you can install it using pip:

    pip install pygame
    
  3. Include PyGUI in Your Project:

    Add pygui.py to your project and start using its components in your Pygame game.


Contributing

💡 Contributions are welcome! Whether it's bug fixes, feature suggestions, or code contributions, feel free to open an issue or submit a pull request. Let's build an awesome GUI library together!

  1. Fork the repository.
  2. Create a new feature branch: git checkout -b feature-name.
  3. Commit your changes: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature-name.
  5. Open a pull request.

License

📜 This project is licensed under the MIT License see the LICENSE file for details.


Pygame

PyGUI - The simplest way to build Pygame GUIs.