👉 中文版在这里

Tutorial version v1.0.3-Beta.

⛳ Note: I have renamed manual cache to user package after v1.0.3-Beta. If you are working with another version you should refer ‘Cache’ as ‘Package’.

📘 User Guide#

Welcome to the UABS User Guide. This guide walks you through how to use the tool—from launching it for the first time to performing advanced tasks.

❗Modding can be complex, which is why the design of UABS might not feel intuitive at first. Please read this User Guide carefully to understand what the tool can and cannot do.

🟢 Getting Started#

Download the any release from the Releases page.
Launch the standalone .exe or open the Unity project if you’re using the dev version.

💡 Special Note: UABS works best with Unity 2021.3.33f1 bundles.

🖥️ User Interface Overview#

Option	Note
File	- 📄Open File: open a file in UABS (only “.bundle”, “.ab”, “.assets” files are included) - 📁Open Folder: open a folder and search for files described above.
Export	- 🌌Export All: export all assets in a bundle. (currently only support images) - 👆Export Selected: export all selected assets in a bundle. (currently only support images) - 🧱Export Filtered: export all filtered assets in a bundle. (currently only support images) ⚠️ only works in a Bundle.
Search	- 🔑By Keywords: find all bundles that contain any of the keywords in their names, or if any of their assets contain any of the keywords in their names. The keywords are separated by a comma. For example: hero,weapon,skill. If you specify exclude keywords and a match includes any of the exclude keywords, it won’t be included in the final result. - 🖼️By Image: use a Sprite / Texture2D to search the Bundle(s). The actual comparison is done with name, not pixels. - 📝By Memo: very similar to ‘By Keywords’ but instead of name it searches asset memo. ⚠️ you will need to build a manual cache first before using this feature.
Dependency	- 🧩Search Bundle’s dependencies: the dependency bundles will be displayed as a folder view. ⚠️ you will need to build a manual cache first before using this feature. ⚠️ only works in a Bundle.
Filter	- 🧱Filter assets in a bundle by asset type (AssetClassID). ⚠️ only works in a Bundle.
Memo	- 📂Select Memo Cache: specify a manual cache for memo storage. - 🧬Inherit Memo: transfer memo from older game versions to a newer version. It has three modes: * Safe: do not transfer memo if the memo field in the current version is non-empty. * Overwrite: transfer all memo from the older version if its memos field is non-empty. * Force: transfer all memos whenever there is a match. ⚠️ you will need to build a manual cache first before using this feature.
Cache (manual cache)	- 🗃️Build New Cache: click button ‘Build New Cache’ to build a new cache. Select the game data folder, such as StreamingAssets(PC), split_UnityDataAssetPack(Android). After that, create a new folder under UABS_Cache (by you) and select it. Wait for the process to complete (the entry in scrollview will turn from gray to white). - 🗑️Remove Cache: click the ‘X’ button to remove an existing cache.
Back	- ↩️To go back: click this button to go back. If you are in a bundle, it will go back to its folder. If you are in a folder, it will go to its parent folder. If you are in dependency / search view, it will go to the last view.

📂 Opening a Bundle File#

In the toolbar, hover over ‘File’ option and select ‘Open File’.

Open a file that has extension “bundle”.

There you go!

⚠️ Special Notice: Large files may take time to load due to current I/O limitations.

🗃️ Building Manual Cache#

Select ‘Cache’ -> ‘Build New Cache’ -> ‘Build New Cache’.

Select the game data folder.

If it’s a Windows Steam game, the directory is usually ’~/steamapps/common/[GAME]/[GAME]_Data/StreamingAssts/aa/StandaloneWindows64’.

For Android APK, it’s ’~/split_UnityDataAssetPack/assets/aa/Android’.

After choose the game data folder, create a new folder under ‘UABS_Cache’ (by you) and select it. I recommend you to name the folder like so: [GAME]-[VERSION]. For example, if you game is called “OWL” and version is “2.11.0.2”, do:

Go to ‘Build New Cache’ panel again and you shall see a new entry that has background color of gray. This mean that UABS is still processing the game data folder.

After UABS is done, the background color should turn white, as shown in this image:

🎉 Now you have your very first manual cache! This is going to be necessary for many features provided by UABS.

🔍 Searching for Bundles#

You can search bundles in UABS. For example, by keywords. Go to ‘Search’ -> ‘By Keywords’ -> Select a cache in the scrollview.

After you have selected the cache, its background should turn white.

Now follow the guideline and enter your keywords (and exclude keywords, if any). After you are done, click ‘Search’.

If any match result is found, it will display them.

🖼️ Viewing and Exporting Assets#

Currently, UABS only supports viewing and exporting Sprite & Texture2D assets.

To view the file, click on the asset entry. The display panel will show the asset if it’s supported by UABS. You can zoom and pan images.

To export assets, go to ‘Export’ -> ‘Export all assets’. Select a place to save.

After you open the export folder, you should see folders like the following.

🏷️ Asset Memo#

You can use the memo feature for quick navigation, annotation, or project organization. But first of all, you need to enable it. To do that, go to ‘Memo’ -> ‘Select Memo Cache’ -> Select a cache for storing memo. You should also expect the cache entry to turn white after you click it.

The memo field should become available after you do that. (Notice currently only Sprite & Texture2D assets work, for other kinds of assets the field should still be disabled)

You can type in memo field like so:

🎉 Now there is your first memo in UABS!

Let’s apply search again but with memo this time. This time, go to ‘Search’ -> ‘By Memo’. Select the cache. Enter your search keyword to find the assets you memo. You don’t need to search exactly. For example, if your memo was ” Harry Potter and the Chamber of Secrets”, searching “Harry Potter” will match them just fine.

UABS treats dependency differently from other tools. You can actually navigate to a dependency bundle and find its dependency from there! It’s very easy to do in UABS. Go to ‘Depend’ -> Select a cache entry in the scrollview.

It will automatically search all dependency bundles for you. Here are the dependencies for my current bundle.

🧯 Troubleshooting#

UABS is not well tested, encountering problems is normal. If you did, please go to C:\Users[YOUR USER NAME]\AppData\LocalLow\DefaultCompany\UABS and find Player.txt. Open an issue and send that to me. Tell me how to replicate the situation so that I can investigate.

🙏 Thanks for using UABS!#

If you like this project, please consider giving my repo a ⭐!

Feel free to explore the other wiki pages for more details.