Skip to content

Companion app for localizing the Android version of CHAOS;CHILD visual novel

License

Notifications You must be signed in to change notification settings

solrudev/OkkeiPatcher

Repository files navigation

Okkei Patcher

Okkei Patcher icon

GitHub release (latest SemVer) License: GPLv3 GitHub downloads

Okkei Patcher is a companion app for localizing the Android version of CHAOS;CHILD visual novel. It downloads the latest revision of CHAOS;CHILD Android localization patch and automatically applies it to the installed game while creating a backup of its original installation, so that you can easily go back to the unpatched Japanese version.

Minimum supported Android version: Android 4.4 KitKat.

Download

Go to the Releases page to download the latest APK.

ATTENTION: versions below 2.0.9 are now defunct due to domain name used for backend API has been shut down.

Screenshots

Light theme

Dark theme

Architecture

Okkei Patcher follows Clean Architecture principles and best practices of modern Android app development, such as edge-to-edge UI, adapting to different screen sizes, MVI pattern for presentation layer logic, Repository pattern and single-activity approach, while also adhering to Material 3 design guidelines (not wholeheartedly, though).

UI is built with Android View system (no Jetpack Compose, sorry, we have to support KitKat anyway).

Core logic of the app is highly abstracted and lives in the domain layer. It contains interfaces such as Operation, Game, GameFile, PatchUpdates. Interacting with other layers is achieved via dependency inversion.

Reliable task execution and status tracking is ensured by using Jetpack WorkManager.

Tech stack

Building

Okkei Patcher requires Android Studio Iguana and higher to build (Android Gradle Plugin 8.3+).

Okkei Patcher has two flavors: prod and mock.

Prod flavor is release version of the app. Mock flavor is a version with mocked implementation of patch, restore and update functions and it doesn't require network or CHAOS;CHILD to be installed. It's used to test the overall flow logic of the app and UI layouts.

By default release builds are signed with debug keystore. To use your own Android keystore in release build, create keystore.properties file in root folder of the project with the following contents:

storePassword=YOUR_KEYSTORE_PASSWORD
keyPassword=YOUR_KEY_PASSWORD
keyAlias=YOUR_KEY_ALIAS
storeFile=PATH_TO_YOUR_KEYSTORE_FILE

License

Okkei Patcher is licensed under GNU GPLv3 license.