Metadata-Version: 2.1
Name: gltf-helper
Version: 0.2.3
Summary: 
Author: Daverin Nadesan
Author-email: daverin@beamm.co
Requires-Python: >=3.6,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: typer[all] (>=0.3.2,<0.4.0)
Description-Content-Type: text/markdown

# GLTF Helper

```glb(web images) -> glb(basis images)```


##

Allows converting gltf/glb files with embedded jpgs/pngs to glb files with embedded basisu images.

## Features
*System*
- [x] glb (web images) -> glb (basisu images)
- [ ] glb (web images) -> glb (ktx2 images)
- [ ] glb (basisu images) -> glb (web images)
- [ ] glb (ktx2 images) -> glb (web images)
- [x] multiple files
- [x] custom basisu compression flags

## Use cases

Unity gltf pipeline:
- [GLTFUtility](https://github.com/Siccity/GLTFUtility) 
- [KTXUnity](https://github.com/atteneder/KtxUnity)

See [sample project](https://github.com/daverin/glTF-universal-tex-unity-demo) ✨

## Usage 

### **Blue Pill Usage**
#


#### Test
```
docker run -t \
    -v $(pwd)/samples:/samples \
    beamm/gltf-helper convert \
        /samples/Avocado/avo.gltf/asset.gltf \
        /samples/Avocado/avo_binary.glb \
    -bf "-y_flip" \
    --tag basisutest
```

#### Help 

```
docker run -t \
    -v $$(pwd)/samples:/samples \
    beamm/gltf-helper --help
```

TIP: Checkout `makefile` for other useful commands

### **Red Pill Usage**
#

 1) build basisu -> [check it](https://github.com/BinomialLLC/basis_universal#command-line-compression-tool)

 2) install gltf-pipeline -> [check it](https://github.com/CesiumGS/gltf-pipeline#getting-started)

 ```
 pip install --user gltf-helper
 ```
3) CLI readme ->  [check it](CLI_README.md)
