azlassets 4.5.0

Azur Lane asset downloader and extractor

Azur Lane Asset Downloader and Extractor

This tool automatically downloads the newest assets directly from the game's CDN servers and allows extraction of Texture2D files as PNG images.

Upgrade Notice

From 2.x / no version number to 3.x+

When upgrading from versions 2.x or with no version number, the project has to be newly set up. To retain all current data, the following folders should be copied to the new working directory:

• config: Only user_config.yml is required, the rest can be deleted.
• ClientAssets or directory set in asset-directory of the config: Contains all currently downloaded assets, version information, and update logs used for extraction. Highly recommended to transfer to the new working directory.

Setup

Before installation, Python 3.11 or newer needs to be available on the system. It is recommended to set the project up using venv or a similar virtual environment manager.

Install the project using pip:

pip install azlassets

To create the config file for editing before first usage, execute azl in a terminal.

Settings

The config/user_config.yml file provides a few settings to filter which files will be downloaded and extracted. The options download-folder-listtype and extract-folder-listtype can be set to either "blacklist" or "whitelist". Depending on this it will filter by the top-level folder names (subfolders are not supported) or top-level filenames (files inside top-level folders or lower cannot be filtered) set in download-folder-list and extract-folder-list. This allows for reduced download and extraction times by skipping unneeded assets.

Usage

The program can be executed using azl <command> with different commands available depending on the desired functionality. The following commands are available, with additional short-form aliases:

Functionality	Command	Aliases
import files from archives	import	i
download files from game server	download	d
extract images	extract	x

Importer

Using this is not necessary to get all files, but recommended as the asset server may not have all files available. An import will guarantee that all game assets will be available on your system (if so desired) and avoid potentially spamming the asset server with errors of missing files on the first download.

The import supports all five game clients and multiple forms of importing the assets. The recommended and easiest way is by downloading the App Bundle from one of the Google Play Store app distributors (.apkm for APKMirror or .xapk for APKPure). They can be found by searching for the package name, which are as follows:

• EN: com.YoStarEN.AzurLane
• JP: com.YoStarJP.AzurLane
• KR: kr.txwy.and.blhx
• TW: com.hkmanjuu.azurlane.gp

If the game is already installed on emulators, copy the obb file to your system. On Android it can be found in /storage/emulated/0/Android/obb/[PACKAGE_NAME]/.

For CN client (not distributed through Google Play Store), download an APK from the official website. Alternatively, the APK can be found in /data/app/com.bilibili.azurlane-1/ on Android (Note: Root access required).

The import command can be executed by passing it the filepath to the apkm/xapk/apk/obb file:

azl import [FILEPATH]

If the program cannot detect the client automatically, specify it with:

azl import [FILEPATH] -c {CLIENT}

Downloader

All assets normally distributed via the in-app downloader can be downloaded by executing:

azl download [CLIENT]

Where CLIENT is one of EN, CN, JP, KR or TW. Check downloaded/deleted files using difflog files in ClientAssets/[CLIENT]/difflog.

Additional Arguments

• -e, --extract: Automatically starts the extraction routine after the download
• --force-refresh: Ignores version check, useful after editing config
• --repair: Checks all files and downloads only missing ones, useful for resuming crashed downloads
• --check-integrity: Checks for modified, deleted, or corrupt files and redownloads them
• --skip-unknown-version-error: Ignores the error when a new version type gets added to the game

Extractor

The asset extraction supports extraction of all newly downloaded files or single asset bundles and directories.

azl extract [CLIENT]

Where CLIENT is one of EN, CN, JP, KR or TW. Extracted images will be saved in ClientExtract/[CLIENT]/ in a subdirectory with the version information as the name. Since only Texture2D assets are exported, it's not desired to try to export from all assetbundles (See settings section).

Extraction of specific versions

Using the -v or --version argument, specific versions and version types can be extracted, including older ones (although it will extract the currently available version of the file if was updated again since then). The syntax for this follows PEP440/PEP508 version specifiers. By default this will extract linked versions as well.

Here are some examples:

version specifier	extracted files
AZL==9.3.110	from "AZL" version type of version "9.3.110"
MANGA>=56	from "MANGA" version type of versions "56" and newer
AZL>9.3.186;PAINTING>35	from "AZL" of versions newer than "9.3.186" and "PAINTING" of versions newer than "35"

Extraction using filepath

Using the -f or --filepath argument, a path for extraction can be passed to the program:

azl extractor -f [FILEPATH]

The path can be either to a single assetbundle or a directory. In the case of a directory, all subdiretories will be recursively extracted as well. The path can be either an absolute path, or a relative path which needs to be relative to the AssetBundles directory of a client, in which case the client needs to be added as an argument as well.

Linked version extraction

Linked versions are extracted by default. To disable this, add the no-linked-versions argument:

azl extract [CLIENT] --no-linked-versions