Update readmes

aelurum · Sep 12, 2023 · be4ced7 · be4ced7
1 parent 2bd762e
commit be4ced7
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 15 deletions.
diff --git a/AssetStudioCLI/ReadMe.md b/AssetStudioCLI/ReadMe.md
@@ -1,6 +1,6 @@
 ## AssetStudioModCLI
 CLI version of AssetStudioMod.
-- Supported asset types: `Texture2D`, `Sprite`, `TextAsset`, `MonoBehaviour`, `Font`, `Shader`, `MovieTexture`, `AudioClip`, `VideoClip`, `Mesh`.
+- Supported asset types for export: `Texture2D`, `Sprite`, `TextAsset`, `MonoBehaviour`, `Font`, `Shader`, `MovieTexture`, `AudioClip`, `VideoClip`, `Mesh`.
 - *There are no plans to add support for `AnimationClip`, `Animator` for now.*
 
 ### Usage
@@ -11,11 +11,11 @@ AssetStudioModCLI <input path to asset file/folder> [-m, --mode <value>]
                       [--log-level <value>] [--log-output <value>]
                       [--image-format <value>] [--audio-format <value>]
                       [--fbx-scale-factor <value>] [--fbx-bone-size <value>]
-                      [--export-asset-list <value>] [--filter-by-name <text>]
-                      [--filter-by-container <text>] [--filter-by-pathid <text>]
-                      [--filter-by-text <text>] [--assembly-folder <path>]
+                      [--filter-by-name <text>] [--filter-by-container <text>]
+                      [--filter-by-pathid <text>] [--filter-by-text <text>]
+                      [--export-asset-list <value>] [--assembly-folder <path>]
                       [--unity-version <text>] [--not-restore-extension]
-
+                      [--load-all]
 
 General Options:
   -m, --mode <value>            Specify working mode
@@ -25,7 +25,7 @@ General Options:
                                 Dump - Makes asset dumps
                                 Info - Loads file(s), shows the number of available for export assets and exits
                                 Live2D - Exports Live2D Cubism 3 models
-                                SplitObjects - Export split objects (fbx)
+                                SplitObjects - Exports split objects (fbx)
                                 Example: "-m info"
 
   -t, --asset-type <value(s)>   Specify asset type(s) to export
@@ -78,12 +78,7 @@ FBX Options:
                                 <Value: integer number from 0 to 100 (default=10)
                                 Example: "--fbx-bone-size 10"
 
-Advanced Options:
-  --export-asset-list <value>   Specify the format in which you want to export asset list
-                                <Value: none(default) | xml>
-                                None - Do not export asset list
-                                Example: "--export-asset-list xml"
-
+Filter Options:
   --filter-by-name <text>       Specify the name by which assets should be filtered
                                 *To specify multiple names write them separated by ',' or ';' without spaces
                                 Example: "--filter-by-name char" or "--filter-by-name char,bg"
@@ -101,8 +96,21 @@ Advanced Options:
                                 *To specify multiple values write them separated by ',' or ';' without spaces
                                 Example: "--filter-by-text portrait" or "--filter-by-text portrait,art"
 
+
+Advanced Options:
+  --export-asset-list <value>   Specify the format in which you want to export asset list
+                                <Value: none(default) | xml>
+                                None - Do not export asset list
+                                Example: "--export-asset-list xml"
+
   --assembly-folder <path>      Specify the path to the assembly folder
-  --unity-version <text>        Specify Unity version. Example: "--unity-version 2017.4.39f1"
+
+  --unity-version <text>        Specify Unity version
+                                Example: "--unity-version 2017.4.39f1"
+
   --not-restore-extension       (Flag) If specified, AssetStudio will not try to use/restore original TextAsset
                                 extension name, and will just export all TextAssets with the ".txt" extension
+
+  --load-all                    (Flag) If specified, AssetStudio will load assets of all types
+                                (Only for Dump, Info and ExportRaw modes)
 ```
diff --git a/README.md b/README.md
@@ -89,13 +89,17 @@ AssetStudioModCLI <asset folder path> -g type
 ```
 AssetStudioModCLI <asset folder path> -o <output folder path>
 ```
+- Dump assets to a specified output folder
+```
+AssetStudioModCLI <asset folder path> -m dump -o <output folder path>
+```
 - Export Live2D Cubism models
 ```
 AssetStudioModCLI <asset folder path> -m live2d
 ```
 > When running in live2d mode you can only specify `-o`, `--log-level`, `--log-output`, `--export-asset-list`, `--unity-version` and `--assembly-folder` options.
 Any other options will be ignored.
-- Export all FBX objects (similar to "Export all objects (split)" in the GUI)
+- Export all FBX objects (similar to "Export all objects (split)" option in the GUI)
 ```
 AssetStudioModCLI <asset folder path> -m splitObjects
 ```
@@ -142,6 +146,14 @@ AssetStudioModCLI <asset folder path> -t monobehaviour --assembly-folder <assemb
 ```
 AssetStudioModCLI <asset folder path> --unity-version 2017.4.39f1
 ```
+- Load assets of all types and show them (similar to "Display all assets" option in the GUI)
+```
+AssetStudioModCLI <asset folder path> -m info --load-all
+```
+- Load assets of all types and dump Material assets
+```
+AssetStudioModCLI <asset folder path> -m dump -t material --load-all
+```
 
 ## GUI Usage
 
@@ -157,7 +169,7 @@ Use **File->Extract file** or **File->Extract folder**.
 
 ### Export Assets, Live2D models
 
-use **Export** menu.
+Use **Export** menu.
 
 ### Export Model