azlassets 4.0.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 can be copied to the new folder of the project:

• 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 und update logs used for extraction. Highly recommend to transfer to the new project folder.

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. The project can be installed using pip:

pip install azlassets

To create the config file to be able to edit it before first time 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 to cut down the 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, which will be explained in the following sections.

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 game clients (EN, JP, CN, KR, TW) and multiple forms of importing the assets. The recommended and easiest way is by downloading the .xapk from one of many Google Play Store app distributors (like APKMirror or 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

Alternatively, if the game is already installed, for example on emulators, you can copy the obb file onto your system and use it instead of the xapk. On Android it can be found in the folder /storage/emulated/0/Android/obb/[PACKAGE_NAME]/.

Since the CN client is not distributed through the Google Play Store, there is no xapk/obb file for it, but there is an android download link on the website which will download an apk file (not xapk like the others). Alternatively, the APK is installed in the folder /data/app/com.bilibili.azurlane-1/ on android (Note: Root access is required to access this folder).

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

azl import [FILEPATH]

Should the program not automatically detect which client these files belong to, an additional client argument can be added:

azl import [FILEPATH] -c {CLIENT}

Downloader

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

azl download [CLIENT]

where CLIENT has to be either EN, CN, JP, KR or TW. You can check which files have been downloaded or deleted using the difflog files in ClientAssets/[CLIENT]/difflog.

There are some additional arguments available:

• --force-refresh: Ignores the version check to run the downloader when on the newest version, useful after editing the config file
• --repair: Checks all files on disk and only downloads missing ones, useful for resuming the download if it crashed
• --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. The newly downloaded assets can be extracted by executing:

azl extract [CLIENT]

where CLIENT is again one of EN, CN, JP, KR or TW. The extracted images will then be saved in ClientExtract/[CLIENT]/ Since only Texture2D assets are exported, it's not desired to try to export from all assetbundles (See settings section).

A single assetbundle can be extracted by passing the filepath to the script:

azl extractor -f [FILEPATH]