https://github.com/scanmountgoat/ssbh_data_py
Python bindings to the ssbh_data Rust library
https://github.com/scanmountgoat/ssbh_data_py
python smash-ultimate
Last synced: 8 months ago
JSON representation
Python bindings to the ssbh_data Rust library
- Host: GitHub
- URL: https://github.com/scanmountgoat/ssbh_data_py
- Owner: ScanMountGoat
- License: mit
- Created: 2021-03-14T00:20:46.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-31T20:44:25.000Z (over 1 year ago)
- Last Synced: 2024-12-31T21:27:07.841Z (over 1 year ago)
- Topics: python, smash-ultimate
- Language: Rust
- Homepage:
- Size: 304 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ssbh_data_py [](https://pypi.org/project/ssbh-data-py/)
Python bindings to the [ssbh_data](https://github.com/ultimate-research/ssbh_lib) Rust library. ssbh_data_py provides a higher level abstraction over
the binary data stored in SSBH files such as a "model.numshb". SSBH files can be created from scratch or modified from existing files entirely in Python.
Report bugs and request new features in [issues](https://github.com/ScanMountGoat/ssbh_data_py/issues). Check the requirements before reporting on any installation issues.
## Supported Formats
| Format | Supported Versions (major.minor) | Read | Save |
| --- | --- | --- | --- |
| Modl (`.numdlb`, `.nusrcmdlb`) | 1.7 | :heavy_check_mark: | :heavy_check_mark: |
| Mesh (`.numshb`) | 1.8, 1.9, 1.10 | :heavy_check_mark: | :heavy_check_mark: |
| Skel (`.nusktb`) | 1.0 | :heavy_check_mark: | :heavy_check_mark: |
| Anim (`.nuanmb`) | 2.0, 2.1 | :heavy_check_mark: | :heavy_check_mark: (2.0 only) |
| Matl (`.numatb`) | 1.5, 1.6 | :heavy_check_mark: | :heavy_check_mark: |
| Hlpb (`.nuhlpb`) | 1.1 | :heavy_check_mark: | :heavy_check_mark: |
| Adj (`.adjb`) | | :heavy_check_mark: | :heavy_check_mark: |
| MeshEx (`.numshexb`) | | :heavy_check_mark: | :heavy_check_mark: |
## Installing
The package can be installed for a supported python version using `pip` on the latest version of Windows, Linux, or MacOS. The prebuilt wheels (`.whl` files) are included only for situations where `pip` might not be available such as for plugin development for applications.
Installing: `pip install ssbh_data_py`
Updating: `pip install ssbh_data_py --upgrade`
The minimum supported pip version is 20.3.
## Requirements
The package is available on [PyPi](https://pypi.org/project/ssbh_data_py/) for Python 3.9, 3.10, 3.11, 3.12, and 3.13 for newer versions of Windows, Linux, and Mac OS. For other Python versions, build ssbh_data_py from source. ssbh_data_py requires the `numpy` package for transforms and attribute data.
## Getting Started
Each supported SSBH type has an associated data struct that can be created reading from a file.
```python
import ssbh_data_py
mesh = ssbh_data_py.mesh_data.read_mesh("model.numshb")
modl = ssbh_data_py.modl_data.read_modl("model.numdlb")
skel = ssbh_data_py.skel_data.read_skel("model.nusktb")
```
It's also possible to construct new objects. Specify the major and minor version to use a particular file format revision. Note that this only impacts the binary output when calling the save method. Not all versions are supported, so it's recommended to use the default values.
```python
mesh = ssbh_data_py.mesh_data.MeshData(major_version=1, minor_version=8)
modl = ssbh_data_py.modl_data.ModlData()
skel = ssbh_data_py.skel_data.SkelData()
```
ssbh_data_py uses standard Python types whenever possible. Conversion to the appropriate binary format is handled automatically on saving. For example, the 4x4 transformation matrix for bone data is simply a numpy array.
> [!IMPORTANT]
> Specify `dtype=numpy.float32` for float arrays and `dtype=numpy.uint32` for integer arrays to prevent conversion errors.
```python
import numpy
# Assign the identity transform to each bone.
for bone in skel.bones:
bone.transform = numpy.eye((4), dtype=numpy.float32)
# Assign the X coordinate for positions
for o in mesh.objects:
o.positions[0].data[:, 0] += 1.0
```
After making any changes, the results can be saved back to a file. Using the same path used to read the files will overwrite the file. Even if no edits are made, the resulting file will likely not be binary identical with the original due to floating point rounding errors or the use of different algorithms.
```python
mesh.save("model_new.numshb")
modl.save("model_new.numdlb")
skel.save("model_new.nusktb")
```
## Documentation
The Python API is best summarized by the type stub (.pyi) files, which can be found [here](https://github.com/ScanMountGoat/ssbh_data_py/tree/main/ssbh_data_py/ssbh_data_py). The Python API matches the underlying Rust types and functions as closely as possible. The Rust documentation has much more detailed documentation and can be found at https://docs.rs/ssbh_data. For more advanced sample Python scripts, see the [examples](https://github.com/ScanMountGoat/ssbh_data_py/tree/main/examples).
## Building
Requires a recent version of Rust. The builds published to PyPi are built using [Maturin](https://github.com/PyO3/maturin). Aftering succesfully installing Maturin, running `maturin develop --release` in the ssbh_data_py directory will build and install the module into the current virtual environment.
`maturin build --release` builds the `ssbh_data_py` module that can be imported into Python. The resulting binary can only be used with the current Python version, processor type, and operating system. Rename the `.dll` to `.pyd` on Windows and the `.dylib` to `.so` on Linux or MacOS.
If the import fails, check that the `.pyd` or `.so` file exists in the appropriate location. Importing may also fail if `ssbh_data_py` was built from source for an operating system or Python interpreter version that isn't compatible with the current Python environment.