Metadata-Version: 2.1
Name: RenderBirdCore
Version: 0.1.1
Summary: A easy to use object-based 3D rendering engine for Python based on PyGame and OpenGL
Home-page: https://github.com/Wojtekb30/RenderBird-Python-3D-engine
Author: Wojtekb30 (Wojciech B)
Author-email: wojtekb30.player@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pygame>=2.0.0
Requires-Dist: PyOpenGL>=3.1.6
Requires-Dist: Pillow>=8.0.0
Requires-Dist: numpy>=1.18.0

# RenderBirdCore

![Version](https://img.shields.io/badge/version-0.1.0-blue.svg)

**RenderBirdCore** is an easy-to-use 3D rendering engine for Python based on PyGame and OpenGL. It provides a simple and intuitive interface for creating and rendering 3D objects, managing cameras, and integrating 2D UI elements, making it ideal for developers looking to easily build simple 3D applications or games with Python.

## Installation

You can install RenderBirdCore via pip:

```bash
pip install RenderBirdCore
```

## Usage

For detailed examples and usage guides, please refer to the [Examples](https://github.com/Wojtekb30/RenderBird-Python-3D-engine/tree/main/Examples) folder on the GitHub repository.

## Known Issues

- **Performance with Complex STL Models**: Custom STL 3D models may exhibit poor performance if they are highly complex or have large textures. It is recommended to use low-poly models until update to handle complex ones releases.

## Future Plans

Future updates for RenderBird include:

- **Enhanced 3D Model Handling**: Improved support and optimization for custom 3D models to handle complexity and textures more efficiently.
- **Performance Enhancements**: Ongoing optimizations to increase rendering speed and reduce computational overhead.
- **Lighting Support**: Introduction of various lighting options to create more realistic and visually appealing scenes.
- **Additional Features**: Implementation of new functions and tools to expand the engine's capabilities and provide developers with more flexibility.
- **Development software**: I plan to create programs that will make software development with RenderBird even easier.

## Why is it named RenderBirdCore?

I named it RenderBird because I like to add the word Bird to many of my projects. BirdEngine sounded generic so I came up with the name RenderBird. And this package is Core because it is core of the rendering engine, and other functionalities may release as separate packages using this one as the core.

## Community and Feedback

I'm excited to see what you've built with RenderBird! Feel free to share your projects and provide feedback to help improve the engine. Your contributions and ideas are highly appreciated.
