Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/K0lb3/UnityPy
UnityPy is python module that makes it possible to extract/unpack and edit Unity assets
https://github.com/K0lb3/UnityPy
assetstudio data-mining python python3 unity unity-asset unity-asset-extractor unitypack
Last synced: 2 months ago
JSON representation
UnityPy is python module that makes it possible to extract/unpack and edit Unity assets
- Host: GitHub
- URL: https://github.com/K0lb3/UnityPy
- Owner: K0lb3
- License: mit
- Created: 2019-07-23T22:36:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T22:48:11.000Z (2 months ago)
- Last Synced: 2024-07-31T02:32:50.605Z (2 months ago)
- Topics: assetstudio, data-mining, python, python3, unity, unity-asset, unity-asset-extractor, unitypack
- Language: Python
- Homepage:
- Size: 22 MB
- Stars: 771
- Watchers: 15
- Forks: 114
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# UnityPy
[](https://discord.gg/C6txv7M)
[](https://pypi.python.org/pypi/UnityPy)
[]()
[](https://github.com/K0lb3/UnityPy/blob/master/LICENSE)
A Unity asset extractor for Python based on [AssetStudio](https://github.com/Perfare/AssetStudio).
Next to extraction, it also supports editing Unity assets.
So far following obj types can be edited:
- Texture2D
- Sprite(indirectly via linked Texture2D)
- TextAsset
- MonoBehaviour (and all other types that you have the typetree of)
If you need advice or if you want to talk about (game) data-mining,
feel free to join the [UnityPy Discord](https://discord.gg/C6txv7M).
If you're using UnityPy a commercial project,
a donation to a charitable cause or a sponsorship of this project is expected.
**As UnityPy is still in active development breaking changes can happen.**
Those changes are usually limited to minor versions (x.y) and not to patch versions (x.y.z).
So in case that you don't want to actively maintain your project,
make sure to make a note of the used UnityPy version in your README or add a check in your code.
e.g.
```python
if UnityPy.__version__ != '1.9.6':
raise ImportError("Invalid UnityPy version detected. Please use version 1.9.6")
```
1. [Installation](#installation)
2. [Example](#example)
3. [Important Classes](#important-classes)
4. [Important Object Types](#important-object-types)
5. [Custom Fileystem](#custom-filesystem)
6. [Credits](#credits)
## Installation
**Python 3.7.0 or higher is required**
via pypi
```cmd
pip install UnityPy
```
from source
```cmd
git clone https://github.com/K0lb3/UnityPy.git
cd UnityPy
python -m pip install .
```
### Notes
#### Windows
Visual C++ Redistributable is required for the brotli dependency.
In case a new(ish) Python version is used, it can happen that the C-dependencies of UnityPy might not be precompiled for this version.
In such cases the user either has to report this as issue or follow the steps of [this issue](https://github.com/K0lb3/UnityPy/issues/223) to compile it oneself.
Another option for the user is downgrading Python to the latest version supported by UnityPy. For this see the python version badge at the top of the README.
### Crash without warning/error
The C-implementation of the typetree reader can directly crash python.
In case this happens, the usage of the C-typetree reader can be disabled by adding these two lines to your main file.
```python
from UnityPy.helpers import TypeTreeHelper
TypeTreeHelper.read_typetree_c = False
```
## Example
The following is a simple example.
```python
import os
import UnityPy
def unpack_all_assets(source_folder : str, destination_folder : str):
# iterate over all files in source folder
for root, dirs, files in os.walk(source_folder):
for file_name in files:
# generate file_path
file_path = os.path.join(root, file_name)
# load that file via UnityPy.load
env = UnityPy.load(file_path)
# iterate over internal objects
for obj in env.objects:
# process specific object types
if obj.type.name in ["Texture2D", "Sprite"]:
# parse the object data
data = obj.read()
# create destination path
dest = os.path.join(destination_folder, data.name)
# make sure that the extension is correct
# you probably only want to do so with images/textures
dest, ext = os.path.splitext(dest)
dest = dest + ".png"
img = data.image
img.save(dest)
# alternative way which keeps the original path
for path,obj in env.container.items():
if obj.type.name in ["Texture2D", "Sprite"]:
data = obj.read()
# create dest based on original path
dest = os.path.join(destination_folder, *path.split("/"))
# make sure that the dir of that path exists
os.makedirs(os.path.dirname(dest), exist_ok = True)
# correct extension
dest, ext = os.path.splitext(dest)
dest = dest + ".png"
data.image.save(dest)
```
You probably have to read [Important Classes](#important-classes)
and [Important Object Types](#important-object-types) to understand how it works.
People with slightly advanced python skills should look at [UnityPy/tools/extractor.py](UnityPy/tools/extractor.py) for a more advanced example.
It can also be used as a general template or as an importable tool.
### Setting the decryption key for Unity CN's AssetBundle encryption
The chinese version of Unity has its own inbuild option to encrypt AssetBundles/BundleFiles. As it's a feature of Unity itself, and not a game specific protection, it is included in UnityPy as well.
To enable encryption simply use `UnityPy.set_assetbundle_decrypt_key(key)`, with key being the value that the game that loads the budles passes to `AssetBundle.SetAssetBundleDecryptKey`.
## Important Classes
### [Environment](UnityPy/environment.py)
Environment loads and parses the given files.
It can be initialized via:
- a file path - apk files can be loaded as well
- a folder path - loads all files in that folder (bad idea for folders with a lot of files)
- a stream - e.g., io.BytesIO, file stream,...
- a bytes object - will be loaded into a stream
UnityPy can detect if the file is a WebFile, BundleFile, Asset, or APK.
The unpacked assets will be loaded into `.files`, a dict consisting of `asset-name : asset`.
All objects of the loaded assets can be easily accessed via `.objects`,
which itself is a simple recursive iterator.
```python
import io
import UnityPy
# all of the following would work
src = "file_path"
src = b"bytes"
src = io.BytesIO(b"Streamable")
env = UnityPy.load(src)
for obj in env.objects:
...
# saving an edited file
# apply modifications to the objects
# don't forget to use data.save()
...
with open(dst, "wb") as f:
f.write(env.file.save())
```
### [Asset](UnityPy/files/SerializedFile.py)
Assets are a container that contains multiple objects.
One of these objects can be an AssetBundle, which contains a file path for some of the objects in the same asset.
All objects can be found in the `.objects` dict - `{ID : object}`.
The objects with a file path can be found in the `.container` dict - `{path : object}`.
### [Object](UnityPy/files/ObjectReader.py)
Objects contain the _actual_ files, e.g., textures, text files, meshes, settings, ...
To acquire the actual data of an object it has to be read first. This happens via the `.read()` function. This isn't done automatically to save time because only a small part of the objects are of interest. Serialized objects can be set with raw data using `.set_raw_data(data)` or modified with `.save()` function, if supported.
## Important Object Types
All object types can be found in [UnityPy/classes](UnityPy/classes/).
### [Texture2D](UnityPy/classes/Texture2D.py)
- `.name`
- `.image` converts the texture into a `PIL.Image`
- `.m_Width` - texture width (int)
- `.m_Height` - texture height (int)
**Export**
```python
from PIL import Image
for obj in env.objects:
if obj.type.name == "Texture2D":
# export texture
data = obj.read()
data.image.save(path)
# edit texture
fp = os.path.join(replace_dir, data.name)
pil_img = Image.open(fp)
data.image = pil_img
data.save()
```
### [Sprite](UnityPy/classes/Sprite.py)
Sprites are part of a texture and can have a separate alpha-image as well.
Unlike most other extractors (including AssetStudio), UnityPy merges those two images by itself.
- `.name`
- `.image` - converts the merged texture part into a `PIL.Image`
- `.m_Width` - sprite width (int)
- `.m_Height` - sprite height (int)
**Export**
```python
for obj in env.objects:
if obj.type.name == "Sprite":
data = obj.read()
data.image.save(path)
```
### [TextAsset](UnityPy/classes/TextAsset.py)
TextAssets are usually normal text files.
- `.name`
- `.script` - binary data (bytes)
- `.text` - script decoded via UTF8 (str)
Some games save binary data as TextFile, so it's usually better to use `.script`.
**Export**
```python
for obj in env.objects:
if obj.type.name == "TextAsset":
# export asset
data = obj.read()
with open(path, "wb") as f:
f.write(bytes(data.script))
# edit asset
fp = os.path.join(replace_dir, data.name)
with open(fp, "rb") as f:
data.script = f.read()
data.save()
```
### [MonoBehaviour](UnityPy/classes/MonoBehaviour.py)
MonoBehaviour assets are usually used to save the class instances with their values.
If a type tree exists, it can be used to read the whole data,
but if it doesn't exist, then it is usually necessary to investigate the class that loads the specific MonoBehaviour to extract the data.
([example](examples/CustomMonoBehaviour/get_scriptable_texture.py))
- `.name`
- `.script`
- `.raw_data` - data after the basic initialisation
**Export**
```python
import json
for obj in env.objects:
if obj.type.name == "MonoBehaviour":
# export
if obj.serialized_type.nodes:
# save decoded data
tree = obj.read_typetree()
fp = os.path.join(extract_dir, f"{tree['m_Name']}.json")
with open(fp, "wt", encoding = "utf8") as f:
json.dump(tree, f, ensure_ascii = False, indent = 4)
else:
# save raw relevant data (without Unity MonoBehaviour header)
data = obj.read()
fp = os.path.join(extract_dir, f"{data.name}.bin")
with open(fp, "wb") as f:
f.write(data.raw_data)
# edit
if obj.serialized_type.nodes:
tree = obj.read_typetree()
# apply modifications to the data within the tree
obj.save_typetree(tree)
else:
data = obj.read()
with open(os.path.join(replace_dir, data.name)) as f:
data.save(raw_data = f.read())
```
### [AudioClip](UnityPy/classes/AudioClip.py)
- `.samples` - `{sample-name : sample-data}`
The samples are converted into the .wav format.
The sample data is a .wav file in bytes.
```python
clip : AudioClip
for name, data in clip.samples.items():
with open(name, "wb") as f:
f.write(data)
```
### [Font](UnityPy/classes/Font.py)
```python
if obj.type.name == "Font":
font : Font = obj.read()
if font.m_FontData:
extension = ".ttf"
if font.m_FontData[0:4] == b"OTTO":
extension = ".otf"
with open(os.path.join(path, font.name+extension), "wb") as f:
f.write(font.m_FontData)
```
### [Mesh](UnityPy/classes/Mesh.py)
- `.export()` - mesh exported as .obj (str)
The mesh will be converted to the Wavefront .obj file format.
```python
mesh : Mesh
with open(f"{mesh.name}.obj", "wt", newline = "") as f:
# newline = "" is important
f.write(mesh.export())
```
### Renderer, MeshRenderer, SkinnedMeshRenderer
ALPHA-VERSION
- `.export(export_dir)` - exports the associated mesh, materials, and textures into the given directory
The mesh and materials will be in the Wavefront formats.
```python
mesh_renderer : Renderer
export_dir: str
if mesh_renderer.m_GameObject:
# get the name of the model
game_object = mesh_renderer.m_GameObject.read()
export_dir = os.path.join(export_dir, game_object.name)
mesh_renderer.export(export_dir)
```
### [Texture2DArray](UnityPy/classes/Texture2DArray.py)
WARNING - not well tested
- `.name`
- `.image` converts the texture2darray into a `PIL.Image`
- `.m_Width` - texture width (int)
- `.m_Height` - texture height (int)
**Export**
```python
import os
from PIL import Image
for obj in env.objects:
if obj.type.name == "Texture2DArray":
# export texture
data = obj.read()
for i, image in enumerate(data.images):
image.save(os.path.join(path, f"{data.m_Name}_{i}.png"))
# editing isn't supported yet!
```
## Custom-Filesystem
UnityPy uses [fsspec](https://github.com/fsspec/filesystem_spec) under the hood to manage all filesystem interactions.
This allows using various different types of filesystems without having to change UnityPy's code.
It also means that you can use your own custom filesystem to e.g. handle indirection via catalog files, load assets on demand from a server, or decrypt files.
Following methods of the filesystem have to be implemented for using it in UnityPy.
- sep (not a function, just the seperator as character)
- isfile(self, path: str) -> bool
- isdir(self, path: str) -> bool
- exists(self, path: str, \*\*kwargs) -> bool
- walk(self, path: str, \*\*kwargs) -> Iterable[List[str], List[str], List[str]]
- open(self, path: str, mode: str = "rb", \*\*kwargs) -> file ("rb" mode required, "wt" required for ModelExporter)
- makedirs(self, path: str, exist_ok: bool = False) -> bool
## Credits
First of all,
thanks a lot to all contributors of UnityPy and all of its users.
Also,
many thanks to:
- [Perfare](https://github.com/Perfare) for creating and maintaining and every contributor of [AssetStudio](https://github.com/Perfare/AssetStudio)
- [ds5678](https://github.com/ds5678) for the [TypeTreeDumps](https://github.com/AssetRipper/TypeTreeDumps) and the [custom minimal Tpk format](https://github.com/AssetRipper/Tpk)
- [Razmoth](https://github.com/Razmoth) for figuring out and sharing Unity CN's AssetBundle decryption ([src](https://github.com/Razmoth/PGRStudio)).