Skip to content

Commit 75ad102

Browse files
authored
Merge pull request #8 from Skyluker4/enhancements/better-documentation
Improve README. Fixes #6.
2 parents 1ff79d8 + b39cef3 commit 75ad102

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ A tool to dump or replace assets in a Unity asset bundle.
88

99
## Usage
1010

11-
This program always requires a **decompressed** Unity asset bundle. Use [Unity Assets Bundle Extractor Avalonia (UABEA)](https://github.com/nesrak1/UABEA) to decompress an asset bundle if it's compressed.
12-
It also always requires the name of the ```member``` (A.K.A. field) you'd like interact with in the asset bundle (ex. ```m_Name```).
11+
This program requires an **uncompressed** Unity asset bundle. Use [Unity Assets Bundle Extractor Avalonia (UABEA)](https://github.com/nesrak1/UABEA) to decompress an asset bundle if it's compressed.
12+
It also requires the name of the ```member``` (the **field** of an object in the assets file, **NOT** the game object itself) you'd like interact with in the asset bundle (ex. ```m_Name```), except for when you are dealing with textures.
13+
The best way to find members/fields for an object is to open the asset bundle in [UABEA](https://github.com/nesrak1/UABEA) or a similar tool, then open the asset file and then the object, where you'll find a list of all members for that object.
1314
To extract, you also need to set the path of where you'd like to dump to.
14-
To replace/import assets, you need to specify the path where the assets to import are and the name of the new asset bundle you're exporting. The files inside of the directory must match the asset names **exactly** in order to be imported.
15+
16+
To replace assets, you need to specify the path where the assets to import are and the name of the new asset bundle you're exporting. The files inside of the directory must match the asset names **exactly** in order to be imported.
1517

1618
### Arguments
1719

@@ -31,10 +33,14 @@ To replace/import assets, you need to specify the path where the assets to impor
3133

3234
### Examples
3335

34-
- Dump all assets from ```assetBundle.bun``` with member ```m_Script``` to ```extracted/```:
35-
- ```UnityAssetReplacer -b assetBundle.bun -m m_Script -d extracted```
36-
- Replace all assets from ```assetBundle.bun``` with member ```m_Script```, reading from ```newAssets/```, to ```newAssetBundle.bun```:
36+
- Dump all assets from ```assetBundle.bun``` with member ```m_Script``` to ```extractedAssets/```:
37+
- ```UnityAssetReplacer -b assetBundle.bun -m m_Script -d extractedAssets```
38+
- Replace assets in ```assetBundle.bun``` with member ```m_Script```, reading from ```newAssets/```, to ```newAssetBundle.bun```:
3739
- ```UnityAssetReplacer -b assetBundle.bun -m m_Script -i newAssets -o newAssetBundle.bun```
40+
- Dump all textures from ```assetBundle.bun``` to ```extractedTextures/```:
41+
- ```UnityAssetReplacer -b assetBundle.bun -t -d extractedTextures```
42+
- Replace textures in ```assetBundle.bun```, reading from ```newTextures/```, to ```newAssetBundle.bun```:
43+
- ```UnityAssetReplacer -b assetBundle.bun -t -i newTextures -o newAssetBundle.bun```
3844

3945
## Building
4046

0 commit comments

Comments
 (0)