Pygame Light 2D

This module provides fast 2D dynamic lighting for pygame.

demo.mp4

System requirements

• Python version >= 3.10
• OpenGL version >= 3.3

Python package dependencies

• numpy >= 1.24.1
• pygame >= 2.3.0
• moderngl >= 5.8.2
• PyOpenGL >= 3.1.6

Installation

Firstly, ensure that your system meets the System requirements.

Then, run the following command:

python3 -m pip install pygame-light2d

To verify correct installation, open a Python terminal and import the module:

import pygame_light2d

If there are no errors, the installation was successful!

Getting started

To learn how to create a simple game with lighting effects using pygame-light2d, check out the Getting started page on the wiki.

Documentation

Using the API

For detailed explanations of the API, please refer to the API Reference.

Using pygame-light2d in an existing project

If you're looking to incorporate pygame-ligth2d into an existing project, we recommend starting with our guide on Adding lights to an existing project.

Frequently Asked Questions

For frequently asked questions check out FAQ.

Contributing

We greatly appreciate and encourage contributions from the community!

Please take a look at the Contributing page on the wiki for details on how to contribute to the project.

License

This code is licensed under the terms of the MIT license.