https://github.com/ppizarror/pygame-menu

A menu for pygame (pygame-ce also supported!). Simple, and easy to use
https://github.com/ppizarror/pygame-menu

background-image button game image input keyboard-input menu menus pygame pygame-menu pygame-ui python python-game python-ui sound text text-input ui

Last synced: 4 days ago
JSON representation

A menu for pygame (pygame-ce also supported!). Simple, and easy to use

• Host: GitHub
• URL: https://github.com/ppizarror/pygame-menu
• Owner: ppizarror
• License: other
• Created: 2017-05-01T16:26:50.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-07-25T13:10:33.000Z (6 months ago)
• Last Synced: 2025-09-26T12:54:58.744Z (4 months ago)
• Topics: background-image, button, game, image, input, keyboard-input, menu, menus, pygame, pygame-menu, pygame-ui, python, python-game, python-ui, sound, text, text-input, ui
• Language: Python
• Homepage: https://pygame-menu.readthedocs.io/
• Size: 31.4 MB
• Stars: 592
• Watchers: 13
• Forks: 149
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
===========

pygame-menu

===========

.. image:: docs/_static/pygame_menu_small.png

    :align: center

    :alt:

.. image:: https://img.shields.io/badge/author-Pablo%20Pizarro%20R.-lightgray.svg

    :target: https://ppizarror.com

    :alt: @ppizarror

.. image:: https://img.shields.io/badge/license-MIT-blue.svg

    :target: https://opensource.org/licenses/MIT

    :alt: License MIT

.. image:: https://img.shields.io/badge/python-3.8+-red.svg

    :target: https://www.python.org/downloads

    :alt: Python 3.8+

.. image:: https://img.shields.io/badge/pygame-1.9.3%2B%2F2.0%2B-orange

    :target: https://www.pygame.org

    :alt: Pygame 1.9.3+/2.0+

.. image:: https://badge.fury.io/py/pygame-menu.svg

    :target: https://pypi.org/project/pygame-menu

    :alt: PyPi package

.. image:: https://img.shields.io/github/actions/workflow/status/ppizarror/pygame-menu/ci.yml?branch=master

    :target: https://github.com/ppizarror/pygame-menu/actions/workflows/ci.yml

    :alt: Build status

    

.. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fppizarror%2Fpygame-menu.svg?type=shield

    :target: https://app.fossa.com/projects/git%2Bgithub.com%2Fppizarror%2Fpygame-menu?ref=badge_shield

    :alt: FOSSA Status

    

.. image:: https://readthedocs.org/projects/pygame-menu/badge/?version=latest

    :target: https://pygame-menu.readthedocs.io

    :alt: Documentation Status

.. image:: https://codecov.io/gh/ppizarror/pygame-menu/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/ppizarror/pygame-menu

    :alt: Codecov

.. image:: https://img.shields.io/github/issues/ppizarror/pygame-menu

    :target: https://github.com/ppizarror/pygame-menu/issues

    :alt: Open issues

.. image:: https://img.shields.io/pypi/dm/pygame-menu?color=purple

    :target: https://pypi.org/project/pygame-menu/

    :alt: PyPi downloads

.. image:: https://static.pepy.tech/personalized-badge/pygame-menu?period=total&units=international_system&left_color=grey&right_color=lightgrey&left_text=total%20downloads

    :target: https://pepy.tech/project/pygame-menu

    :alt: Total downloads

    

.. image:: https://img.shields.io/badge/buy%20me%20a-Ko--fi-02b9fe

    :target: https://ko-fi.com/ppizarror

    :alt: Buy me a Ko-fi

Source repo on `GitHub `_, 

and run it on `Repl.it `_

Introduction

------------

Pygame-menu is a `python-pygame `_ library for creating menus and GUIs.

It supports several widgets, such as buttons, color inputs, clock objects, drop selectors,

frames, images, labels, selectors, tables, text inputs, color switches, and many

more, with multiple customization options.

Comprehensive documentation for the latest version is available at

https://pygame-menu.readthedocs.io

**Note**: For `pygame-ce`, check out `pygame-menu-ce `_.

Install Instructions

--------------------

Pygame-menu can be installed via pip. Simply run:

.. code-block:: bash

    $> pip install pygame-menu -U

To build the documentation from a Git repository:

.. code-block:: bash

    $> clone https://github.com/ppizarror/pygame-menu

    $> cd pygame-menu

    $> pip install -e ."[docs]"

    $> cd docs

    $> make html