Metadata-Version: 2.1
Name: pygame-render
Version: 1.2.1
Summary: Fast 2D render 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-render
Project-URL: Documentation, https://github.com/MarkelZ/pygame-render/wiki
Project-URL: Bug Reports, https://github.com/MarkelZ/pygame-render/issues
Keywords: pygame,render,shader,shaders,pygame-ce,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.22.0
Requires-Dist: pygame >=2.1.0
Requires-Dist: moderngl >=5.8.2
Requires-Dist: PyOpenGL >=3.1.6

# Pygame Render

Python package for rendering 2D graphics with shaders for Pygame.

![screenshot](screenshot.png)

## System requirements

- `Python` version >= 3.10
- `OpenGL` version >= 3.3

## Supported platforms

✅ **Windows**  
✅ **Mac**  
✅ **Linux**  

## Installation

Firstly, ensure that your system meets the [System requirements](#system-requirements).

Then, run the following command:

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

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

```py
import pygame_render
```

If there are no errors, the installation was successful!

## Getting started

To learn about the features of `pygame-render`, check out the [Feature Walkthrough](https://github.com/MarkelZ/pygame_render/wiki/Feature-Walkthrough) page on the wiki.

You can also take a look at the examples in the [`examples/`](https://github.com/MarkelZ/pygame_render/tree/main/examples) directory.

For detailed explanations of the API, please refer to the [API Reference](https://github.com/MarkelZ/pygame-render/wiki/API-Reference)

## Python package dependencies

- `numpy` >=1.22.0
- `pygame` >=2.1.0
- `moderngl` >= 5.8.2
- `PyOpenGL` >= 3.1.6

## Frequently Asked Questions

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

## Contributing

We greatly appreciate and encourage contributions from the community! 

If you want to report a bug or request a new feature, feel free to open an issue in the [issue tracker](https://github.com/MarkelZ/pygame-render/issues).

For code contributions, please check out [Contributing](https://github.com/MarkelZ/pygame_render/wiki/Contributing) for details.

## License

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