Menu for pygame, simple, lightweight and easy to use
Clone or download
Latest commit a4cca4d Oct 12, 2018

README.md

Pygame Menu

Pygame Menu

Menu for pygame, simple, lightweight and easy to use

@ppizarror License MIT Python 2.7 Python 3.6

Python library that can create a simple Menu for Pygame application, supports:

  1. Textual menus
  2. Textual menus + buttons
  3. Lists of values (Selectors) that can trigger functions when pressing Return or changing the value
  4. Buttons

Examples:

Normal Button menu

Text menu

Small submenu

Install

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

pip install pygame-menu

Import

Import of this library is similar as pygame:

import pygameMenu                # This imports classes and other things
from pygameMenu.locals import *  # Import constants (like actions)

Obviously you need Pygame to run this.

Usage

Creating menus

  • Menu

    This class creates a Menu

    pygameMenu.Menu(surface, window_width, window_height, font, title, *args) # -> Menu object

    Parameters are the following:

    Param Description Type Default
    surface Pygame surface object Pygame Surface -
    window_width Window width size (px) int -
    window_height Window height size (px) int -
    font Font file dir str -
    title Title of the menu (main title) str -
    bgfun Background drawing function (only if menupause app) function None
    color_selected Color of selected item tuple MENU_SELECTEDCOLOR
    dopause Pause game bool True
    draw_region_x Drawing position of element inside menu (x-axis) int MENU_DRAW_X
    draw_region_y Drawing position of element inside menu (y-axis) int MENU_DRAW_Y
    draw_select Draw a rectangle around selected item(bool) bool MENU_SELECTED_DRAW
    enabled Menu is enabled by default or not bool True
    font_color Color of font tuple MENU_FONT_COLOR
    font_size Font size int MENU_FONT_SIZE
    font_size_title Font size of the title int MENU_FONT_SIZE_TITLE
    font_title Alternative font of the title (fil direction) str None
    joystick_enabled Enable joystick support bool True
    menu_alpha Alpha of background (0=tansparent, 100=opaque) int MENU_ALPHA
    menu_centered Text centered menu bool MENU_CENTERED_TEXT
    menu_color Menu color tuple MENU_BGCOLOR
    menu_color_title Background color of title tuple MENU_TITLE_BG_COLOR
    menu_height Height of menu (px) int MENU_HEIGHT
    menu_width Width of menu (px) int MENU_WIDTH
    onclose Event that applies when closing menufunction PymenuAction None
    option_margin Margin of each element in menu(px) int MENU_OPTION_MARGIN
    option_shadow Indicate if a shadow is drawn on ech option bool MENU_OPTION_SHADOW
    rect_width Border with of rectangle around seleted item int MENU_SELECTED_WIDTH
    title_offsetx Offset x-position of title (px) int 0
    title_offsety Offset y-position of title (px) int 0
  • TextMenu

    This class creates a textual menu

    pygameMenu.TextMenu(surface, window_width, window_height, font, title, *args) # -> TextMenu object

    This class inherites from Menu, so the parameters are the same, except the following extra parameters:

    Param Description Type
    text_centered Indicate if text is centered bool
    text_color Text color tuple
    text_fontsize Text font size int
    text_margin Line margin int
    draw_text_region_x X-Axis drawing region of the text int

Add options and entries to Menus

