Skip to content

Commit

Permalink
Update readme and other text files
Browse files Browse the repository at this point in the history
  • Loading branch information
aelurum committed Apr 4, 2024
1 parent 1fc504e commit 5120999
Show file tree
Hide file tree
Showing 6 changed files with 82 additions and 24 deletions.
4 changes: 2 additions & 2 deletions AssetStudioCLI/Options/CLIOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@ private static void InitOptions()
optionDefaultValue: exportableAssetTypes,
optionName: "-t, --asset-type <value(s)>",
optionDescription: "Specify asset type(s) to export\n" +
"<Value(s): tex2d, sprite, textAsset, monoBehaviour, font, shader, movieTexture,\n" +
"audio, video, mesh | all(default)>\n" +
"<Value(s): tex2d, tex2dArray, sprite, textAsset, monoBehaviour, font, shader\n" +
"movieTexture, audio, video, mesh | all(default)>\n" +
"All - export all asset types, which are listed in the values\n" +
"*To specify multiple asset types, write them separated by ',' or ';' without spaces\n",
optionExample: "Examples: \"-t sprite\" or \"-t tex2d,sprite,audio\" or \"-t tex2d;sprite;font\"\n",
Expand Down
35 changes: 25 additions & 10 deletions AssetStudioCLI/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ AssetStudioModCLI <input path to asset file/folder> [-m, --mode <value>]
[--l2d-force-bezier] [--fbx-scale-factor <value>]
[--fbx-bone-size <value>] [--filter-by-name <text>]
[--filter-by-container <text>] [--filter-by-pathid <text>]
[--filter-by-text <text>] [--export-asset-list <value>]
[--filter-by-text <text>] [--custom-compression <value>]
[--max-export-tasks <value>] [--export-asset-list <value>]
[--assembly-folder <path>] [--unity-version <text>]
[--not-restore-extension] [--load-all]
[--not-restore-extension] [--avoid-typetree-loading]
[--load-all]
General Options:
-m, --mode <value> Specify working mode
Expand All @@ -26,13 +27,13 @@ General Options:
ExportRaw - Exports raw data
Dump - Makes asset dumps
Info - Loads file(s), shows the number of available for export assets and exits
Live2D - Exports Live2D Cubism 3 models
Live2D - Exports Live2D Cubism models
SplitObjects - Exports split objects (fbx)
Example: "-m info"
-t, --asset-type <value(s)> Specify asset type(s) to export
<Value(s): tex2d, sprite, textAsset, monoBehaviour, font, shader, movieTexture,
audio, video, mesh | all(default)>
<Value(s): tex2d, tex2dArray, sprite, textAsset, monoBehaviour, font, shader
movieTexture, audio, video, mesh | all(default)>
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 tex2d,sprite,audio" or "-t tex2d;sprite;font"
Expand Down Expand Up @@ -74,9 +75,9 @@ Convert Options:
None - Do not convert images and export them as texture data (.tex)
Example: "--image-format jpg"
--audio-format <value> Specify the format for converting audio assets
--audio-format <value> Specify the format for converting FMOD audio assets
<Value: none | wav(default)>
None - Do not convert audios and export them in their own format
None - Do not convert fmod audios and export them in their own format
Example: "--audio-format wav"
Live2D Options:
Expand All @@ -92,11 +93,11 @@ Live2D Options:
FBX Options:
--fbx-scale-factor <value> Specify the FBX Scale Factor
<Value: float number from 0 to 100 (default=1)
<Value: float number from 0 to 100 (default=1)>
Example: "--fbx-scale-factor 50"
--fbx-bone-size <value> Specify the FBX Bone Size
<Value: integer number from 0 to 100 (default=10)
<Value: integer number from 0 to 100 (default=10)>
Example: "--fbx-bone-size 10"
Filter Options:
Expand All @@ -119,6 +120,17 @@ Filter Options:
Advanced Options:
--custom-compression <value> Specify the compression type for assets that use custom compression
<Value: zstd(default) | lz4>
Zstd - Try to decompress as zstd archive
Lz4 - Try to decompress as lz4 archive
Example: "--custom-compression lz4"
--max-export-tasks <value> Specify the number of parallel tasks for asset export
<Value: integer number from 1 to max number of cores (default=max)>
Max - Number of cores in your CPU
Example: "--max-export-tasks 8"
--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
Expand All @@ -132,6 +144,9 @@ Advanced Options:
--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
--avoid-typetree-loading (Flag) If specified, AssetStudio will not try to parse assets at load time
using their type tree
--load-all (Flag) If specified, AssetStudio will load assets of all types
(Only for Dump, Info and ExportRaw modes)
```
2 changes: 1 addition & 1 deletion AssetStudioUtility/ModelConverter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public class ModelConverter : IImported

private ImageFormat imageFormat;
private Avatar avatar;
private AnimationClip[] animationClipUniqArray = Array.Empty<AnimationClip>();
private AnimationClip[] animationClipUniqArray = Array.Empty<AnimationClip>(); //TODO: a proper AnimationClip equality comparer
private Dictionary<AnimationClip, string> boundAnimationPathDic = new Dictionary<AnimationClip, string>();
private Dictionary<uint, string> bonePathHash = new Dictionary<uint, string>();
private Dictionary<Texture2D, string> textureNameDictionary = new Dictionary<Texture2D, string>();
Expand Down
46 changes: 46 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,51 @@
# Changelog

## v0.18.0.0 [04-04-2024]
#### Breaking Changes
- Structure of the AnimationClip class has been changed a bit to match the structure of its type tree (`m_Clip = animationClip.m_MuscleClip.m_Clip` -> `m_Clip = animationClip.m_MuscleClip.m_Clip.data`)
- Types of Unity version fields have been changed from `int[]` to the `UnityVersion` class

#### New features
- Added option to export assets with PathID in filename (https://github.com/aelurum/AssetStudio/issues/25)
- Added support for swizzled Switch textures:
- Ported from nesrak1's fork (https://github.com/nesrak1/AssetStudio/tree/switch-tex-deswizzle)
- Added support for `Texture2DArray` assets:
- [GUI] Assets of fake asset type `Texture2DArrayImage` will be generated, to make it easier to work with images from array in the GUI
- Added support for assets with Zstd block compression:
- Implemented as one of the option for custom compression type (5). Selected by default.
- [GUI] "Options" -> "Custom compression type"
- [CLI] "--custom-compression"
- Added support of Texture2D assets from Unity 2023.2+
- Added support of parallel asset export
- It's also possible to specify the number of parallel tasks for export in both the GUI and CLI (the higher the number of parallel tasks, the more RAM may be needed for exporting)
- Added support for parsing assets using their type tree for some asset types (`Texture2D`, `Texture2DArray`, `AnimationClip`) (beta):
> only suitable for asset bundles which contain typetree info
#### Fixes
- [GUI] Fixed compatibility with High Contrast modes
- Fixed Live2D export error due to wrong Blend type in Live2D expression parser
- Fixed AssetBundle structure for Unity v5.4.x (https://github.com/aelurum/AssetStudio/issues/31)
- Fixed loading of some Unity 2019.4 assets

#### Other changes
- [GUI] Preserve selection order of `AnimationClip` assets (https://github.com/aelurum/AssetStudio/issues/24)
- Improved integration with Live2D assets:
- Improved export method of AnimationClip motions
- Added support for generation of cdi3.json (beta)
- [GUI] Added display of model info on the preview tab
- [GUI] Added support for partial export:
- selected models
- model + selected AnimationClip motions
- model + selected Fade motions
- model + selected Fade Motion List
- Add more options to work with Scene Hierarchy: (https://github.com/aelurum/AssetStudio/issues/23)
- Added option to group exported assets by node path in scene hierarchy
- Added field with node path to exported xml asset list
- [CLI] Added colors to help message
- Changed Dump function to show/export object dump if type tree dump is not available
- Added more displayed information for non-fmod audio clips
- Added display of asset bundle's unity version in cases where asset's unity version is stripped but the asset bundle's unity version is not

## v0.17.4.0 [16-12-2023]
- Added support for Live2D Fade motions
- [GUI] Added related settings to the Export Options window
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ MIT License

Copyright (c) 2016 Radu
Copyright (c) 2016-2022 Perfare
Copyright (c) 2021-2023 aelurum
Copyright (c) 2021-2024 aelurum

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# AssetStudioMod

[![Build status](https://ci.appveyor.com/api/projects/status/5qyai0hqs0ktyara/branch/AssetStudioMod?svg=true)](https://ci.appveyor.com/project/aelurum/assetstudiomod/branch/AssetStudioMod)
[![Release](https://img.shields.io/github/v/release/aelurum/AssetStudio)](https://github.com/aelurum/AssetStudio/releases/latest) [![Downloads](https://img.shields.io/github/downloads/aelurum/AssetStudio/total?color=blue)](https://github.com/aelurum/AssetStudio/releases/latest) [![Download latest release](https://img.shields.io/badge/Download_latest_release-blue)](https://github.com/aelurum/AssetStudio/releases/latest)

[![Build status](https://ci.appveyor.com/api/projects/status/5qyai0hqs0ktyara/branch/AssetStudioMod?svg=true)](https://ci.appveyor.com/project/aelurum/assetstudiomod/branch/AssetStudioMod) [![Download latest build](https://img.shields.io/badge/Download_latest_build-brightgreen)](https://ci.appveyor.com/project/aelurum/assetstudiomod/branch/AssetStudioMod/artifacts)

**AssetStudioMod** - modified version of Perfare's [AssetStudio](https://github.com/Perfare/AssetStudio), mainly focused on UI optimization and some functionality enhancements.

**Neither the repository, nor the tool, nor the author of the tool, nor the author of the modification is affiliated with, sponsored, or authorized by Unity Technologies or its affiliates.**

Since the original repo has been archived, it's worth saying that you shouldn't expect support for newer versions of Unity from this fork.
Unfortunately, I can't continue Perfare's work and keep AssetStudio up to date.

## Game specific modifications

- [ArknightsStudio](https://github.com/aelurum/AssetStudio/tree/ArknightsStudio)

## AssetStudio Features

- Support version:
- 3.4 - 2022.3
- 3.4 - 2023.2
- Support asset types:
- **Texture2D** : convert to png, tga, jpeg, bmp, webp
- **Texture2D**, **Texture2DArray** : convert to png, tga, jpeg, bmp, webp
- **Sprite** : crop Texture2D to png, tga, jpeg, bmp, webp
- **AudioClip** : mp3, ogg, wav, m4a, fsb. Support converting FSB file to WAV(PCM)
- **Font** : ttf, otf
Expand All @@ -39,21 +38,19 @@ Unfortunately, I can't continue Perfare's work and keep AssetStudio up to date.
- Support of Live2D Cubism model export
- Ported from my fork of Perfare's [UnityLive2DExtractor](https://github.com/aelurum/UnityLive2DExtractor)
- Using the Live2D export in AssetStudio allows you to specify a Unity version and assembly folder if needed
- Support of swizzled Switch textures
- Ported from nesrak1's [AssetStudio fork](https://github.com/nesrak1/AssetStudio/tree/switch-tex-deswizzle)
- Detecting bundles with UnityCN encryption
- Detection only. If you want to open them, please use Razmoth's [Studio](https://github.com/RazTools/Studio)
- Some UI optimizations and bug fixes (See [CHANGELOG](https://github.com/aelurum/AssetStudio/blob/AssetStudioMod/CHANGELOG.md) for details)


## Requirements

- AssetStudioMod.net472
- GUI/CLI - [.NET Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework/net472)
- AssetStudioMod.net6
- GUI/CLI (Windows) - [.NET Desktop Runtime 6.0](https://dotnet.microsoft.com/download/dotnet/6.0)
- CLI (Linux/Mac) - [.NET Runtime 6.0](https://dotnet.microsoft.com/download/dotnet/6.0)
- AssetStudioMod.net7
- GUI/CLI (Windows) - [.NET Desktop Runtime 7.0](https://dotnet.microsoft.com/download/dotnet/7.0)
- CLI (Linux/Mac) - [.NET Runtime 7.0](https://dotnet.microsoft.com/download/dotnet/7.0)
- AssetStudioMod.net8
- GUI/CLI (Windows) - [.NET Desktop Runtime 8.0](https://dotnet.microsoft.com/download/dotnet/8.0)
- CLI (Linux/Mac) - [.NET Runtime 8.0](https://dotnet.microsoft.com/download/dotnet/8.0)
Expand Down

0 comments on commit 5120999

Please sign in to comment.