Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.31 KB

README.md

File metadata and controls

42 lines (30 loc) · 2.31 KB

PySDL3

Logo

Tests PyPI Python Versions PyPI Version PyPI Downloads PyPI Status

PySDL3 is a pure Python wrapper around the SDL3, SDL3_image, SDL3_mixer, SDL3_ttf, SDL3_rtf and SDL3_net libraries. It uses the built-in ctypes library to interface with SDL3 while providing an understandable function definition with docstrings, argument names and type hints, like this:

Screenshot

Getting Started

Just run one of the following commands in a terminal:

# To install the latest stable version from PyPI:
pip install --upgrade PySDL3

# To install the latest development version from GitHub:
pip install --upgrade git+https://github.com/Aermoss/PySDL3.git

Requirements

There are no additional requirements since PySDL3 will download all the necessary binaries for you on the first run.

SDL3 binaries will be downloaded from PySDL3-Build repository, if you want to use your own binaries please read the documentation.

Supported Platforms:

  • Linux (AMD64, ARM64)
  • Windows (AMD64, ARM64)
  • Darwin (AMD64, ARM64)

Documentation

The documentation of PySDL3 can be found at: https://pysdl3.readthedocs.io.

If you can't find what you are looking for there, it is highly recommended to look at the official documentation of SDL3 since everything is defined exactly the same.

License

PySDL3 is available under the MIT license, see the LICENSE file for more information.