Metadata-Version: 2.1
Name: pygame-light2d
Version: 2.0.2
Summary: Fast 2D dynamic lighting engine for Pygame.
Author: Markel Zubia
License: MIT License
        
        Copyright (c) 2023 MarkelZ
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/MarkelZ/pygame-light2d
Project-URL: Documentation, https://github.com/MarkelZ/pygame-light2d/wiki
Project-URL: Bug Reports, https://github.com/MarkelZ/pygame-light2d/issues
Keywords: pygame,light,lights,engine,shadows,dynamic,2D
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.24.1
Requires-Dist: pygame >=2.3.0
Requires-Dist: moderngl >=5.8.2
Requires-Dist: PyOpenGL >=3.1.6

# Pygame Light 2D
This module provides fast 2D dynamic lighting for `pygame`. 

https://github.com/MarkelZ/pygame-light2d/assets/60424316/a8d1322b-ac05-47d4-8b04-2786f0d3c96a

## 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](#system-requirements).

Then, run the following command:

```sh
python3 -m pip install pygame-light2d
```

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

```py
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](https://github.com/MarkelZ/pygame-light2d/wiki/Getting-Started) page on the wiki.

## Documentation

### Using the API

For detailed explanations of the API, please refer to the [API Reference](https://github.com/MarkelZ/pygame-light2d/wiki/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](https://github.com/MarkelZ/pygame-light2d/wiki/Adding-lights-to-an-existing-project).

## Frequently Asked Questions

For frequently asked questions check out [FAQ](https://github.com/MarkelZ/pygame-light2d/wiki/FAQ).

## Contributing

We greatly appreciate and encourage contributions from the community! 

Please take a look at the [Contributing](https://github.com/MarkelZ/pygame-light2d/wiki/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.


