azlassets 3.3.0__tar.gz

azlassets-3.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 nobbyfix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

azlassets-3.3.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: azlassets
+Version: 3.3.0
+Summary: Azur Lane asset downloader and extractor
+Author: nobbyfix
+Project-URL: homepage, https://github.com/nobbyfix/AzurLane-AssetDownloader
+Project-URL: repository, https://github.com/nobbyfix/AzurLane-AssetDownloader.git
+Project-URL: issues, https://github.com/nobbyfix/AzurLane-AssetDownloader/issues
+Project-URL: changelog, https://github.com/nobbyfix/AzurLane-AssetDownloader/blob/master/CHANGELOG.md
+Project-URL: download, https://github.com/nobbyfix/AzurLane-AssetDownloader/releases/latest
+Keywords: azurlane,azur-lane
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: UnityPy>=1.10.18
+Requires-Dist: PyYAML
+Requires-Dist: Pillow
+Requires-Dist: protobuf
+Requires-Dist: aiofile
+Requires-Dist: aiohttp[speedups]
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Dynamic: license-file
+
+# 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](https://docs.python.org/3/tutorial/venv.html) or a similar virtual environment manager. The project can be installed using pip:
+
+```
+pip install azlassets
+```
+
+Alternatively, to install the newest version from the repository (requires git on the system):
+```
+pip install git+https://github.com/nobbyfix/AzurLane-AssetDownloader.git
+```
+
+## Usage
+There are three scripts to manage the assets:
+- `obb_apk_import`: Importing assets from obb/apk/xapk files
+- `downlader`: Downloading assets from the game server
+- `extractor`: Extract PNGs from the assets
+
+These can be executed using `py -m <scriptname>` on Windows or `python3 -m <scriptname>` on Linux/macOS (will be shortened to `py[thon3]` going forward, use the appropriate version for your system). Detailed usage will be explained in the following sections.
+
+### 1. Import files from xapk/apk/obb
+While this is *not necessary*, this step is **recommended** if you want all game assets available and not spam the game update server with errors of missing files on the first download.
+
+The `obb_apk_import.py` 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). You can find them 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 you already have the game 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 you can find the android download link on the [website](https://game.bilibili.com/blhx/) 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).
+
+You can then execute the script by passing it the filepath to the xapk/apk/obb:
+```
+py[thon3] -m obb_apk_import [FILEPATH]
+```
+
+### 2. Settings
+The `config/user_config.yml` file provides a few settings to filter which files will be downloaded (and later also 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.
+
+### 3. Download new updates from the game
+All assets normally distributed via the in-app downloader can be downloaded by simply executing:
+```
+py[thon3] -m downloader [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`.
+
+### 4. Extract all new and changed files
+The asset extraction script supports extraction of all newly downloaded files and single asset bundles. The newly downloaded assets can be extracted by executing:
+```
+py[thon3] -m extractor [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](#2-settings)).
+
+A single assetbundle can be extracted by passing the filepath to the script:
+```
+py[thon3] -m extractor -f [FILEPATH]
+```
+
+### 5. Enjoy the files

azlassets-3.3.0/README.md

@@ -0,0 +1,70 @@
+# 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](https://docs.python.org/3/tutorial/venv.html) or a similar virtual environment manager. The project can be installed using pip:
+
+```
+pip install azlassets
+```
+
+Alternatively, to install the newest version from the repository (requires git on the system):
+```
+pip install git+https://github.com/nobbyfix/AzurLane-AssetDownloader.git
+```
+
+## Usage
+There are three scripts to manage the assets:
+- `obb_apk_import`: Importing assets from obb/apk/xapk files
+- `downlader`: Downloading assets from the game server
+- `extractor`: Extract PNGs from the assets
+
+These can be executed using `py -m <scriptname>` on Windows or `python3 -m <scriptname>` on Linux/macOS (will be shortened to `py[thon3]` going forward, use the appropriate version for your system). Detailed usage will be explained in the following sections.
+
+### 1. Import files from xapk/apk/obb
+While this is *not necessary*, this step is **recommended** if you want all game assets available and not spam the game update server with errors of missing files on the first download.
+
+The `obb_apk_import.py` 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). You can find them 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 you already have the game 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 you can find the android download link on the [website](https://game.bilibili.com/blhx/) 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).
+
+You can then execute the script by passing it the filepath to the xapk/apk/obb:
+```
+py[thon3] -m obb_apk_import [FILEPATH]
+```
+
+### 2. Settings
+The `config/user_config.yml` file provides a few settings to filter which files will be downloaded (and later also 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.
+
+### 3. Download new updates from the game
+All assets normally distributed via the in-app downloader can be downloaded by simply executing:
+```
+py[thon3] -m downloader [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`.
+
+### 4. Extract all new and changed files
+The asset extraction script supports extraction of all newly downloaded files and single asset bundles. The newly downloaded assets can be extracted by executing:
+```
+py[thon3] -m extractor [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](#2-settings)).
+
+A single assetbundle can be extracted by passing the filepath to the script:
+```
+py[thon3] -m extractor -f [FILEPATH]
+```
+
+### 5. Enjoy the files

azlassets-3.3.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "azlassets"
+authors = [{ name = "nobbyfix" }]
+description ="Azur Lane asset downloader and extractor"
+readme = "README.md"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dynamic = ["version"]
+dependencies = [
+    "UnityPy >= 1.10.18",
+    "PyYAML",
+    "Pillow",
+    "protobuf",
+    "aiofile",
+    "aiohttp[speedups]"
+]
+keywords = [
+    "azurlane",
+    "azur-lane"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Topic :: Games/Entertainment"
+]
+
+[project.optional-dependencies]
+dev = ["pre-commit"]
+
+[project.urls]
+homepage = "https://github.com/nobbyfix/AzurLane-AssetDownloader"
+repository = "https://github.com/nobbyfix/AzurLane-AssetDownloader.git"
+issues = "https://github.com/nobbyfix/AzurLane-AssetDownloader/issues"
+changelog = "https://github.com/nobbyfix/AzurLane-AssetDownloader/blob/master/CHANGELOG.md"
+download = "https://github.com/nobbyfix/AzurLane-AssetDownloader/releases/latest"
+
+[tool.setuptools.dynamic]
+version = { attr = "azlassets.__version__" }
+
+[tool.setuptools.package-data]
+"azlassets.config" = ["*.json", "*.yml"]

azlassets-3.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

azlassets-3.3.0/src/azlassets/__init__.py

@@ -0,0 +1 @@
+__version__ = "3.3.0" # x-release-please-version

azlassets-3.3.0/src/azlassets/classes.py

@@ -0,0 +1,191 @@
+from enum import Enum
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Self
+
+
+CompareType = Enum('CompareType', 'New Changed Unchanged Deleted')
+DownloadType = Enum('DownloadType', 'NoChange Removed Success Failed ForDeletionNoChange')
+
+class VersionType(Enum):
+	__hash2member_map__: dict[str, Self] = {}
+	hashname: str
+	"""Hash name used on the version result returned by the game server."""
+	suffix: str
+	"""Suffix used on version and hash files."""
+
+	AZL			= (1,	"azhash",		"")
+	CV			= (2,	"cvhash",		"cv")
+	L2D			= (3,	"l2dhash",		"live2d")
+	PIC			= (4,	"pichash",		"pic")
+	BGM			= (5,	"bgmhash",		"bgm")
+	CIPHER		= (6,	"cipherhash",	"cipher")
+	MANGA		= (7,	"mangahash",	"manga")
+	PAINTING	= (8,	"paintinghash",	"painting")
+	DORM		= (9,	"dormhash",		"dorm")
+	MAP			= (10,	"maphash",		"map")
+
+
+	def __init__(self, _, hashname, suffix) -> None:
+		# add attributes to enum objects
+		self.hashname = hashname
+		self.suffix = suffix
+		# add enum objects to member maps
+		self.__hash2member_map__[hashname] = self
+
+	def __str__(self) -> str:
+		return self.name.lower()
+
+	@property
+	def version_filename(self) -> str:
+		"""
+		Full version filename using the suffix.
+		"""
+		suffix = self.suffix
+		if suffix: suffix = "-"+suffix
+		return f"version{suffix}.txt"
+
+	@property
+	def hashes_filename(self) -> str:
+		"""
+		Full hashes filename using the suffix.
+		"""
+		suffix = self.suffix
+		if suffix: suffix = "-"+suffix
+		return f"hashes{suffix}.csv"
+
+	@classmethod
+	def from_hashname(cls, hashname: str) -> Self | None:
+		"""
+		Returns a VersionType member with matching *hashname* if match exists, otherwise None.
+		"""
+		return cls.__hash2member_map__.get(hashname)
+
+
+class AbstractClient(Enum):
+	active: bool
+	locale_code: str
+	package_name: str
+
+	def __new__(cls, value, active, locale, package_name):
+		# this should be done differently, but i am too lazy to do that now
+		# TODO: change it
+		if not hasattr(cls, "package_names"):
+			cls.package_names = {}
+
+		obj = object.__new__(cls)
+		obj._value_ = value
+		obj.active = active
+		obj.locale_code = locale
+		obj.package_name = package_name
+		cls.package_names[package_name] = obj
+		return obj
+
+	@classmethod
+	def from_package_name(cls, package_name) -> Self | None:
+		return cls.package_names.get(package_name)
+
+
+class Client(AbstractClient):
+	EN = (1, True, 'en-US', 'com.YoStarEN.AzurLane')
+	JP = (2, True, 'ja-JP', 'com.YoStarJP.AzurLane')
+	CN = (3, True, 'zh-CN', '')
+	KR = (4, True, 'ko-KR', 'kr.txwy.and.blhx')
+	TW = (5, True, 'zh-TW', 'com.hkmanjuu.azurlane.gp')
+
+
+@dataclass
+class HashRow:
+	filepath: str
+	size: int
+	md5hash: str
+
+@dataclass
+class CompareResult:
+	current_hash: HashRow | None
+	new_hash: HashRow | None
+	compare_type: CompareType
+
+@dataclass
+class VersionResult:
+	version: str
+	vhash: str
+	rawstring: str
+	version_type: VersionType
+
+@dataclass
+class BundlePath:
+	full: Path
+	inner: str
+
+	@staticmethod
+	def construct(parentdir: Path, inner: Path | str) -> "BundlePath":
+		fullpath = Path(parentdir, inner)
+		return BundlePath(fullpath, str(inner))
+
+	def __hash__(self):
+		return hash(self.inner)
+
+@dataclass
+class UpdateResult:
+	compare_result: CompareResult
+	download_type: DownloadType
+	path: BundlePath
+
+@dataclass
+class UserConfig:
+	useragent: str
+	download_isblacklist: bool
+	download_filter: list
+	extract_isblacklist: bool
+	extract_filter: list
+	asset_directory: Path
+	extract_directory: Path
+
+@dataclass
+class ClientConfig:
+	gateip: str
+	gateport: int
+	cdnurl: str
+
+
+# stolen from https://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console
+def printProgressBar(iteration, total, prefix = '', suffix = 'Complete', decimals = 1, length = 50, fill = '█', printEnd = "\r", details_unit = None):
+	"""
+	Call in a loop to create terminal progress bar
+	@params:
+		iteration	- Required  : current iteration (Int)
+		total		- Required  : total iterations (Int)
+		prefix		- Optional  : prefix string (Str)
+		suffix		- Optional  : suffix string (Str)
+		decimals	- Optional  : positive number of decimals in percent complete (Int)
+		length		- Optional  : character length of bar (Int)
+		fill		- Optional  : bar fill character (Str)
+		printEnd	- Optional  : end character (e.g. "\r", "\r\n") (Str)
+	"""
+	percent = ("{0:." + str(decimals) + "f}").format(100 * (iteration / float(total)))
+	filledLength = int(length * iteration // total)
+	progress = fill * filledLength + '-' * (length - filledLength)
+	details = f" [{iteration}/{total} {details_unit}]" if details_unit else ""
+	print(f'\r{prefix} |{progress}| {percent}% {suffix}{details}', end = printEnd)
+	# Print New Line on Complete
+	if iteration == total:
+		print()
+
+# simplified progress bar class with only the useful stuff i use
+class ProgressBar():
+	def __init__(self, total: int, prefix: str, suffix: str = "Complete", iterstart: int = 0, details_unit: str | None = None, print_on_init: bool = True):
+		self.iteration = iterstart
+		self.total = total
+		self.prefix = prefix
+		self.suffix = suffix
+		self.details_unit = details_unit
+		if print_on_init:
+			printProgressBar(iterstart, total, prefix, suffix, details_unit=details_unit)
+
+	def update(self, iteration: int | None = None):
+		if iteration:
+			self.iteration = iteration
+		else:
+			self.iteration += 1
+		printProgressBar(self.iteration, self.total, self.prefix, self.suffix, details_unit=self.details_unit)

azlassets-3.3.0/src/azlassets/config/client_config.json

@@ -0,0 +1,27 @@
+{
+	"EN": {
+		"gateip": "blhxusgate.yo-star.com",
+		"gateport": 80,
+		"cdnurl": "https://blhxusstatic.yo-star.com"
+	},
+	"CN": {
+		"gateip": "line1-login-bili-blhx.bilibiligame.net",
+		"gateport": 80,
+		"cdnurl": "https://line3-patch-blhx.bilibiligame.net"
+	},
+	"JP": {
+		"gateip": "blhxjploginapi.azurlane.jp",
+		"gateport": 80,
+		"cdnurl": "https://blhxstatic.yo-star.com"
+	},
+	"KR": {
+		"gateip": "bl-kr-gate.xdg.com",
+		"gateport": 80,
+		"cdnurl": "http://blcdn.imtxwy.com"
+	},
+	"TW": {
+		"gateip": "prod-all-login.azurlane.tw",
+		"gateport": 10080,
+		"cdnurl": "http://blhxstatic.azurlane.tw"
+	}
+}

azlassets-3.3.0/src/azlassets/config/user_config_template.yml

@@ -0,0 +1,61 @@
+asset-directory: ClientAssets
+extract-directory: ClientExtract
+# set to blacklist or whitelist
+download-folder-listtype: blacklist
+extract-folder-listtype: whitelist
+download-folder-list: []
+extract-folder-list:
+- activitybanner
+- aircrafticon
+- backyardtheme
+- battlescore
+- bg
+- boxprefab
+- chargeicon
+- clutter
+- collectionfileillustration
+- collectionfiletitle
+- commanderhrz
+- commandericon
+- commanderskillicon
+- commandertalenticon
+- commonbg
+- crusingwindow
+- emblem
+- enemies
+- equips
+- eventtype
+- extra_page
+- furnitureicon
+- gallerycard
+- guildnode
+- guildboss
+- guildevent
+- guildmission
+- helpbg
+- herohrzicon
+- icondesc
+- iconframe
+- independenttex
+- levelmap
+- loadingbg
+- lotterybg
+- mangapic
+- medal
+- memoryicon
+- metaship
+- musiccover
+- newshipbg
+- newyearskinshowpage
+- painting
+- prints
+- props
+- qicon
+- shipmodels
+- shiprarity
+- shipyardicon
+- skillicon
+- squareicon
+- strategyicon
+- updatebg
+useragent: ''

azlassets-3.3.0/src/azlassets/config.py

@@ -0,0 +1,62 @@
+import sys
+import json
+import yaml
+from shutil import copy
+from pathlib import Path
+from importlib.resources import files
+
+from .classes import Client, UserConfig, ClientConfig
+
+
+# package-incuded filepaths
+CONFIG_DATA_PATH = files("azlassets").joinpath("config")
+YAML_TEMPLATE_PATH = CONFIG_DATA_PATH.joinpath("user_config_template.yml")
+CLIENT_CONFIG_PATH = CONFIG_DATA_PATH.joinpath("client_config.json")
+
+# cwd-relative filepaths
+YAML_CONFIG_PATH = Path("config") / "user_config.yml"
+
+
+def load_user_config() -> UserConfig:
+	if not YAML_CONFIG_PATH.exists():
+		print("Userconfig does not exist. A new one will be created.")
+		print("Note that the useragent is empty and it is advised to set one.")
+		YAML_CONFIG_PATH.parent.mkdir(parents=True, exist_ok=True)
+		copy(YAML_TEMPLATE_PATH, YAML_CONFIG_PATH)
+		return load_user_config()
+
+	with open(YAML_CONFIG_PATH, 'r', encoding='utf8') as file:
+		yamlconfig = yaml.safe_load(file)
+
+	try:
+		userconfig = UserConfig(
+			useragent=yamlconfig['useragent'],
+			download_isblacklist=yamlconfig['download-folder-listtype'] == 'blacklist',
+			download_filter=yamlconfig['download-folder-list'],
+			extract_isblacklist=yamlconfig['extract-folder-listtype'] == 'blacklist',
+			extract_filter=yamlconfig['extract-folder-list'],
+			asset_directory=yamlconfig['asset-directory'],
+			extract_directory=yamlconfig['extract-directory'],
+		)
+	except KeyError:
+		print("There is an error inside the userconfig file. Delete it or change the wrong values.")
+		sys.exit(1)
+
+	return userconfig
+
+
+def load_client_config(client: Client) -> ClientConfig:
+	with open(CLIENT_CONFIG_PATH, 'r', encoding='utf8') as f:
+		configdata = json.load(f)
+
+	if not client.name in configdata:
+		raise NotImplementedError(f'Client {client.name} has not been configured yet.')
+
+	config = configdata[client.name]
+	try:
+		clientconfig = ClientConfig(config['gateip'], config['gateport'], config['cdnurl'])
+	except KeyError:
+		print("The clientconfig has been wrongly configured.")
+		sys.exit(1)
+
+	return clientconfig

azlassets-3.3.0/src/azlassets/downloader.py

@@ -0,0 +1,61 @@
+import aiohttp
+import aiofile
+import traceback
+from pathlib import Path
+
+from .classes import VersionResult
+
+
+class AzurlaneAsyncDownloader(aiohttp.ClientSession):
+	def __init__(self, cdn_url: str, useragent: str):
+		base_url = f"{cdn_url}/android/"
+		limited_tcp_connector = aiohttp.TCPConnector(limit_per_host=6)
+		super().__init__(base_url=base_url, headers={"user-agent": useragent}, connector=limited_tcp_connector)
+
+	async def get_hashes(self, versionhash: str) -> aiohttp.ClientResponse:
+		return await self.get(f"hash/{versionhash}")
+
+	async def get_asset(self, filehash: str) -> aiohttp.ClientResponse:
+		return await self.get(f"resource/{filehash}")
+
+	async def download_hashes(self, version_result: VersionResult) -> str | None:
+		try:
+			async with await self.get_hashes(version_result.rawstring) as response:
+				response: aiohttp.ClientResponse
+				response.raise_for_status() # raises error on bad HTTP status
+
+				hashes = await response.text()
+				return hashes
+
+		except Exception as e:
+			print(f"ERROR: An unexpected error occured while downloading '{version_result.version_type.name}' hashfile.")
+			traceback.print_exception(type(e), e, e.__traceback__)
+			return
+
+	async def download_asset(self, filehash: str, save_destination: Path, expected_file_size: int) -> bool:
+		"""
+		Downloads the requested file using the session and saves it to 'save_destination' on disk.
+
+		Returns `True` if the operation was successful, otherwise `False`.
+		"""
+		try:
+			async with await self.get_asset(filehash) as response:
+				response: aiohttp.ClientResponse
+				response.raise_for_status() # raises error on bad HTTP status
+
+				# reject response if response size doesn't match expected size
+				response_size = response.content_length
+				if expected_file_size != response_size:
+					print(f"ERROR: Received asset '{filehash}' with target '{save_destination}' has wrong size ({response_size}/{expected_file_size}).")
+					return False
+
+				save_destination.parent.mkdir(parents=True, exist_ok=True)
+				async with aiofile.async_open(save_destination, "wb") as file:
+					async for chunk in response.content.iter_chunked(1024*16): # no idea what chuck size is best
+						await file.write(chunk)
+
+			return True
+		except Exception as e:
+			print(f"ERROR: An unexpected error occured while downloading '{filehash}' to '{save_destination}'.")
+			traceback.print_exception(type(e), e, e.__traceback__)
+			return False