Skip to content

Commit

Permalink
Update ui-editing-scripts installation
Browse files Browse the repository at this point in the history
  • Loading branch information
drojf committed Jan 25, 2024
1 parent 2a5011b commit ab333e9
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/developer/sharedassets/ui-editing-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,20 @@ There is also another [tool](https://github.com/07th-mod/ui-editing-scripts/blob

# Installation

Before using these scripts, run the following command to install the dependencies. If you run into an issue with `decrunch` then read bellow.
!!! info "build.py users"
If using the `build.py`, dependencies will be installed automatically. Use a virtual environment if you do not want packages installed globally.

Before using these scripts, run the following command to install the dependencies.

```bash
pip install numpy Pillow unitypack
pip install -r requirements.txt
```

UnityPack has dependency on something called `decrunch` which requires Visual C++ Build Tools 14.0 (on Windows) but can still fail to install even if you have them. We're not using the part that needs `decrunch` (it's only used to decompress certain formats of image assets) anyway so if you run into these issues, simply download [this fork](https://github.com/tellowkrinkle/unitypack) of unitypack where the dependency is removed and install if with `python setup.py install` from within its folder.
## Installation - `decrunch` error

This should no longer occur if you use the above `requirements.txt` to install dependencies, but I've kept the old text below for reference.

UnityPack has dependency on something called `decrunch` which requires Visual C++ Build Tools 14.0 (on Windows) but can still fail to install even if you have them. We're not using the part that needs `decrunch` (it's only used to decompress certain formats of image assets) anyway so if you run into these issues, simply download [this fork](https://github.com/drojf/UnityPack) of unitypack where the dependency is removed and install if with `python setup.py install` from within its folder.

# UnityTextModifier

Expand Down

0 comments on commit ab333e9

Please sign in to comment.