HighCapable/YukiHookAPI
5
0
Fork 0
mirror of https://github.com/HighCapable/YukiHookAPI.git synced 2025-12-08 14:14:05 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update document suggestion

Browse Source
This commit is contained in:
fankesyooni
2025-11-12 17:57:25 +08:00
parent 786ba1a5ef
commit 1085e789f0
2 changed files with 4 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs-source/src/en/guide/quick-start.md
View File

@@ -28,82 +28,9 @@ Use `Android Studio` or `IntelliJ IDEA` to create a new Android project and sele
### Integration Dependencies ### Integration Dependencies
We recommend using Kotlin DSL as the Gradle build script language and [SweetDependency](https://github.com/HighCapable/SweetDependency) to manage dependencies. We recommend using Kotlin DSL as the Gradle build script language.
#### SweetDependency (Recommended) #### Version Catalog (Recommended)
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/
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: <this>::api
# YukiHookAPI version 1.3.0 uses KavaRef as core reflection API
# YukiHookAPI no longer binds its own reflection API, you can start trying to use KavaRef
com.highcapable.kavaref:
kavaref-core:
version: +
kavaref-extension:
version: +
...
```
After adding it, run Gradle Sync and all dependencies will be autowired.
Next, deploy plugins in your project's `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's `build.gradle.kts`.
> The following example
```kotlin
dependencies {
// Basic dependencies
implementation(com.highcapable.yukihookapi.api)
// It is recommended to use KavaRef as the core reflection API
implementation(com.highcapable.kavaref.kavaref.core)
implementation(com.highcapable.kavaref.kavaref.extension)
// 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)
}
```
#### Version Catalog
Add repositories in your project's `build.gradle.kts`. Add repositories in your project's `build.gradle.kts`.

77
docs-source/src/zh-cn/guide/quick-start.md
View File

@@ -28,82 +28,9 @@
### 集成依赖 ### 集成依赖
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言并推荐使用 [SweetDependency](https://github.com/HighCapable/SweetDependency) 来管理依赖。 我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言。
#### SweetDependency (推荐) #### Version Catalog (推荐)
在你的项目 `SweetDependency` 配置文件中添加存储库和依赖。
> 示例如下
```yaml
repositories:
# 作为 Xposed 模块使用务必添加，其它情况可选
rovo89-xposed-api:
url: https://api.xposed.info/
plugins:
# 作为 Xposed 模块使用务必添加，其它情况可选
com.google.devtools.ksp:
version: +
...
libraries:
# 作为 Xposed 模块使用务必添加，其它情况可选
de.robv.android.xposed:
api:
version: 82
repositories:
rovo89-xposed-api
com.highcapable.yukihookapi:
api:
version: +
# 作为 Xposed 模块使用务必添加，其它情况可选
ksp-xposed:
version-ref: <this>::api
# YukiHookAPI 1.3.0 版本后使用 KavaRef 作为核心反射 API
# YukiHookAPI 不再绑定自身的反射 API，你可以开始尝试使用 KavaRef
com.highcapable.kavaref:
kavaref-core:
version: +
kavaref-extension:
version: +
...
```
添加完成后运行一次 Gradle Sync，所有依赖版本将自动装配。
接下来，在你的项目 `build.gradle.kts` 中部署插件。
> 示例如下
```kotlin
plugins {
// 作为 Xposed 模块使用务必添加，其它情况可选
autowire(libs.plugins.com.google.devtools.ksp)
// ...
}
```
然后，在你的项目 `build.gradle.kts` 中部署依赖。
> 示例如下
```kotlin
dependencies {
// 基础依赖
implementation(com.highcapable.yukihookapi.api)
// 推荐使用 KavaRef 作为核心反射 API
implementation(com.highcapable.kavaref.kavaref.core)
implementation(com.highcapable.kavaref.kavaref.extension)
// 作为 Xposed 模块使用务必添加，其它情况可选
compileOnly(de.robv.android.xposed.api)
// 作为 Xposed 模块使用务必添加，其它情况可选
ksp(com.highcapable.yukihookapi.ksp.xposed)
}
```
#### Version Catalog
在你的项目 `build.gradle.kts` 中添加存储库。 在你的项目 `build.gradle.kts` 中添加存储库。