| Name | pygame-light2d JSON |
| Version |
2.1.2
JSON |
| download |
| home_page | None |
| Summary | Fast 2D dynamic lighting engine for Pygame. |
| upload_time | 2024-08-03 14:13:42 |
| maintainer | None |
| docs_url | None |
| author | Markel Zubia |
| requires_python | >=3.10 |
| 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. |
| keywords |
pygame
light
lights
engine
shadows
dynamic
2d
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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).
## Graphics engine
This package uses [pygame-render](https://github.com/MarkelZ/pygame-render) for
using shaders in `pygame`, and it can be accessed with `LightingEngine.graphics`.
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "pygame-light2d",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "pygame, light, lights, engine, shadows, dynamic, 2D",
"author": "Markel Zubia",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e7/6d/3b6dd17cb4ad105f5e2fdb42108239f2c74d219ae8dfacd866673b33ca5b/pygame_light2d-2.1.2.tar.gz",
"platform": null,
"description": "# Pygame Light 2D\nThis module provides fast 2D dynamic lighting for `pygame`. \n\nhttps://github.com/MarkelZ/pygame-light2d/assets/60424316/a8d1322b-ac05-47d4-8b04-2786f0d3c96a\n\n## System requirements\n\n- `Python` version >= 3.10\n- `OpenGL` version >= 3.3\n\n## Python package dependencies\n\n- `numpy` >= 1.24.1\n- `pygame` >= 2.3.0\n- `moderngl` >= 5.8.2\n- `PyOpenGL` >= 3.1.6\n\n## Installation\n\nFirstly, ensure that your system meets the [System requirements](#system-requirements).\n\nThen, run the following command:\n\n```sh\npython3 -m pip install pygame-light2d\n```\n\nTo verify correct installation, open a Python terminal and import the module:\n\n```py\nimport pygame_light2d\n```\n\nIf there are no errors, the installation was successful!\n\n## Getting started\n\nTo 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.\n\n## Documentation\n\n### Using the API\n\nFor detailed explanations of the API, please refer to the [API Reference](https://github.com/MarkelZ/pygame-light2d/wiki/API-Reference).\n\n### Using `pygame-light2d` in an existing project\n\nIf 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).\n\n## Graphics engine\n\nThis package uses [pygame-render](https://github.com/MarkelZ/pygame-render) for\nusing shaders in `pygame`, and it can be accessed with `LightingEngine.graphics`.\n\n## Frequently Asked Questions\n\nFor frequently asked questions check out [FAQ](https://github.com/MarkelZ/pygame-light2d/wiki/FAQ).\n\n## Contributing\n\nWe greatly appreciate and encourage contributions from the community! \n\nPlease 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.\n\n## License\n\nThis code is licensed under the terms of the MIT license.\n\n\n",
"bugtrack_url": null,
"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. ",
"summary": "Fast 2D dynamic lighting engine for Pygame.",
"version": "2.1.2",
"project_urls": {
"Bug Reports": "https://github.com/MarkelZ/pygame-light2d/issues",
"Documentation": "https://github.com/MarkelZ/pygame-light2d/wiki",
"Homepage": "https://github.com/MarkelZ/pygame-light2d"
},
"split_keywords": [
"pygame",
" light",
" lights",
" engine",
" shadows",
" dynamic",
" 2d"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d5ae7a3d23d0cc8cdca7457aba77094b181df999255d82b47a7e98c74d7d7b27",
"md5": "6323d12a694bdec8fdbc1a2e6b853a86",
"sha256": "7d16a93a0356ab1bfb711085b0fa8c274dd34780b81b0755c90bae9efcbc956b"
},
"downloads": -1,
"filename": "pygame_light2d-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6323d12a694bdec8fdbc1a2e6b853a86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12591,
"upload_time": "2024-08-03T14:13:40",
"upload_time_iso_8601": "2024-08-03T14:13:40.740034Z",
"url": "https://files.pythonhosted.org/packages/d5/ae/7a3d23d0cc8cdca7457aba77094b181df999255d82b47a7e98c74d7d7b27/pygame_light2d-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e76d3b6dd17cb4ad105f5e2fdb42108239f2c74d219ae8dfacd866673b33ca5b",
"md5": "f80b501005c5dc3b8ca6ec1167a01467",
"sha256": "8ee3d8fadeecef6db1974fbe17278d081ca60df42ffa582858623f19301af52e"
},
"downloads": -1,
"filename": "pygame_light2d-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "f80b501005c5dc3b8ca6ec1167a01467",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11525,
"upload_time": "2024-08-03T14:13:42",
"upload_time_iso_8601": "2024-08-03T14:13:42.582042Z",
"url": "https://files.pythonhosted.org/packages/e7/6d/3b6dd17cb4ad105f5e2fdb42108239f2c74d219ae8dfacd866673b33ca5b/pygame_light2d-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-03 14:13:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarkelZ",
"github_project": "pygame-light2d",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pygame-light2d"
}
