Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3dninjas/3dn-bip
A Python library for Blender addons. Blazingly fast preview loads in Blender. Images of arbitrary size. bpy.utils.previews drop-in replacement.
https://github.com/3dninjas/3dn-bip
blender blender-addon blender-python blender-scripts blender3d jpg pillow png
Last synced: about 1 month ago
JSON representation
A Python library for Blender addons. Blazingly fast preview loads in Blender. Images of arbitrary size. bpy.utils.previews drop-in replacement.
- Host: GitHub
- URL: https://github.com/3dninjas/3dn-bip
- Owner: bonjorno7
- License: gpl-3.0
- Created: 2021-04-10T13:29:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-26T18:25:16.000Z (about 1 year ago)
- Last Synced: 2024-04-23T10:57:58.562Z (5 months ago)
- Topics: blender, blender-addon, blender-python, blender-scripts, blender3d, jpg, pillow, png
- Language: Python
- Homepage: https://bonjorno7.github.io/3dn-bip/
- Size: 1000 KB
- Stars: 55
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - 3dn-bip - A Python library for Blender addons. Blazingly fast preview loads in Blender. Images of arbitrary size. bpy.utils.previews drop-in replacement. (Python)
README
Please note that we’re no longer actively maintaining the library ourselves. If anyone is interested in assuming ownership of the project, feel free to reach out. We’re aware that the library is an essential component of multiple Blender addons, so we trust it will remain in good hands.
# 3D Ninjas | Blender Image Preview (BIP) Library
## Documentation
1. [Getting Started (this page)](https://bonjorno7.github.io/3dn-bip/)
2. [Install Pillow](https://bonjorno7.github.io/3dn-bip/install_pillow/)
3. [Reference](https://bonjorno7.github.io/3dn-bip/reference/)
4. [More](https://bonjorno7.github.io/3dn-bip/more/)
5. [Development](https://bonjorno7.github.io/3dn-bip/development/)
## What is 3DN BIP?
_3DN BIP_ or _3D Ninjas Blender Image Preview_ is a library, which allows blazingly fast preview image loads in Blender. Furthermore, it can load preview images of arbitrary size. It operates as an `bpy.utils.previews` drop-in replacement and does all the heavy lifting for you.
Our library enables the following major use cases:
1. Load preview images shipped as BIP images blazingly fast. We recommend this approach in case you can generate the images beforehand. In this case, your users don't need to take any action to enjoy the speed boost.
2. Load regular JPEG or PNG preview images blazingly fast. Recommended in case you need to load images provided by the user or by external software tools. For that, we need [Pillow](https://pypi.org/project/Pillow/) on the user's system. It would be best if you use our prepared `InstallPillow` operator so that your users can enjoy the speed boost with a simple click.
Notes:
1. Our library will always fall back to `bpy.utils.previews` if unsupported formats are to be loaded. For this reason, there is absolutely no disadvantage in using this library. In the worst case, we will apply the standard mechanism of Blender.
2. `.bip` is a highly optimized image format, which can be transferred to Blender's internal data structures immediately. It is always blazingly fast, whether [Pillow](https://pypi.org/project/Pillow/) is installed or not.
## Examples
Download the following sample addons. You can easily install the ZIP files in Blender via the addon preferences tab.
- Getting Started: [t3dn_bip_getting_started.zip](https://github.com/bonjorno7/3dn-bip/releases/latest/download/t3dn_bip_getting_started.zip)
- Showcase: [t3dn_bip_showcase.zip](https://github.com/bonjorno7/3dn-bip/releases/latest/download/t3dn_bip_showcase.zip)
## Library
The latest release of the library can be downloaded here: [t3dn_bip.zip](https://github.com/bonjorno7/3dn-bip/releases/latest/download/t3dn_bip.zip)
Just extract the zip file and copy the folder into your addon. Take a closer look at the examples given above to learn how to use the library.
In case you want to install the library via [PyPI](https://pypi.org/project/t3dn-bip/), you can use the following command:
```sh
python -m pip install t3dn-bip
```
## Converter
The converter is provided via [PyPI](https://pypi.org/project/t3dn-bip-converter/). Use the following command for the installation:
```sh
python -m pip install t3dn-bip-converter
```
Use the following command to convert images of [various formats](https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html) into the BIP format:
```sh
python -m t3dn_bip_converter source_file.png destination_file.bip
```
## Who is using 3DN BIP?
3DN BIP is a new library and is currently being integrated into various addons. The following addons have already been released with 3DN BIP.
### KIT OPS
