diff --git a/AssetStudioCLI/ReadMe.md b/AssetStudioCLI/ReadMe.md new file mode 100644 index 0000000..f281e4d --- /dev/null +++ b/AssetStudioCLI/ReadMe.md @@ -0,0 +1,96 @@ +## AssetStudioCLI +CLI version of AssetStudio Mod. +- Supported asset types: `Texture2D`, `Sprite`, `TextAsset`, `MonoBehaviour`, `Font`, `Shader`, `MovieTexture`, `AudioClip`, `VideoClip` +- *There are no plans to add support for `Mesh`/`AnimationClip`/`Animator` for now* + +### Usage +``` +AssetStudioCLI [-m, --mode ] + [-t, --asset-type ] [-g, --group-option ] + [-o, --output ] [-h, --help] + [--log-level ] [--log-output ] + [--image-format ] [--audio-format ] + [--export-asset-list ] [--filter-by-name ] + [--filter-by-container ] [--filter-by-pathid ] + [--filter-by-text ] [--assembly-folder ] + [--unity-version ] [--not-restore-extension] + + + +General Options: + -m, --mode Specify working mode + + Export - Exports converted assets + ExportRaw - Exports raw data + Dump - Makes asset dumps + Info - Loads file(s), shows the number of supported for export assets and exits + Example: "-m info" + + -t, --asset-type Specify asset type(s) to export + + All - export all asset types, which are listed in the values + *To specify multiple asset types, write them separated by ',' or ';' without spaces + Examples: "-t sprite" or "-t all" or "-t tex2d,sprite,audio" or "-t tex2d;sprite;font" + + -g, --group-option Specify the way in which exported assets should be grouped + + None - Do not group exported assets + Type - Group exported assets by type name + Container - Group exported assets by container path + Filename - Group exported assets by source file name + Example: "-g container" + + -o, --output Specify path to the output folder + If path isn't specifyed, 'ASExport' folder will be created in the program's work folder + + -h, --help Display help and exit + +Logger Options: + --log-level Specify the log level + + Example: "--log-level warning" + + --log-output Specify the log output + + Example: "--log-output both" + +Convert Options: + --image-format Specify the format for converting image assets + + None - Do not convert images and export them as texture data (.tex) + Example: "--image-format jpg" + + --audio-format Specify the format for converting audio assets + + None - Do not convert audios and export them in their own format + Example: "--audio-format wav" + +Advanced Options: + --export-asset-list Specify the format in which you want to export asset list + + None - Do not export asset list + Example: "--export-asset-list xml" + + --filter-by-name 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" + + --filter-by-container Specify the container by which assets should be filtered + *To specify multiple containers write them separated by ',' or ';' without spaces + Example: "--filter-by-container arts" or "--filter-by-container arts,icons" + + --filter-by-pathid Specify the PathID by which assets should be filtered + *To specify multiple PathIDs write them separated by ',' or ';' without spaces + Example: "--filter-by-pathid 7238605633795851352,-2430306240205277265" + + --filter-by-text Specify the text by which assets should be filtered + Looks for assets that contain the specified text in their names or containers + *To specify multiple values write them separated by ',' or ';' without spaces + Example: "--filter-by-text portrait" or "--filter-by-text portrait,art" + + --assembly-folder Specify the path to the assembly folder + --unity-version Specify Unity version. Example: "--unity-version 2017.4.39f1" + --not-restore-extension (Flag) If specified, AssetStudio will not try to restore TextAssets extension name, + and will just export all TextAssets with the ".txt" extension +```