Android APK GitHub Actions
This guide provides a comprehensive walkthrough for modifying and repackaging the OTClient Android APK to include custom assets, scripts, or configurations.
- 1. Prerequisites
- 2. Obtaining the Base APK via GitHub Actions
- 3. APK Editor Studio
- 4. Extracting and Modifying data.zip
- 5. Repackaging the Data
- 6. Replace data.zip
- 7. Compiling in APK Editor Studio
- 8. Installation and Testing
- 9. Credits
Before beginning the process, ensure you have the following requirements ready:
- Android Device: An Android-based smartphone
- GitHub Account: Necessary to access and download the automated builds.
- APK Editor Studio (v1.7.2): Download via Google Drive
The latest versions of the APK are automatically compiled through GitHub workflows.
-
Navigate to the OTClient Actions repository page.
-
Select the "CI" workflow from the sidebar.
-
Filter the results by the
mainbranch and select the most recent successful commit.
-
Scroll to the Artifacts section at the bottom of the page and download the APK package.
- Launch APK Editor Studio.
- Click the Folder Icon (Select APK) to load your downloaded file.
- In the central menu, click the Open Contents button. This will unpack the APK into a temporary directory within your
AppDatafolder for editing.
The client's logic and visual assets are stored within the data.zip file.
- Navigate to the
assetsfolder within the unpacked project. - Locate
data.zip. Note: You must extract this file to a separate directory to perform edits.
- Inside your extraction folder, you can modify UI components, update Lua scripts, or add asset or
.sprand.dat.
Warning
Lua 5.2 Compatibility: Ensure your scripts do not use ::goto:: or continue keywords, as they are not supported in this version. Additionally, remember that Lua is strictly case-sensitive.
Once your modifications are complete, you must rebuild the internal archive.
- Select all files and folders within your modified workspace.
- Compress them using the native Windows tool (Right-click -> Compress to ZIP file).
-
Important: The resulting archive must be named exactly
data.zip.
- Replace the original
data.zipfile in theassetsfolder of your APK Editor Studio project with your newly created version.
- Return to the APK Editor Studio interface.
- Select Save APK from the central menu. The software will recompile and sign the modified APK.
- Transfer the newly generated APK to your Android device.
- Install the application and launch it to verify that your changes have been applied correctly.