pysdl2-dll

pysdl2-dll is a Python package that bundles the SDL2 binaries in pip-installable form for macOS and Windows, making it easier to create and run scripts/packages that use the PySDL2 library.

It uses the official SDL2, SDL2_mixer, SDL2_ttf, and SDL2_image binaries for macOS and Windows, as well as unofficial SDL2_gfx binaries for the same platforms. For Linux, the SDL2 binaries and their dependencies are all built from source using the official Python manylinux images for maximum compatibility.

The latest release includes the following versions of the SDL2 binaries:

Installation

You can install the latest version of pysdl2-dll via pip:

pip install pysdl2-dll # install latest release version

Requirements

At present, the following platforms are supported:

• macOS (10.9+, 64-bit x86)
• macOS (11.0+, 64-bit ARM)
• Windows (32-bit x86)
• Windows (64-bit x86)
• Linux (32-bit x86)
• Linux (64-bit x86)
• Linux (64-bit ARM)

The pysdl2-dll package can be installed on platforms other than the ones listed above, but it won't have any effect.

pysdl2-dll requires PySDL2 0.9.7 or later in order to work correctly on macOS, and for PySDL2 to load the binaries automatically when available. To update to the latest PySDL2, you can run:

pip install -U pysdl2

Because the wheels are not built against any specfic version of Python, pysdl2-dll supports all versions and implementations of Python that are supported by PySDL2.

Linux Requirements

There are currently two versions the Linux wheels: "legacy" wheels based on the manylinux2014 standard (for 32-bit and 64-bit x86), and "modern" wheels based on the manylinux_2_24 standard (for 64-bit x86 and 64-bit ARM only). The manylinux_2_24 SDL2 binaries require a more recent version of Linux, but offer dynamic support for additional features such as Wayland windowing, Pipewire/sndio/JACK audio, and OpenGL ES v1 rendering.

You must have pip 19.3 or newer to install the manylinux2014 wheels, and pip 20.3 or newer to install the manylinux_2_24 wheels. Distributions that use musl C instead of glibc (e.g. Alpine Linux) are not supported.

Note: pysdl2-dll is currently not built with libdecor support, meaning that native Wayland (non-XWayland) window decorations will be unavailable when using these binaries (see issue #9 for details). Given that SDL2 defaults to using XWayland this shouldn't be an issue for most users, but suggestions and/or PRs to fix the issue are welcome!

Usage

If you are using PySDL2 0.9.7 or later, you don't need to do anything special to use the pysdl2-dll binaries in your project: PySDL2 will load them automatically (and print a message indicating such) if they are available. For older versions of PySDL2, you will need to import this module manually in your scripts (import sdl2dll) before PySDL2 is imported.

To override pysdl2-dll and use a different set of binaries, you can set the PYSDL2_DLL_PATH environment variable to the path of the folder containing the binaries you want to use instead, or alternatively set it to "system" to force PySDL2 to use the system install of SDL2 if available (e.g. SDL2 installed with brew on macOS).