import{_ as o,r as l,o as i,c as p,b as n,d as t,a as e,e as s}from"./app.c86510cc.js";const r={},c=e(`

Quick Start

Integrate YukiHookAPI into your project.

Environment Requirements

Automatically Build Project

YukiHookAPI provides an automated build tool that can help you quickly build an Android standard project template with Xposed Module dependencies, and use the built template to start the next step directly.

You can click here to check it out.

Manually Configure Project

If you don't want to use automated build tools, you can still manually configure project dependencies as follows.

Create Project

Use Android Studio or IntelliJ IDEA to create a new Android project and select Kotlin in the Language column to automatically add basic dependencies.

Integration Dependencies

Add dependencies to your project build.gradle.

The following example

repositories {
    google()
    mavenCentral()
    // \u2757If your Plugin version is too low, be sure to add it as an Xposed Module, other cases are optional
    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" }
    // \u2757Be sure to add it as an Xposed Module, optional in other cases
    maven { url "https://api.xposed.info/" }
    // MavenCentral has a 2-hour cache, if you cannot integrate the latest version, please add this address
    maven { url "https://s01.oss.sonatype.org/content/repositories/releases" }
}

Add plugin to your app build.gradle.

The following example

plugins {
    // \u2757Be sure to add it as an Xposed Module, optional in other cases
    id 'com.google.devtools.ksp' version '<ksp-version>'
}

Add dependencies to your app build.gradle.

The following example

dependencies {
    // Base dependencies
    implementation 'com.highcapable.yukihookapi:api:<yuki-version>'
    // \u2757Be sure to add it as an Xposed Module, optional in other cases
    compileOnly 'de.robv.android.xposed:api:82'
    // \u2757Be sure to add it as an Xposed Module, optional in other cases
    ksp 'com.highcapable.yukihookapi:ksp-xposed:<yuki-version>'
}
`,21),d=s("Please modify "),u=n("strong",null,"",-1),y=s(" to the latest version from "),v={href:"https://github.com/google/ksp/releases",target:"_blank",rel:"noopener noreferrer"},A=s("here"),m=s(),h=n("strong",null,"(Please choose your current corresponding Kotlin version)",-1),b=s("."),g=e(`

Please modify <yuki-version> to the latest version here.

Pay Attention

The api of YukiHookAPI and the versions that ksp-xposed depend on must correspond one by one, otherwise a version mismatch error will occur.

Modify the JVM version of Kotlin to 11 and above in your app build.gradle.

The following example

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_11
        targetCompatibility JavaVersion.VERSION_11
    }
    kotlinOptions {
        jvmTarget = '11'
    }
}

Notice

Since API 1.0.80 version, the default JVM version is 11, and 1.8 and below are no longer supported.

Use as Xposed Module

Add the base code to your AndroidManifest.xml.

The following example

<!-- Set as Xposed Module -->
<meta-data
    android:name="xposedmodule"
    android:value="true" />

<!-- Set your Xposed Module description -->
<meta-data
    android:name="xposeddescription"
    android:value="Fill in your Xposed Module description" />

<!-- The minimum Xposed version number -->
<!-- If you are using EdXposed/LSPosed, the minimum recommended is 93 -->
<meta-data
    android:name="xposedminversion"
    android:value="93" />

<!-- Optional: Configure support for New XSharedPreferences without adjusting xposedminversion to 93 -->
<meta-data
    android:name="xposedsharedprefs"
    android:value="true"/>

Create a Hook entry class in your project, implements IYukiHookXposedInit and add the annotation @InjectYukiHookWithXposed.

The following example

@InjectYukiHookWithXposed
object HookEntry : IYukiHookXposedInit {

    override fun onHook() = YukiHookAPI.encase {
        // Your code here.
    }
}

Suggestion

Please configure YukiHookAPI in the onInit method and set the isDebug mode to the following form.

The following example

override fun onInit() = configs {
    isDebug = BuildConfig.DEBUG
}

YukiHookAPI will print all logs for debugging by default.

For a release build, be sure to turn off debugging to prevent a lot of log stuffing on the user's device.

You can also extends Application of your Module App from ModuleApplication to achieve a complete user experience.

For more functions, please refer to ModuleApplication.

Then, you can start writing Hook code.

For configuration details related to use as an Xposed Module, you can click here to continue reading.

If you are currently using Xposed API, you can refer to Migrate from Xposed API.

Use as Hook API

Integration

Create your custom Application.

Pay Attention

Regardless of the Hook Framework you use, you need to add its docking Xposed dependency support.

If the target Hook Framework does not integrate Xposed API, you need to implement and connect XposedBridge by yourself.

Add YukiHookAPI.encase method to attachBaseContext.

The following example

override fun attachBaseContext(base: Context?) {
    // Load Hook Framework
    //
    // Your code here.
    //
    // Load YukiHookAPI
    YukiHookAPI.encase(base) {
        // Your code here.
    }
    super.attachBaseContext(base)
}

Then, you can start writing Hook code in much the same way you would use it as an Xposed Module.

For configuration details related to use as a Hook API, you can click here to continue reading.

Notice

YukiHookPrefsBridge, YukiHookDataChannel and Resources Hook functionality will not work when using a custom Hook Framework instead of the full Xposed Module.

`,27);function D(B,C){const a=l("ExternalLinkIcon");return i(),p("div",null,[c,n("p",null,[d,u,y,n("a",v,[A,t(a)]),m,h,b]),g])}const F=o(r,[["render",D],["__file","quick-start.html.vue"]]);export{F as default};