lwa_unity_unpack/README.md

41 lines
2.0 KiB
Markdown

# lwa_unity_unpack [![build](https://github.com/Leinnan/lwa_unity_unpack/actions/workflows/rust.yml/badge.svg)](https://github.com/Leinnan/lwa_unity_unpack/actions/workflows/rust.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![crates.io](https://img.shields.io/crates/v/lwa_unity_unpack.svg)](https://crates.io/crates/lwa_unity_unpack)
[![crates.io](https://img.shields.io/crates/d/lwa_unity_unpack.svg)](https://crates.io/crates/lwa_unity_unpack)
Simple CLI tool for unpacking the unitypackages.
Also allows auto convert of the FBX files to GLTF during unpacking. For that download the tool from [here](https://github.com/godotengine/FBX2glTF) and pass the path to executable file as `--fbx-to-gltf` argument value.
```bash
Program for unpacking unitypackages files
Usage: lwa_unity_unpack.exe [OPTIONS] --input <INPUT> --output <OUTPUT>
Options:
-i, --input <INPUT> .unitypackage file to extract
-o, --output <OUTPUT> target directory
-f, --fbx-to-gltf <FBX_TO_GLTF> optional- path to the tool that will auto convert fbx files to gltf during unpacking
--get-materials-from-prefabs
checks if material base texture in prefabs differ from the one specified in fbx model that is converted to GLTF and overrides it with the one from prefab and copy texture to models folder
--ignore-extensions <IGNORE_EXTENSIONS>
optional- extensions that will be ignored during unpacking
--copy-meta-files
copy meta files alongside regular files
-h, --help Print help
-V, --version Print version
```
`lwa_unity_unpack -i "C:\\PROJECTS\\lwa_unity_unpack\\POLYGON_Snow_Kit_Unity_2020_3_v1_4.unitypackage" -o "output" -f "C:\\tools\\FBX2glTF.exe" --ignore-extensions "mat" --ignore-extensions "prefab"`
## Install
It can be downloaded by going to Releases page.
It can be also installed using Rust Cargo:
```sh
cargo install lwa_unity_unpack
```