Menu and TextMenu have the next functions:

  • add_option(element_name, element, *args)

    Adds an option to the Menu.

    Param Description Type
    element_name String on menu entry str
    element Menu object (Menu, function or Menu-Event) supported PymenuAction, function, Menu
    *args Additional arguments -

    Example:

    help_menu = pygameMenu.TextMenu(surface, window...)
    help_menu.add_option('Return to Menu', PYGAME_MENU_BACK) # Add option

    Another example:

    menu = pygameMenu.Menu(surface, window...)
    menu.add_option(timer_menu.get_title(), timer_menu)  # Add timer submenu
    menu.add_option(help_menu.get_title(), help_menu)    # Add help submenu
    menu.add_option(about_menu.get_title(), about_menu)  # Add about submenu
    menu.add_option('Exit', PYGAME_MENU_EXIT)            # Add exit function
  • add_selector(title, values, onchange, onreturn, **kwargs)

    • add_selector_change(title, values, onchange, **kwargs)
    • add_selector_return(title, values, onreturn, **kwargs)

    Add a selector to menu: several options with values and two functions that execute when changing the selector (left/right) and pressing Return key on the element.

    Param Description Type
    title String on menu entry str
    values Value list, list of tuples list
    onchange Function that executes when change the value of selector function
    onreturn Function that executes when pressing return button on selected item function
    **kwargs Additional arguments -

    Example:

    def change_color_bg(c, **kwargs):
        """
        Change background color
        
        :param c: Color tuple
        """
        if c == (-1, -1, -1):  # If random color
            c = (randrange(0, 255), randrange(0, 255), randrange(0, 255))
        if kwargs['write_on_console']:
            print('New bg color: ({0},{1},{2})'.format(*c))
        COLOR_BACKGROUND[0] = c[0]
        COLOR_BACKGROUND[1] = c[1]
        COLOR_BACKGROUND[2] = c[2]
        
    timer_menu = pygameMenu.Menu(...)
    
    # Add selector
    timer_menu.add_selector('Change bgcolor',
                            # Values of selector, call to change_color_bg
                            [('Random', (-1, -1, -1)),  # Random color
                             ('Default', (128, 0, 128)),
                             ('Black', (0, 0, 0)),
                             ('Blue', COLOR_BLUE)],
                            None, # onchange
                            change_color_bg, # onreturn
                            write_on_console=True # Optional change_color_bg param)
                            
    timer_menu.add_option('Reset timer', reset_timer)
    timer_menu.add_option('Return to Menu', PYGAME_MENU_BACK)
    timer_menu.add_option('Close Menu', PYGAME_MENU_CLOSE)
  • add_line(text)

    Adds a new line on TextMenu object.

    Example:

    HELP = ['Press ESC to enable/disable Menu',
            'Press ENTER to access a Sub-Menu or use an option',
            'Press UP/DOWN to move through Menu',
            'Press LEFT/RIGHT to move through Selectors']
            
    menu_help = pygameMenu.Menu(...)
    for line in HELP:
        menu_help.add_line(line) # Add line
    menu_help.add_option('Return to Menu', PYGAME_MENU_BACK)
  • mainloop(events)

    Main loop of menu, on this function Menu can handle exceptions and draw. If parameter dopause is enabled then Menu pauses application and checks Events.

    menu = pygameMenu.Menu(...)
    
    # Main aplication
    while True:
    
        # Application events
        events = pygame.event.get()
    
        # Menu loop (If onpause is enabled then a infinite-loop is triggered on this line)
        menu.mainloop(events)
  • disable()

    Disable Menu (doest check events and draw on surface).

    menu = pygameMenu.Menu(...)
    menu.disable()
  • draw()

    Draw Menu on surface.

    menu = pygameMenu.Menu(...)
    menu.disable()
  • enable()

    Enable Menu (can check events and draw).

    menu = pygameMenu.Menu(...)
    menu.enable()
  • get_title()

    Give the title of the menu.

    menu = pygameMenu.Menu(..., title='Menu title', ...)
    menu.get_title() # -> 'Menu title'
  • is_enabled()

    Check if menu is enabled.

    menu = pygameMenu.Menu(...)
    menu.disable()
    menu.is_enabled() # -> False
  • is_disabled()

    Check if menu is disabled.

    menu = pygameMenu.Menu(...)
    menu.disable()
    menu.is_disabled() # -> True

Menu events

Supported events are the same:

Event Description
PYGAME_MENU_BACK Go back on menu
PYGAME_MENU_CLOSE Close menu
PYGAME_MENU_EXIT Close application
PYGAME_MENU_DISABLE_CLOSE Disable close menu
PYGAME_MENU_RESET Reset menu

This events are imported on from pygameMenu.locals import * line. Also the menu can handle joypad events.

Using fonts

Also this library has some fonts to use, to load a font run this code:

import pygameMenu

fontdir = pygameMenu.fonts.FONT_NAME

Available fonts (FONT_NAME): 8BIT, BEBAS, FRANCHISE, MUNRO and NEVIS.

Configurations

Default parameters of Menu and TextMenu are stored on the following files:

File Description
config_controls.py Configure default key-events of Menus
config_menu.py Configure default parameter of Menu class
config_textmenu.py Configure default parameter of TextMenu class

License

This project is licensed unde MIT [https://opensource.org/licenses/MIT/]

Author

Pablo Pizarro R. | 2017-2018