Update documentation

This commit is contained in:
2022-07-23 22:34:37 +08:00
parent b9810c0e98
commit 15fbd7295a
8 changed files with 59 additions and 7 deletions

View File

@@ -12,7 +12,7 @@
- 方便移植 快速上手
<font size=3 style="opacity: 0.6">`更新时间 2022-05-31 01:35`</font>
<font size=3 style="opacity: 0.6">`更新时间 2022-07-23 22:33`</font>
[GitHub](https://github.com/fankes/YukiHookAPI)
[Get Started](#介绍)

View File

@@ -11,6 +11,9 @@
* [API 异常处理](config/api-exception)
* [R8 与 Proguard 混淆](config/r8-proguard)
* 工具
* [YukiHookAPI 构建工具](tools/yukihookapi-projectbuilder)
* API 文档
* [文档介绍](api/home)
* [Public API](api/document)

View File

@@ -13,6 +13,9 @@
* [作为 Hook API 使用的相关配置](config/api-using)
* [R8 与 Proguard 混淆](config/r8-proguard)
* 工具
* [YukiHookAPI 构建工具](tools/yukihookapi-projectbuilder)
* API 文档
* [文档介绍](api/home)
* [Public API](api/document)

View File

@@ -193,6 +193,7 @@ class HookEntry : IXposedHookZygoteInit, IXposedHookLoadPackage, IXposedHookInit
| Hook Framework | ST | Describe |
| --------------------------------------------------------- | --- | ----------------------------------------------------------------------------------------- |
| [LSPosed](https://github.com/LSPosed/LSPosed) | ✅ | 多场景下稳定使用 |
| [LSPatch](https://github.com/LSPosed/LSPatch) | ⭕ | 将在此项目完善后逐渐加入 API 支持 |
| [EdXposed](https://github.com/ElderDrivers/EdXposed) | ❎ | 已停止维护,不再推荐使用 |
| [Pine](https://github.com/canyie/pine) | ⭕ | 可以使用 |
| [SandHook](https://github.com/asLody/SandHook) | ⭕ | 可以使用 |

View File

@@ -18,7 +18,17 @@
- Jvm 11 及以上 (Since API `1.0.80`)
## 集成依赖
## 自动构建项目
`YukiHookAPI` 提供了一个自动化构建工具,它可以帮助你快速构建一个拥有 Xposed 模块依赖的 Android 标准项目模板,使用构建好的模板即可直接开始下一步工作。
你可以 [点击这里](tools/yukihookapi-projectbuilder) 进行查看。
## 手动配置项目
若你不想使用自动化构建工具,你依然可以按照以下方式手动配置项目依赖。
### 集成依赖
在你的项目 `build.gradle` 中添加依赖。
@@ -85,7 +95,7 @@ android {
!> 自 API `1.0.80` 版本后 Jvm 版本默认为 11不再支持 1.8 及以下版本。
## 作为 Xposed 模块使用
### 作为 Xposed 模块使用
在你的 `AndroidManifest.xml` 中添加基础代码。
@@ -139,9 +149,9 @@ class HookEntry : IYukiHookXposedInit {
若你目前正在使用 Xposed API你可以参考 [从 Xposed API 迁移](guide/move-to-new-api)。
## 作为 Hook API 使用
### 作为 Hook API 使用
### 集成方式
#### 集成方式
创建你的自定义 `Application`
@@ -171,6 +181,6 @@ override fun attachBaseContext(base: Context?) {
有关作为 Hook API 使用的相关配置详细内容,你可以 [点击这里](config/api-using) 继续阅读。
### 特别说明
#### 特别说明
!> 由于你使用了自定义的 Hook 框架而并非模块,~~`YukiHookModuleStatus`~~ ~~`YukiHookModulePrefs`~~ ~~`YukiHookDataChannel`~~ 以及 Resources Hook 功能将失效。

Binary file not shown.

After

Width:  |  Height:  |  Size: 649 KiB

View File

@@ -0,0 +1,35 @@
# YukiHookAPI 构建工具
> 这是一个使用 YukiHookAPI 作为核心的 Xposed 模块自动构建工具,实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板。
<img src="../img-src/yukihookapi-projectbuilder.png" width = "720"/>
## 获取项目
本项目完全开源免费,且会根据大家的使用情况持续维护,初代版本可能存在不完善或 BUG欢迎反馈。
项目地址 https://github.com/fankes/YukiHookAPI-ProjectBuilder
若你想直接下载可以 [点击这里](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases) 前往 Release 发布地址。
## 使用方法
> 这里包含了基本的使用方法和功能讲解。
### 基本用法
- 软件使用过程需要当前设备已连接互联网,若项目依赖无法搜索请尝试 **科学上网**
- 启动软件后,对你期望创建的项目进行简单配置,点击右下角的 **按钮** 或菜单栏选择 **项目 > 开始创建** 即可开始任务。
- 等待依赖自动搜索完成后,你可以对项目依赖进行配置,建议使用最新依赖保证项目的稳定性,构建工具也仅对最新依赖进行支持。
- 选择你需要创建项目的目录,开始后项目会在你选择的位置中创建,并等待整个过程完成,项目就创建好了。
### 配置模板
配置模板是一个扩展功能,你可以选择菜单栏 **项目 > 配置模板 > 新建模板**,即可使用当前填写的配置创建一份模板,下次可以从 **已保存的模板** 中重新载入模板,即可还原当前配置。
### 多语言支持
软件语言跟随当前系统,你可以在菜单栏 **语言 (Language)** 一栏手动选择软件的界面语言。