English | 简体中文

YumeBox

An open-source Android client based on the mihomo kernel

Features

• Mihomo kernel
• SubStore Optional Support
• Web dashboard
• For more, please explore on your own...

Compatibility

• Android 7.0 and above
• Supports armeabi-v7a, arm64-v8a, x86, and x86_64 architectures

Usage

• Install: Visit the Releases page
• Build: See the Build section

Discussion

• Telegram group: @OOM_WG

Contributing Translations

To translate YumeBox into your language or improve existing translations, please fork this project and create or update translation files in the lang directory.

Build

1. Sync core source code

   sh scripts/sync-kernel.sh <alpha|meta|smart>

2. Install dependencies Ensure that OpenJDK 24, Android SDK, CMake, and Golang are installed.

3. Create local.properties in the project root

   sdk.dir=/path/to/android-sdk

4. (Optional) Customize the package name by editing gradle.properties

   project.namespace.base=com.github.yumelira.yumebox
   project.namespace.core=${project.namespace.base}.core
   project.namespace.extension=${project.namespace.base}.extension
   project.namespace.buildlogic=${project.namespace.base}.buildlogic

5. Create signing.properties in the project root

   keystore.path=/path/to/keystore/file
   keystore.password=<key store password>
   key.alias=<key alias>
   key.password=<key password>

6. Build the application

   Ontology:

   ./gradlew app:assembleRelease

   SubStore Extension:

   ./gradlew extension:assembleRelease

Acknowledgements

• Mihomo
• ClashMetaForAndroid
• SubStore
• SubCase
• Yacd-meta
• Zashboard