Metadata-Version: 2.4
Name: ssk
Version: 1.0rc1
Summary: SolidSKeleton tessellation and format tools
Author: Rogier Goossen
License-Expression: MIT
Project-URL: Homepage, https://github.com/FerroIT/SolidSKeleton
Project-URL: Repository, https://github.com/FerroIT/SolidSKeleton
Project-URL: Issues, https://github.com/FerroIT/SolidSKeleton/issues
Project-URL: Specifications, https://github.com/FerroIT/SolidSKeleton/tree/main/format
Keywords: 3d,csg,geometry,solid modeling,solidskeleton
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pyyaml>=6.0
Requires-Dist: numpy>=1.24
Requires-Dist: trimesh>=4.0
Requires-Dist: manifold3d>=2.3
Dynamic: license-file

# SolidSKeleton Python

Python 3.10+.

```sh
pip install ssk
```

## Commands

```sh
ssk validate model.ssk
ssk convert model.ssk model.sskb
ssk convert model.ssk model.glb
ssk convert model.ssk model.glb --resolution 64
ssk convert model.sskb model.glb
ssk inspect model.sskb
```

From this directory without installing:

```sh
python -m ssk validate model.ssk
```

## Library

```py
from ssklib import convert, inspect_file, load, validate_file

convert("model.ssk", "model.glb", resolution=64)
```

Lower-level functions:

```py
from ssklib import parse_ssk, parse_sskb, resolve, validate, write_sskb
```

## Notes

- Mesh output defaults to resolution 32.
- CSG uses [trimesh](https://trimesh.org/) with [Manifold](https://github.com/elalish/manifold).
- glTF output uses unindexed meshes with flat per-face normals.
