{"id":26929573,"url":"https://github.com/twhlynch/apk-modding-guide","last_synced_at":"2026-04-07T07:03:59.934Z","repository":{"id":169236334,"uuid":"645150511","full_name":"twhlynch/APK-Modding-Guide","owner":"twhlynch","description":"A guide to decompile, modify, and recompile android packages.","archived":false,"fork":false,"pushed_at":"2024-11-15T09:19:06.000Z","size":118627,"stargazers_count":28,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T05:29:59.837Z","etag":null,"topics":["android","apk","guide","mod"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/twhlynch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-25T03:15:10.000Z","updated_at":"2025-03-29T07:47:50.000Z","dependencies_parsed_at":"2025-04-02T05:37:32.104Z","dependency_job_id":null,"html_url":"https://github.com/twhlynch/APK-Modding-Guide","commit_stats":null,"previous_names":["twhlynch/basic-apk-modding-guide","twhlynch/asset-apk-modding-guide"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/twhlynch/APK-Modding-Guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twhlynch%2FAPK-Modding-Guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twhlynch%2FAPK-Modding-Guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twhlynch%2FAPK-Modding-Guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twhlynch%2FAPK-Modding-Guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/twhlynch","download_url":"https://codeload.github.com/twhlynch/APK-Modding-Guide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twhlynch%2FAPK-Modding-Guide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31503394,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","apk","guide","mod"],"created_at":"2025-04-02T05:27:24.257Z","updated_at":"2026-04-07T07:03:59.917Z","avatar_url":"https://github.com/twhlynch.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# APK-Modding-Guide\n\n## Requirements\n- [sidequest](https://sidequestvr.com/setup-howto) (for sideloading after modding)\n- [Apktool](https://ibotpeaches.github.io/Apktool/) added to PATH\n- [zipalign and Apksigner (Command-line tools)](https://developer.android.com/studio#command-line-tools-only) added to PATH\n\n## Steps\n\n### Setup\n\n- Download the APK and place it in the same folder as this README.\n- Add the requirements to your PATH environment variable:\n\n### Decompile the APK\n```bash\napktool d -f [APK_NAME].apk\n```\nUse this command to decompile the APK into a folder called \\[APK_NAME\\]:\n\n### Modify the APK\nThis is where you can make changes to the apk. The most basic way would be swapping out audio or texture assets.\n\nYou can also change the package name in order to install the APK separately to the unmodded version. To do this, open `apktool.yml` in a text editor and change the `renameManifestPackage` value to something else. (eg, `com.index.[APK_NAME]_modded`)\n\u003e Only use letters and underscores\n### Recompile the APK\n```bash\napktool b -f --use-aapt2 -d [APK_NAME]\n```\nThis command will recompile the APK into `[APK_NAME]/dist/[APK_NAME].apk`:\n\n### Create a keystore\n\u003e For now use the keys in /tools\n\n### Traverse to the folder containing the APK\n```bash\ncd [APK_NAME]/dist\n```\n\n### Align the APK\n```bash\nzipalign -p 4 [APK_NAME] aligned-[APK_NAME]\n```\nThis command will align the APK into `aligned-[APK_NAME].apk`:\n\n### Sign the APK\n```bash\nApkSigner sign --key index.pk8 --cert index.pem --v4-signing-enabled false --out modded-[APK_NAME].apk aligned-[APK_NAME].apk\n```\nThis command will sign the APK\n\nReady to sideload! You will find the APK as `[APK_NAME]/dist/modded-[APK_NAME].apk`.\n\n## Disclaimer\n\nPlease note that modifying APK files of games or any other applications may infringe on the terms of service and may be against the law. Ensure that you have proper authorization and comply with the relevant legal requirements before using this guide. The author of this guide holds no responsibility for any misuse or illegal activities conducted using it.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwhlynch%2Fapk-modding-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftwhlynch%2Fapk-modding-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwhlynch%2Fapk-modding-guide/lists"}