Editing Gadvia:Guides/Extracting game files

= Prerequisites =

Required items:
* an Android device with the game installed,
* an USB Cable,
* a computer or laptop.

Required software:
* [https://developer.android.com/tools/adb Android Debug Bridge (adb)]
* [https://github.com/AssetRipper/AssetRipper/releases AssetRipper]

= Getting the APK files =

<ol>
<li>Enable USB debugging on your Android device. If you do not know how to do that, read [https://developer.android.com/studio/debug/dev-options this guide from developer.android.com].</li>
<li>Connect your device to the computer using an USB cable. Choose "Android Auto" on your device if prompted.</li>
<li>Open a terminal on your computer.</li>
<li>
Run the command <code>adb shell pm path com.hgca.uma</code>. You should get an output similar to this:
<pre>
$ adb shell pm path com.hgca.uma
package:/data/app/~~6cSX1IHn2iEGpQNOGSEkmg==/com.hgca.uma-u4heOeiO-Z4gD1SMy7kOVA==/base.apk
package:/data/app/~~6cSX1IHn2iEGpQNOGSEkmg==/com.hgca.uma-u4heOeiO-Z4gD1SMy7kOVA==/split_UnityDataAssetPack.apk
package:/data/app/~~6cSX1IHn2iEGpQNOGSEkmg==/com.hgca.uma-u4heOeiO-Z4gD1SMy7kOVA==/split_config.arm64_v8a.apk
</pre>
These are the paths to the game's <code>.apk</code> files.
</li>
<li>
Using the paths from the output of the previous command, copy the files to your computer one by one using the command<code>adb pull <nowiki><sourcePath> <destinationPath></nowiki></code>. For example:
<pre>
adb pull /data/app/~~6cSX1IHn2iEGpQNOGSEkmg==/com.hgca.uma-u4heOeiO-Z4gD1SMy7kOVA==/base.apk base.apk
</pre>
This command will copy the base APK file from the mobile device to the computer and save it as <code>base.apk</code>. Repeat this command three times with different paths to extract all of the APK files from the game.
</li>
</ol>

= Extracting most of the assets from APK files =
Most of the game's assets are inside the <code>split_UnityDataAssetPack.apk</code>, however if you want to, you can also extract the other two APK files.

<ol>
<li>Change the extension of the file that you want to extract from <code>.apk</code> to <code>.zip</code>.</li>
<li>Open the <code>.zip</code> file with any archiving program and extract the contents of it to a directory of your choice. You will be able to see some of the files, however most assets will still be hidden behind [[Asset Bundle]]s.</li>
<li>Open AssetRipper.</li>
<li>On the top bar, choose <code>File > Open Folder</code> and select the directory with the extracted files.</li>
<li>After AssetRipper is done loading everything, choose <code>Export > Export all Files</code> on the top bar, and choose a directory for all of the extracted assets.</li>
<li>Wait until AssetRipper finishes extracting, and you are done! Most of the assets should be available in the selected directory.</li>
</ol>

Some of the assets are unable to be extracted with AssetRipper using this method. These assets include:
* Chart files
* Song list file
* Lyrics file
The next section will cover extracting some of these files.

= Extracting the missing assets =

Some of these missing files can be extracted using AssetRipper if they are opened individually. For example, the chart file located inside the <code>/assets/bin/Data/293c9b06cc505f448949507b64e7a17c</code> asset bundle in the <code>split_UnityDataAssetPack.apk</code>, can be extracted by selecting <code>File > Open File</code> instead of <code>File > Open Folder</code>. This section of the guide will help you extract those assets.

<ol>
<li>Find the [[asset bundle file]] that contains the asset you want. Asset bundle files are files with no extension, and 32-character-long names which contain only numbers 0-9 and lowercase letters a-f. The simplest way to find the wanted asset bundle is to search for some text that appears in the asset. For example, to find a chart file, try searching for the song name. On Linux, you can use a tool such as [https://apps.kde.org/en/kfind/ KFind] to search for text in the binary files.</li>
<li>Once you have successfully located the asset bundle, open AssetRipper.</li>
<li>On the top bar, choose <code>File > Open File</code> and select the asset bundle with the extracted files.</li>
<li>After AssetRipper is done loading everything, choose <code>Export > Export all Files</code> on the top bar, and choose a directory for all of the extracted assets.</li>
<li>Wait until AssetRipper finishes extracting, and you are done! The selected asset bundle should have its content extracted to the selected directory.</li>
</ol>

=== Files that cannot be extracted ===

Unfortunately, even this method cannot extract all of the assets. These "unextractable" assets include:
* Song list file
* Lyrics file
The cause of this issue is currently unknown.

While you cannot cleanly extract these files, you can still somewhat read the contents of the assets using a text editor such as [https://notepad-plus-plus.org/ Notepad++] or [https://apps.kde.org/en/kate/ Kate]. Since both the lyrics file and the song list file contain a mostly text, you can read the majority of it.