Skip to content

Commit d95676b

Browse files
author
Ven
committed
docs(README): 更新文档结构和内容优化
- 添加架构设计链接到导航栏 - 重构目录结构,更新章节标题和内容组织 - 新增生态介绍表格,展示基于Assists的完整开发生态系统 - 优化核心能力展示,以表格形式清晰呈现各项功能 - 更新付费社群权益描述,增加详细服务内容 - 补充相关项目链接,完善文档引用
1 parent 1596c11 commit d95676b

File tree

2 files changed

+94
-63
lines changed

2 files changed

+94
-63
lines changed

README.md

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
[![][forks-shield]][forks-link]
1313
[![][issues-shield]][issues-link]
1414

15-
[📱 下载Demo][demo-download] · [📘 开发文档][docs-link] · [🐛 反馈问题][issues-link] · [💬 交流反馈](#交流反馈) · [💰 赞助支持](#-赞助支持) · [💁 付费社群](#-付费社群) · [⭐ Star支持][stars-link]
15+
[📱 下载Demo][demo-download] · [🏗️ 架构设计](docs/architecture.md) · [📘 开发文档][docs-link] · [🐛 反馈问题][issues-link] · [💬 交流反馈](#交流反馈) · [💰 赞助支持](#-赞助支持) · [💁 付费社群](#-付费社群) · [⭐ Star支持][stars-link]
1616

1717
</div>
1818

@@ -24,13 +24,11 @@
2424
<summary><kbd>展开目录</kbd></summary>
2525

2626
- [📖 目录](#-目录)
27-
- [利用无障碍服务能做什么](#利用无障碍服务能做什么)
28-
- [Assists作用](#assists作用)
29-
- [主要能力](#主要能力)
30-
- [功能示例](#功能示例)
31-
- [基础功能](#基础功能)
32-
- [高级示例](#高级示例)
33-
- [更多示例](#更多示例)
27+
- [🎯 适用场景](#-适用场景)
28+
- [💡 为什么选 Assists](#-为什么选-assists)
29+
- [🌟 基于 Assists 的开发生态](#-基于-assists-的开发生态)
30+
- [📋 核心能力](#-核心能力)
31+
- [🎬 功能示例](#-功能示例)
3432
- [开发文档](#开发文档)
3533
- [交流反馈](#交流反馈)
3634
- [💝 支持开源](#-支持开源)
@@ -42,66 +40,61 @@
4240

4341
</details>
4442

45-
## 利用无障碍服务能做什么
43+
## 🎯 适用场景
4644

47-
可以开发各种各样的自动化脚本程序以及协助脚本,比如
45+
基于无障碍与 Assists 生态,可开发各类**自动化脚本****辅助工具**,例如
4846

49-
1. 微信自动抢红包
50-
2. 微信自动接听电话
51-
3. 支付宝蚂蚁森林自动浇水
52-
4. 支付宝芭芭农场自动施肥、自动收集能量...
53-
5. 各种平台的拓客、引流、营销系统
54-
6. 远程控制
47+
- 微信自动抢红包、自动接听电话
48+
- 支付宝蚂蚁森林浇水、芭芭农场施肥与能量收集
49+
- 各平台拓客、引流、营销自动化
50+
- 远程控制与设备协作
5551

52+
上述能力可基于 **原生(assists)****Web(assistsx-js + AssistsX)** 两种方式实现,详见 [开发生态](#-基于-assists-的开发生态)
5653

54+
## 💡 为什么选 Assists
5755

58-
## Assists作用
56+
Assists 是整条生态的**基础库**:基于 Android 无障碍服务封装,提供统一 API 与增强能力,让上层模块与应用专注业务而非底层细节。
5957

60-
基于Android无障碍服务(AccessibilityService)封装的框架
58+
- **开发更简单**:无障碍能力封装为易用 API,减少样板代码
59+
- **能力可扩展**:浮窗、截图、输入法、图像识别、Web 桥接等按需选用
60+
- **脚本易维护**:步骤器与模块化设计,便于复用与迭代
61+
- **技术栈灵活**:支持原生开发,也支持 HTML + JS/Vue 的 Web 自动化([assistsx-js][assistsx-js-link]
6162

62-
1. 简化自动化脚本开发
63-
2. 为自动化脚本提供各种增强能力
64-
3. 提高脚本易维护性
65-
4. 支持html+js/vue开发自动化脚本
63+
## 🌟 基于 Assists 的开发生态
6664

65+
> **从基础库到运行平台、从 Native 到 Web,一套完整可用的自动化开发生态已围绕 Assists 形成。**
66+
> 无论你偏好原生开发还是 Web 技术栈,都能找到对应模块与示例,快速上手、持续扩展。
6767
68+
| 角色 | 项目 | 说明 |
69+
|------|------|------|
70+
| **🏠 基础库** | **assists** | 自动化**基础库**:无障碍服务封装、能力增强 API、浮窗管理,一切能力的根基。 |
71+
| **⌨️ 输入法** | **assists-ime** | 自定义**输入法**:在仅能通过输入法触发搜索等场景下,为自动化提供关键能力。 |
72+
| **📹 屏幕录制** | **assists-mp** | **屏幕录制**与截图:整屏/节点截图,弥补无障碍无法直接截图的场景。 |
73+
| **🖼️ 图像处理** | **assists-opcv** | **图像处理**:集成 OpenCV,模板匹配等能力增强屏幕识别。 |
74+
| **🌐 Web 桥接** | **assists-web** | **Web 自动化支持**:WebView 原生↔JS 通道,让 Web 端直接调用 Assists 能力。 |
75+
| **📱 运行平台** | [**AssistsX**][assistsx-link] | **Web 自动化运行平台****节点分析工具**:安装即用,支持插件本地/局域网/在线加载,开启节点分析后可在局域网用浏览器分析页面节点。 |
76+
| **📜 JS 库** | [**assistsx-js**][assistsx-js-link] | **Web 自动化 JS 库**:节点查找、手势、步骤器……用前端技术栈轻松编写与维护自动化。 |
77+
| **📂 示例仓库** | [**assists-examples**][assists-examples-link] | **Assists 相关示例项目**:包含**原生自动化****Web 端自动化**示例,即拿即跑。 |
78+
| **📊 日志节点分析** | **日志节点上报分析系统**(付费) | 测试人员可提交**运行日志****页面节点信息**,开发基于上报数据分析页面结构、精准定位多设备/多界面 Bug,解决「无日志、无节点难以复现」的痛点。**仅限付费用户使用。** |
6879

69-
## 主要能力
80+
**推荐路径**:使用 [assistsx-js][assistsx-js-link] 在 Web 端开发自动化 → 在手机安装 [AssistsX][assistsx-link] 运行插件 → 参考 [assists-examples][assists-examples-link] 学习与扩展。
7081

71-
1. 易于使用的无障碍服务API
72-
2. 浮窗管理器:易于实现及管理浮窗
73-
3. 步骤器:为快速实现、可复用、易维护的自动化步骤提供框架及管理
74-
4. 配套屏幕管理:快速生成输出屏幕截图、元素截图
75-
5. 屏幕管理结合opencv:便于屏幕内容识别为自动化提供服务
76-
6. 封装webview接口支持html+js/vue开发自动化脚本(对应js库:**[assistsx-js][assistsx-js-link]**
82+
## 📋 核心能力
7783

84+
| 能力 | 说明 |
85+
|------|------|
86+
| **无障碍 API** | 节点查找、点击、输入、滚动等,接口简洁易用 |
87+
| **浮窗管理** | 浮窗的添加/删除/显示/隐藏/缩放/移动,快速实现悬浮控制 |
88+
| **步骤器** | 可复用、易维护的自动化步骤框架与编排 |
89+
| **屏幕与截图** | 整屏截图、指定节点区域截图([assists-mp](docs/architecture.md)|
90+
| **图像识别** | 结合 OpenCV 的模板匹配等,辅助屏幕内容识别([assists-opcv](docs/architecture.md)|
91+
| **Web 自动化** | WebView 桥接,HTML + JS/Vue 开发脚本,对应 [assistsx-js][assistsx-js-link] |
7892

93+
## 🎬 功能示例
7994

80-
## 功能示例
95+
Demo 覆盖**基础操作****高级自动化**(收能量、发朋友圈、接听电话等)、**截图与浮窗**等,完整示例 GIF 与截图见 **[功能示例图集](docs/demo-gallery.md)**
8196

82-
### 基础功能
83-
84-
| 基础示例 | 进阶示例 | 高级示例 | 图片截取 |
85-
| :------: | :------: | :------: | :------: |
86-
| <img src="https://github.com/user-attachments/assets/b537bab4-cc55-41c2-8f81-9e8b965e939a" width="200" /> | <img src="https://github.com/user-attachments/assets/9b50628c-603e-47d1-a6ae-5600358575fc" width="200" /> | <img src="https://github.com/user-attachments/assets/262b9028-5926-478b-93bd-3e20110db391" width="200" /> | <img src="https://github.com/user-attachments/assets/522236e4-5880-4f00-9f4c-76728df3cfe6" width="200" /> |
87-
88-
### 高级示例
89-
90-
| 自动收能量 | 自动发朋友圈 | 自动滑动朋友圈 | 无障碍服务开启引导 |
91-
| :--------: | :----------: | :------------: | :----------------: |
92-
| <img src="https://github.com/ven-coder/Assists/assets/27257149/8d1d09b2-e4b3-44dc-b5df-68fcdcac7a62" width="200" /> | <img src="https://github.com/ven-coder/Assists/assets/27257149/4713656b-a8ff-4c99-9814-a0b883ebbe64" width="200" /> | <img src="https://github.com/ven-coder/Assists/assets/27257149/056ef46b-8076-4f90-ab5a-263ff308f8e8" width="200" /> | <img src="https://github.com/user-attachments/assets/9e20a757-8d8f-47e6-999b-8532b4e6827a" width="200" /> |
93-
94-
| 防止下拉通知栏 | 通知/Toast监听 | 自动接听微信电话 | 窗口缩放&拖动 |
95-
| :------------: | :------------: | :--------------: | :-----------: |
96-
| <img src="https://github.com/user-attachments/assets/76613db4-c0a9-4ad8-abde-ec0ef8f7ed09" width="200" /> | <img src="https://github.com/user-attachments/assets/cc6a861a-3512-43c0-9c1d-4e61229dc527" width="200" /> | <img src="https://github.com/user-attachments/assets/25472235-8d6d-4327-9bc5-db47253b7f0e" width="200" /> | <img src="https://github.com/user-attachments/assets/184fb248-66e0-4bb4-aaae-c1b8c4cef70a" width="200" /> |
97-
98-
### 更多示例
99-
100-
更多示例可以直接下载demo查看
101-
102-
<img src="https://github.com/user-attachments/assets/39568ee6-b9f3-447f-8a81-4ef25692815b" width="150" />
103-
104-
[📱 直接下载][demo-download]
97+
[📱 直接下载 Demo][demo-download]
10598

10699

107100

@@ -140,18 +133,23 @@
140133

141134
### 💁 付费社群
142135

143-
付费社群提供的服务:
136+
加入付费社群可享受以下权益:
137+
138+
- 开发指导
139+
- VIP 交流群
140+
- VIP 外包接单
141+
- 详细开发文档
142+
- 经验总结分享
143+
- 高级示例源码
144+
- 群友互助资源对接
145+
- 新 API 优先提供对接
146+
- 日志上报分析系统(对外使用开发中)
147+
148+
**加入方式与说明**[在线查看](https://my.feishu.cn/wiki/CXIDwLKlYidE6TkD79gcAvI6nBg) · 或扫码查看:
144149

145-
1. 完整易于阅读的开发文档
146-
2. Assists开发指导
147-
3. 开发疑难解答
148-
4. 群友互助资源对接
149-
5. 基于Assists开发的抖音养号,小红书养号,支付宝能量收集,支付宝农场,无线远程控制等源码(补充中...)
150+
<img src="https://github.com/user-attachments/assets/2ab13741-a30a-4f12-9906-f558547d0760" width="180" alt="付费社群加入方式与说明二维码" />
150151

151-
| 资料截图 | 微信扫码加入 |
152-
|:------:|:------:|
153-
| <img src="https://github.com/user-attachments/assets/7607a4e6-4845-474e-a9c6-e685cc306523" width="600" /> | <img src="https://github.com/ven-coder/Assists/assets/27257149/7ae8e825-f489-46e3-96f0-ed03d12db9e8" width="200" /> |
154-
**定制开发可联系个人微信: x39598**
152+
**定制开发可联系作者微信: x39598**
155153

156154
**感谢所有的支持者,得到你们的支持我将会更加完善开源库的能力!** 🚀
157155

@@ -192,6 +190,8 @@ Copyright © 2025 [ven-coder][profile-link]
192190
[demo-download]: https://www.pgyer.com/1zaijG
193191
[docs-link]: https://ahcirffybg.feishu.cn/wiki/space/7561797853589553156?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home
194192
[assistsx-js-link]: https://github.com/ven-coder/assistsx-js
193+
[assistsx-link]: https://github.com/ven-coder/assistsx
194+
[assists-examples-link]: https://github.com/ven-coder/assists-examples
195195
[api-reference]: https://github.com/ven-coder/Assists/blob/master/API_REFERENCE.md
196196
[changelog]: https://github.com/ven-coder/Assists/releases
197197
[afdian-link]: https://afdian.com/a/vencoder

docs/demo-gallery.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# 功能示例图集
2+
3+
本文档集中展示基于 Assists 生态开发的功能示例 GIF/截图,便于直观了解能力边界与效果。更多示例可直接下载 Demo 应用体验。
4+
5+
[📱 直接下载 Demo](https://www.pgyer.com/1zaijG)
6+
7+
---
8+
9+
## 基础功能
10+
11+
| 基础示例 | 进阶示例 | 高级示例 | 图片截取 |
12+
| :------: | :------: | :------: | :------: |
13+
| <img src="https://github.com/user-attachments/assets/b537bab4-cc55-41c2-8f81-9e8b965e939a" width="200" /> | <img src="https://github.com/user-attachments/assets/9b50628c-603e-47d1-a6ae-5600358575fc" width="200" /> | <img src="https://github.com/user-attachments/assets/262b9028-5926-478b-93bd-3e20110db391" width="200" /> | <img src="https://github.com/user-attachments/assets/522236e4-5880-4f00-9f4c-76728df3cfe6" width="200" /> |
14+
15+
## 高级示例
16+
17+
| 自动收能量 | 自动发朋友圈 | 自动滑动朋友圈 | 无障碍服务开启引导 |
18+
| :--------: | :----------: | :------------: | :----------------: |
19+
| <img src="https://github.com/ven-coder/Assists/assets/27257149/8d1d09b2-e4b3-44dc-b5df-68fcdcac7a62" width="200" /> | <img src="https://github.com/ven-coder/Assists/assets/27257149/4713656b-a8ff-4c99-9814-a0b883ebbe64" width="200" /> | <img src="https://github.com/ven-coder/Assists/assets/27257149/056ef46b-8076-4f90-ab5a-263ff308f8e8" width="200" /> | <img src="https://github.com/user-attachments/assets/9e20a757-8d8f-47e6-999b-8532b4e6827a" width="200" /> |
20+
21+
| 防止下拉通知栏 | 通知/Toast监听 | 自动接听微信电话 | 窗口缩放&拖动 |
22+
| :------------: | :------------: | :--------------: | :-----------: |
23+
| <img src="https://github.com/user-attachments/assets/76613db4-c0a9-4ad8-abde-ec0ef8f7ed09" width="200" /> | <img src="https://github.com/user-attachments/assets/cc6a861a-3512-43c0-9c1d-4e61229dc527" width="200" /> | <img src="https://github.com/user-attachments/assets/25472235-8d6d-4327-9bc5-db47253b7f0e" width="200" /> | <img src="https://github.com/user-attachments/assets/184fb248-66e0-4bb4-aaae-c1b8c4cef70a" width="200" /> |
24+
25+
## 更多示例
26+
27+
更多示例可直接下载 Demo 在设备上查看。
28+
29+
<img src="https://github.com/user-attachments/assets/39568ee6-b9f3-447f-8a81-4ef25692815b" width="150" />
30+
31+
[📱 直接下载 Demo](https://www.pgyer.com/1zaijG)

0 commit comments

Comments
 (0)