Utils for scrapping honse game files.

You must insert into the /storage folder your own copy of the meta file and the master folder. You can grab them from the game's root dir: /data/data/jp.co.cygames.umamusume/files.

All scripts have required dependencies, run pip install -r requirements.txt to install all of them.

All utils reside inside the scripts folder.

Downloads ALL game assets according to your meta file. If the game is updated, all you have to do is update the meta file and re-run this script. This only downloads new files, you can set SKIP_EXISTING to False inside the script to force a full re-download.

Set HPATHS inside of the script to True if you want the downloaded folder structure to be the same as the game's dat folder structure.

IMPORTANT If doing a full download, this will suck your machine's network dry. Set ASYNC_DOWNLOAD to False to download in a less aggressive way.

Uses the decrypted meta file if decrypt_meta.py was used before this script.

The output files are located at storage/data.

Extracts stuff related to items. Output file can be found at storage/items.txt.

Extracts the strings related to the in-game stories. This only extracts new files, you can set SKIP_EXISTING to False inside the script to force a full extraction.

Uses the decrypted assets if decrypt_assets.py was used before this script.

Set HPATHS inside of the script to True if you also set HPATHS to True in data_download.py.

The output files are located at storage/story.

Creates a one-to-one copy of the meta file with no encryption. Output file can be found at storage/meta_decrypted.

Creates a one-to-one copy of the asset files from the storage/data folder with no encryption.

Set HPATHS inside of the script to True if you also set HPATHS to True in data_download.py.

Can be customized which folders are included or excluded and whether to skip existing files with these lines of code inside the script:

SKIP_EXISTING = True

# If this is NOT empty, ONLY assets within these folders will be decrypted.
# If this IS empty, ALL assets will be processed (with exclusions).
# Example:
# INCLUDED_FOLDERS = set()
# INCLUDED_FOLDERS = {"sound/v/", "story/data/"}
INCLUDED_FOLDERS = {"story/data/"}

# Any asset from these folders will be explicitly SKIPPED.
# This is useful for ignoring entire categories of files.
# Example:
# EXCLUDED_FOLDERS = {"font/"}
# EXCLUDED_FOLDERS = {"font/", "movie/"}
EXCLUDED_FOLDERS = set()

The output files are located at storage/data_decrypted.

Dumps the contents of the meta file into a JSON file.

WARNING The output file might be over 50MB, do not open the dump file with a normal text editor on a phone or PC. It's recommended to view the file with something like neovim or vim instead.

Output file can be found at storage/meta_dump.json.