# Quick Start > Integrate `YukiHookAPI` into your project. ## Environment Requirements - Windows 7 and above / macOS 10.14 and above / Linux distributions (Arch/Debian) - Android Studio 2021.1 and above - IntelliJ IDEA 2021.1 and above - Kotlin 1.7.0 and above - Android Gradle Plugin 7.0 and above - Gradle 7.0 and above - Java 11 and above (Since API `1.0.80`) ## 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](../tools/yukihookapi-projectbuilder) 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 We recommend using Kotlin DSL as the Gradle build script language and [SweetDependency](https://github.com/HighCapable/SweetDependency) to manage dependencies. #### SweetDependency Method Add the repositories and dependencies in your project's `SweetDependency` configuration file. > The following example ```yaml repositories: # Must be added when used as an Xposed Module, otherwise optional rovo89-xposed-api: url: https://api.xposed.info/ # MavenCentral has a 2-hour cache, # if the latest version cannot be integrated, please add this sonatype-oss-releases: plugins: # Must be added when used as an Xposed Module, otherwise optional com.google.devtools.ksp: version: + ... libraries: # Must be added when used as an Xposed Module, otherwise optional de.robv.android.xposed: api: version: 82 repositories: rovo89-xposed-api com.highcapable.yukihookapi: api: version: + # Must be added when used as an Xposed Module, otherwise optional ksp-xposed: version-ref: ::api ... ``` After adding it, run Gradle Sync and all dependencies will be autowired. Next, deploy plugins in your project `build.gradle.kts`. > The following example ```kotlin plugins { // Must be added when used as an Xposed Module, otherwise optional autowire(libs.plugins.com.google.devtools.ksp) // ... } ``` Then, deploy dependencies in your project `build.gradle.kts`. > The following example ```kotlin dependencies { // Basic dependencies implementation(com.highcapable.yukihookapi.api) // Must be added when used as an Xposed Module, otherwise optional compileOnly(de.robv.android.xposed.api) // Must be added when used as an Xposed Module, otherwise optional ksp(com.highcapable.yukihookapi.ksp.xposed) } ``` #### Traditional Method (Not Recommended) Add repositories in your project `build.gradle.kts` or `build.gradle`. > Kotlin DSL ```kotlin repositories { google() mavenCentral() // Must be added when used as an Xposed Module, otherwise optional maven { url("https://api.xposed.info/") } // MavenCentral has a 2-hour cache, if the latest version cannot be integrated, please add this URL maven { url("https://s01.oss.sonatype.org/content/repositories/releases/") } } ``` > Groovy DSL ```groovy repositories { google() mavenCentral() // Must be added when used as an Xposed Module, otherwise optional maven { url 'https://api.xposed.info/' } // MavenCentral has a 2-hour cache, if the latest version cannot be integrated, please add this URL maven { url 'https://s01.oss.sonatype.org/content/repositories/releases/' } } ``` Add plugins in your project `build.gradle.kts` or `build.gradle`. > Kotlin DSL ```kotlin plugins { // Must be added when used as an Xposed Module, otherwise optional id("com.google.devtools.ksp") version "" } ``` > Groovy DSL ```groovy plugins { // Must be added when used as an Xposed Module, otherwise optional id 'com.google.devtools.ksp' version '' } ``` Add dependencies in your project `build.gradle.kts` or `build.gradle`. > Kotlin DSL ```kotlin dependencies { // Basic dependency implementation("com.highcapable.yukihookapi:api:") // Must be added when used as an Xposed Module, otherwise optional compileOnly("de.robv.android.xposed:api:82") // Must be added when used as an Xposed Module, otherwise optional ksp("com.highcapable.yukihookapi:ksp-xposed:") } ``` > Groovy DSL ```groovy dependencies { // Basic dependency implementation 'com.highcapable.yukihookapi:api:' // Must be added when used as an Xposed Module, otherwise optional compileOnly 'de.robv.android.xposed:api:82' // Must be added when used as an Xposed Module, otherwise optional ksp 'com.highcapable.yukihookapi:ksp-xposed:' } ``` Please modify **<ksp-version>** to the latest version found [here](https://github.com/google/ksp/releases) **(please note to select your current corresponding Kotlin version)**. Please change **<yuki-version>** to the latest version [here](../about/changelog). :::danger The **api** and **ksp-xposed** dependency versions of **YukiHookAPI** must correspond one-to-one, otherwise a version mismatch error will occur. We recommend using [SweetDependency](https://github.com/HighCapable/SweetDependency) to autowire dependencies for you. ::: #### Configure Java Version Modify the Java version of Kotlin in your project `build.gradle.kts` or `build.gradle` to 11 or above. > Kotlin DSL ```kt android { compileOptions { sourceCompatibility = JavaVersion.VERSION_11 targetCompatibility = JavaVersion.VERSION_11 } kotlinOptions { jvmTarget = "11" } } ``` > Groovy DSL ```groovy android { compileOptions { sourceCompatibility JavaVersion.VERSION_11 targetCompatibility JavaVersion.VERSION_11 } kotlinOptions { jvmTarget = '11' } } ``` ::: warning Since API **1.0.80**, the Java version used by Kotlin defaults to 11, and versions 1.8 and below are no longer supported. ::: ### Use as Xposed Module Add the base code to your `AndroidManifest.xml`. > The following example ```xml ``` Create a Hook entry class in your project, implements `IYukiHookXposedInit` and add the annotation `@InjectYukiHookWithXposed`. > The following example ```kotlin @InjectYukiHookWithXposed object HookEntry : IYukiHookXposedInit { override fun onHook() = YukiHookAPI.encase { // Your code here. } } ``` ::: tip Suggestion Please configure **YukiHookAPI** in the **onInit** method and set the **isDebug** mode to the following form. > The following example ```kotlin 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](../api/public/com/highcapable/yukihookapi/hook/xposed/application/ModuleApplication). ::: Then, you can start writing Hook code. For configuration details related to use as an Xposed Module, you can [click here](../config/xposed-using) to continue reading. If you are currently using Hook APIs such as Rovo89 Xposed API, you can refer to [Migrate from Other Hook APIs](../guide/move-to-new-api). ### Use as Hook API #### Integration Create your custom `Application`. ::: danger Regardless of the **Hook Framework** you use, you need to add its docking Xposed dependency support. If the target **Hook Framework** does not integrate Rovo89 Xposed API, you need to implement and connect **XposedBridge** by yourself. ::: Add `YukiHookAPI.encase` method to `attachBaseContext`. > The following example ```kotlin 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](../config/api-using) to continue reading. ::: warning **YukiHookPrefsBridge**, **YukiHookDataChannel** and Resources Hook functionality will not work when using a custom Hook Framework instead of the full Xposed Module. :::