tretrauit/vollerei
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add information on functions.apply_update_archive

Browse Source
This commit is contained in:
tretrauit 2024-01-03 17:00:58 +07:00
parent 960ba8d746
commit f8cfbc1100
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
vollerei/common/functions.py
View File

@ -13,6 +13,13 @@ _hdiff = HDiffPatch()
def apply_update_archive( def apply_update_archive(
game: GameABC, archive_file: Path | IOBase, auto_repair: bool = True game: GameABC, archive_file: Path | IOBase, auto_repair: bool = True
) -> None: ) -> None:
"""
Applies an update archive to the game, it can be the game update or a
voicepack update.
Because this function is shared for all games, you should use the game's
`apply_update_archive()` method instead.
"""
# Most code here are copied from worthless-launcher. # Most code here are copied from worthless-launcher.
# worthless-launcher uses asyncio for multithreading while this one uses # worthless-launcher uses asyncio for multithreading while this one uses
# ThreadPoolExecutor, probably better for this use case. # ThreadPoolExecutor, probably better for this use case.