AssetStudioMod Documentation

Depending on which version of AssetStudioMod you are using, you must install the corresponding .NET runtime:

• AssetStudioMod.net472:

  • GUI/CLI: Requires .NET Framework 4.7.2.

• AssetStudioMod.net8:

  • GUI/CLI (Windows): Requires .NET Desktop Runtime 8.0.
  • CLI (Linux/Mac): Requires .NET Runtime 8.0.

• AssetStudioMod.net9:

  • GUI/CLI (Windows): Requires .NET Desktop Runtime 9.0.
  • CLI (Linux/Mac): Requires .NET Runtime 9.0.

When you select a MonoBehaviour asset for the first time, AssetStudioMod will prompt you to select the directory where the assembly is located (e.g., the Managed folder).

For Il2Cpp projects:

1. Use Il2CppDumper to generate dummy DLLs.
2. When prompted by AssetStudioMod, select the folder containing these dummy DLLs as the assembly directory.

To export complex animation data in the GUI:

• Exporting a Model with AnimationClip:

  1. Select the model in the Scene Hierarchy.
  2. Select the desired AnimationClip from the Asset List.
  3. Use Model -> Export selected objects with AnimationClip.

• Exporting an Animator with AnimationClip:

  1. Select the Animator in the Asset List.
  2. Use Ctrl + Click to select both the Animator and the AnimationClip from the Asset List.
  3. Use Export -> Export Animator with selected AnimationClip.

AssetStudioModCLI is a command-line tool used to extract and export assets from Unity asset bundles. It supports various asset types including Texture2D, Sprite, AudioClip, Mesh, and Animator.

Basic Syntax:

AssetStudioModCLI <input path to asset file(s)/folder> [options]

Common Workflow:

1. Info Mode: Use -m info to see how many assets are available for export before starting a large job.
2. Export Mode: Use -m export (default) to convert and export assets to a folder.
3. Extract Mode: Use -m extract to decompress asset bundles.
4. Output: Specify a destination with -o <path>. If omitted, assets are saved to an ASExport folder in the working directory.

To run the CLI, use the executable directly or use dotnet for portable versions (.NET 6+).

Standard command: AssetStudioModCLI <asset folder path>

Portable version (.NET 6+): dotnet AssetStudioModCLI.dll <asset folder path>

In the GUI version of AssetStudioMod, use the following workflows:

• Loading Assets/AssetBundles: Use File -> Load file or File -> Load folder. Warning: Loading AssetBundles directly into memory can consume significant RAM.

• Extracting/Decompressing AssetBundles: To avoid high memory usage, use File -> Extract file or File -> Extract folder to decompress AssetBundles to a local directory before reading them.

• Exporting Assets and Live2D models: Use the Export menu.

• Exporting Models: Use the Model menu from the "Scene Hierarchy" view.

For handling compressed asset bundles, use these advanced options:

Block Compression:

• --blockinfo-comp <value>: Compression type for blockInfo data (auto (default), zstd, oodle, lz4, lzma).
• --block-comp <value>: Compression type for block data (auto (default), zstd, oodle, lz4, lzma).

Decompression Behavior:

• --decompress-to-disk: (Flag) If not specified, only bundles larger than 2GB are decompressed to disk; otherwise, they are decompressed in RAM.

Control how exported files are organized and named using the following options:

Grouping (-g, --group-option <value>):

• none: No grouping.
• type: Group by type name.
• container (default): Group by container path.
• containerFull: Group by full container path (e.g., including prefab name).
• fileName: Group by source file name.
• sceneHierarchy: Group by node path in scene hierarchy.

Naming (-f, --filename-format <value>):

• assetName (default): assetName.extension
• assetName_pathID: assetName @pathID.extension
• pathID: pathID.extension

You can control which assets are processed using the -t, --asset-type and filtering options.

Asset Types (-t): Specify types using tex2d, tex2dArray, sprite, textAsset, monoBehaviour, font, shader, movieTexture, audio, video, or mesh. Use all (default) to export everything. Multiple types must be separated by , or ; without spaces.

Filtering Options:

• --filter-by-name <text>: Filter by name or regex.
• --filter-by-container <text>: Filter by container or regex.
• --filter-by-pathid <text>: Filter by specific PathIDs.
• --filter-by-text <text>: Search for text within names or containers.
• --filter-with-regex: Enables regular expression handling for the filters above (does not apply to --filter-by-pathid).

Specify the output format for media assets:

• --image-format <value>: Formats include none (exports as .tex raw data), jpg, png (default), bmp, or webp.
• --audio-format <value>: Formats include none (exports in original FMOD format) or wav (default).