Skip to content

Commit 47b5fb2

Browse files
committed
docs: 📝 Update docs
1 parent 81fe791 commit 47b5fb2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1361
-2756
lines changed

README-CN.md

Lines changed: 15 additions & 317 deletions
Original file line numberDiff line numberDiff line change
@@ -39,333 +39,31 @@
3939

4040
### macOS 可以通过 Homebrew 安装
4141

42-
请参阅 [homebrew-escrcpy](https://github.com/viarotel-org/homebrew-escrcpy)
42+
参阅 [homebrew-escrcpy](https://github.com/viarotel-org/homebrew-escrcpy)
4343

44-
## 快速上手
44+
## 文档
4545

46-
### USB 连接
47-
48-
> 注意:如果手机上提示调试授权请点击允许
49-
50-
1. 安卓手机需开启开发者模式并打开 USB 调试
51-
2. 打开 Escrcpy 并将安卓手机连接到你的电脑
52-
3. 这时 Escrcpy 设备列表应该已经检测到你的手机,点击开始镜像
53-
4. 开始享受吧
54-
55-
### WIFI 连接
56-
57-
#### 扫描二维码连接
58-
1. 同 USB 连接中的 1-2 步骤
59-
2. 在开发者模式中打开并进入无线调试
60-
3. 点击使用二维码配对设备
61-
4. 开始享受吧
62-
63-
#### 通过IP地址连接
64-
65-
> 注意:如果首次无线连接失败,你可能需要无线配对请参阅 [常见问题](#常见问题)
66-
>
67-
> 注意:需同时开启无线调试功能,并在无线调试页面中获取你的当前设备的无线地址(通常为你连接 WIFI 时分配的 IP 地址)及端口号(默认为 5555)
68-
69-
1. 同 USB 连接中的 1-2 步骤
70-
2. 将获取到的设备 IP 地址及端口号填写到 Escrcpy 中,然后点击连接设备
71-
3. 这时 Escrcpy 设备列表应该已经检测到你的手机,点击开始镜像
72-
4. 开始享受吧
73-
74-
### macOS && Linux
75-
76-
> 注意:在 Escrcpy@1.27.1+ 中初步集成了 scrcpy 二进制文件,无需手动安装 scrcpy。
77-
78-
1. Linux 可参阅的 [安装文档](https://github.com/Genymobile/scrcpy/blob/master/doc/linux.md)
79-
2. macOS 可参阅的 [安装文档](https://github.com/Genymobile/scrcpy/blob/master/doc/macos.md)
80-
3. 安装上述依赖成功后步骤同 USB 连接 和 WIFI 连接
81-
82-
### Gnirehtet 反向供网
83-
84-
> 注意: macOS 内部没有集成如需使用需要手动安装 [安装文档](https://github.com/Genymobile/gnirehtet)
85-
86-
Windows 及 Linux 端内部集成了 Gnirehtet, 用于提供 PC 到安卓设备的反向供网功能。
46+
- [快速上手](https://escrcpy.viarotel.eu.org/zhHans/guide/started)
47+
- [快捷键](https://escrcpy.viarotel.eu.org/zhHans/reference/scrcpy/shortcuts)
48+
- [设备操作](https://escrcpy.viarotel.eu.org/zhHans/guide/operation)
49+
- [偏好设置](https://escrcpy.viarotel.eu.org/zhHans/guide/preferences)
50+
- [反向供网](https://escrcpy.viarotel.eu.org/zhHans/reference/gnirehtet/)
8751

8852
## 开发人员
8953

9054
如果你是开发人员,希望运行或帮助改进该项目请参阅 [开发文档](https://github.com/viarotel-org/escrcpy/blob/main/develop.md)
9155

92-
## 快捷键
93-
94-
请参阅 [scrcpy/doc/shortcuts](https://github.com/Genymobile/scrcpy/blob/master/doc/shortcuts.md)
95-
96-
## 设备操作
97-
98-
### 批量处理
99-
100-
- 批量截取屏幕
101-
- 批量安装应用
102-
- 批量文件管理
103-
- 批量执行脚本
104-
- 批量计划任务
105-
106-
### 控制模式
107-
108-
- 镜像
109-
- 录制
110-
- 录制相机
111-
- 录制音频
112-
- 相机
113-
- 灵活启动
114-
- OTG
115-
116-
### 设备交互栏
117-
118-
- 切换键
119-
- 主屏幕
120-
- 返回键
121-
- 启动APP(多屏协同)
122-
- 关闭屏幕(实验性)
123-
- 通知栏
124-
- 电源键
125-
- 旋转屏幕
126-
- 音量控制
127-
- 截取屏幕
128-
- 重启设备
129-
- 安装应用
130-
- 文件管理
131-
- 执行脚本
132-
- 计划任务
133-
- 反向供网(Gnirehtet)
134-
135-
## 偏好设置
136-
137-
> 持续完善中 目前支持以下常用配置
138-
139-
### 通用
140-
141-
- 主题
142-
- 语言
143-
- 文件存储路径
144-
- Adb 路径
145-
- Scrcpy 路径
146-
- Gnirehtet 路径
147-
- Scrcpy 参数
148-
- 自动连接设备
149-
- 自动执行镜像
150-
- Gnirehtet 修复
151-
- 调试
152-
- 浮动控制栏
153-
154-
### 视频控制
155-
156-
- 禁用视频转发
157-
- 最大尺寸
158-
- 视频比特率
159-
- 刷新率
160-
- 视频编码
161-
- 显示方向
162-
- 旋转角度
163-
- 屏幕裁剪
164-
- 显示器
165-
- 视频缓冲
166-
- 接收器(v4l2)缓冲
167-
168-
### 设备控制
169-
170-
- 展示触摸点
171-
- 保持唤醒
172-
- 控制时关闭屏幕
173-
- 控制结束关闭屏幕
174-
- 控制时禁用自动亮屏
175-
- 模拟辅助显示器
176-
177-
### 窗口控制
178-
179-
- 窗口宽度
180-
- 窗口高度
181-
- 窗口横坐标
182-
- 窗口纵坐标
183-
- 无边框模式
184-
- 全屏模式
185-
- 始终位于顶部
186-
- 禁用屏幕保护程序
187-
188-
### 音频控制
189-
190-
- 禁用音频转发
191-
- 保持设备音频
192-
- 音频源
193-
- 音频编码
194-
- 音频比特率
195-
- 音频缓冲
196-
- 音频输出缓冲
197-
198-
### 音视频录制
199-
200-
- 录制视频格式
201-
- 录制视频方向
202-
- 录制时长
203-
- 禁用视频播放
204-
- 禁用音频播放
205-
206-
### 输入控制
207-
208-
- 鼠标模式
209-
- 鼠标绑定
210-
- 键盘模式
211-
- 键盘注入方式
212-
- 游戏手柄
56+
## 获得帮助
21357

214-
### 摄像控制
58+
> 因为是开源项目 全靠爱发电 所以支持有限 更新节奏不固定
21559
216-
- 摄像源
217-
- 摄像尺寸
218-
- 摄像比例
219-
- 摄像帧率
60+
- [常见问题](https://escrcpy.viarotel.eu.org/zhHans/help/escrcpy)
61+
- [反馈问题](https://github.com/viarotel-org/escrcpy/issues)
62+
- [联系邮箱](viarotel@qq.com)
22063

22164
## 下一步做什么?
22265

223-
> 优先级从高到低
224-
225-
1. 更好的标志 ✅
226-
2. 软件更新功能 ✅
227-
3. 录制和保存音视频 ✅
228-
4. 设备快捷交互控制栏 ✅
229-
5. 自定义 Adb 及 Scrcpy 依赖 ✅
230-
6. 自定义设备名称 ✅
231-
7. 偏好设置的导出及导入 ✅
232-
8. 对单个设备进行独立配置 ✅
233-
9. 添加 macOS 及 linux 操作系统的支持 ✅
234-
10. 国际化 ✅
235-
11. 深色模式 ✅
236-
12. 反向供网(Gnirehtet) ✅
237-
13. 相机镜像 ✅
238-
14. 多屏协同 ✅
239-
15. 文件推送、旋转屏幕、音频控制 ✅
240-
16. 批量连接历史设备 ✅
241-
17. 内置终端 ✅
242-
18. 自动执行镜像 ✅
243-
19. 灵活启动镜像 ✅
244-
20. 批量处理 ✅
245-
21. 计划任务 ✅
246-
22. 图形化文件管理器 ✅
247-
23. 浮动操作栏 ✅
248-
24. 增强录制功能 ✅
249-
25. 启动APP(多线程) ✅
250-
26. 主窗口贴边隐藏 ✅
251-
27. 对设备进行分组(通过筛选备注) ✅
252-
28. 改进历史设备连接体验 ✅
253-
29. 文件管理支持上传目录 ✅
254-
30. 支持将打开APP添加到桌面快捷方式(仅限Windows) ✅
255-
31. 支持批量启动设备 ✅
256-
32. 改进设置镜像窗口位置及大小的方式 🚧
257-
33. 改进批量连接设备的体验 🚧
258-
34. 支持图形化脚本编排工具 🚧
259-
260-
## 常见问题
261-
262-
### 电脑连接设备后无法检测到
263-
264-
1. 请重新插拔你的设备,并确认设备同意了 USB 调试授权窗口。
265-
2. 如果还不行,你的电脑可能缺少必要的驱动程序,请使用第三方工具 如:驱动精灵,安装必要的驱动后重试。
266-
267-
### 无法输入中文
268-
269-
> 在 Scrcpy@2.4+ 及以上版中,解决方法如下
270-
271-
1. Escrcpy 设置:在 `偏好设置``输入控制``键盘模式` 中选择 `uhid` 模式。
272-
2. 设备输入法准备:安装支持物理键盘的输入法(推荐微信输入法)并完成配置。
273-
3. 启动镜像:在 Escrcpy 中点击 `开始镜像`。验证:设备中 `设置``系统``语言和输入` 应显示 `实体键盘``屏幕键盘` 选项。
274-
4. 设备输入设置:在 `屏幕键盘` 中启用微信输入法。在 `实体键盘` 中配置键盘布局,使其与计算机键盘一致(仅需一次)。
275-
5. 计算机输入准备:将输入模式设为英文(重要)。
276-
6. 切换输入语言:使用 `Ctrl` + `Shift` 在中英文间切换。
277-
7. 开始使用。
278-
279-
[下载微信输入法](https://z.weixin.qq.com/)
280-
281-
### 无线连接提示: 目标计算机积极拒绝访问
282-
283-
第一次无线连接可能需要配对 或 插入 USB 以保证与电脑建立连接即授权成功后方可使用
284-
285-
### 通过数据线连接后点击无线模式没有反应
286-
287-
请再点一次,或点击刷新设备,一般不会超过两次,如果还不行,请提供机型和安卓版本信息到 [Issues](https://github.com/viarotel-org/escrcpy/issues)
288-
289-
### 设备交互控制栏为什么不设计为自动跟踪吸附的悬浮菜单?
290-
291-
需要注意的是 Escrcpy 原则上只是基于 Scrcpy 实现的 GUI 版本,尽管它确实扩展了一些功能,但是这些功能都是不影响 Scrcpy 核心的前提下,而如果要实现该功能我将不得不对 Scrcpy 底层进行修改,这会使 Escrcpy 更难以与 Scrcpy 保持同步更新,这将得不偿失。
292-
因此,综合考虑,我们决定采用现有的方案,并期待 Scrcpy 未来能够增加原生交互控制栏的支持。
293-
294-
### 某些设备连接镜像后可以看到画面但是无法操作
295-
296-
> 注意:以小米手机为例,不仅需要开启 USB 调试还需要开启 USB 调试(安全设置)也就是允许通过 USB 调试修改权限或模拟点击的功能
297-
298-
可供参阅的详细说明 [鼠标和键盘不工作的原因](https://github.com/Genymobile/scrcpy/blob/master/FAQ.md#mouse-and-keyboard-do-not-work)
299-
300-
### 下载软件包时提示报毒导致无法正常下载
301-
302-
> 经过反馈,有时在 Windows 环境下,由于软件包没有进行证书签名,可能会被 Windows Defender 误认为有害而导致拦截提示,可以尝试以下解决方法
303-
304-
1. 打开 `Windows 安全中心`
305-
2. 选择 `病毒和威胁防护`
306-
3.`病毒和威胁防护设置` 下,点击 `管理设置`
307-
4. 找到 `实时保护`,如果权限允许,可以尝试点击关闭。如果无法关闭实时保护,请跳过此步骤。
308-
5. 向下滑动页面,找到 `排除项`,点击 `添加或删除排除项`
309-
6. 添加您下载软件包的文件夹路径作为排除项,即将该文件夹添加到`排除列表`中。
310-
311-
### 获取设备列表失败或开始镜像/录屏报错
312-
313-
> 该问题一般是 `Adb``Scrcpy` 依赖路径错误导致的,可以尝试以下解决方法
314-
315-
1. 在菜单中选择 `偏好设置`,然后在 `Global 模式` 下点击右上角的 `重置配置`
316-
2. 接下来,进入 `设备列表` 页面,并尝试重新开启镜像功能。
317-
3. 如果问题仍然存在,请确保您已下载并安装了最新版本的 `Escrcpy`
318-
4. 按下 `Ctrl` + `Shift` + `I` 进入开发者工具,并查看是否有任何报错信息。
319-
5. 如果有报错,请截图并在 [反馈问题](https://github.com/viarotel-org/escrcpy/issues) 页面中提交您的问题。
320-
321-
### macOS 关闭窗口选择最小化到托盘后顶部右侧状态栏找不到图标
322-
323-
> 这个一般是状态栏图标过多导致无法展示 Escrcpy 的图标 推荐用以下工具解决
324-
325-
- [iBar](https://www.better365.cn/ibar.html)
326-
- [Bartender](https://www.macbartender.com/)
327-
328-
### macOS 安装成功后打开提示文件损坏
329-
330-
> 这个通常是因为软件包本身没有签名导致的,可以尝试以下解决方法
331-
332-
1. 终端中执行 `sudo spctl --master-disable` 以允许任何来源
333-
2. 终端中执行 `sudo xattr -r -d com.apple.quarantine /Applications/Escrcpy.app` 以尝试修复提示软件包损坏
334-
335-
### 无法定位程序输入点 DiscardVirtualMemory 于动态链接库 KERNEL32.dll 上。
336-
337-
仅支持 `Windows 10` 及更高版本。
338-
339-
### 音频捕获异常导致镜像失败
340-
341-
> 通常是因为您的计算机缺少音频输出,或者您的 Android 版本过低(Android 11+)。
342-
343-
请尝试通过`偏好设置`中的`禁用音频转发`功能,以解决此问题。
344-
345-
### 微软商店版本启动镜像报错
346-
347-
> 这是因为该版本的安装目录内部文件没有可执行权限导致的
348-
349-
你需要自定义 `scrcpy` 以及 `adb` 的文件路径(确保具有可执行权限),如果用到反向供网则同样需要以同样方法配置 `gnirehtet`
350-
351-
### Could not execute "adb start-server"
352-
353-
这可能是因为安装路径中包含中文或特殊字符导致的,请尝试更改安装路径。
354-
355-
### Linux 系统中安装后无法打开
356-
357-
> 一些流行的发行版(如 Ubuntu 24.04)对 AppImage 应用程序实施了新的限制,限制了沙箱的使用。临时解决方法如下:
358-
359-
```shell
360-
sudo chmod 4755 /opt/Escrcpy/chrome-sandbox
361-
```
362-
363-
## 获得帮助
364-
365-
> 因为是开源项目 全靠爱发电 所以支持有限 更新节奏不固定
366-
367-
- issues: [反馈问题](https://github.com/viarotel-org/escrcpy/issues)
368-
- email: viarotel@qq.com
66+
[里程碑](https://escrcpy.viarotel.eu.org/zhHans/guide/milestones)
36967

37068
## 致谢
37169

@@ -377,7 +75,7 @@ sudo chmod 4755 /opt/Escrcpy/chrome-sandbox
37775
- [vue](https://vuejs.org/)
37876
- [gnirehtet](https://github.com/Genymobile/gnirehtet/)
37977

380-
## 赞助项目
78+
## 捐赠项目
38179

38280
> 如果该项目帮到你的话,可以请我喝杯咖啡,让我更有精神完善该项目 😛
38381
@@ -397,4 +95,4 @@ sudo chmod 4755 /opt/Escrcpy/chrome-sandbox
39795

39896
## Star 历史
39997

400-
[![Star History Chart](https://api.star-history.com/svg?repos=viarotel-org/escrcpy&type=Date)](https://star-history.com/#viarotel-org/escrcpy&Date)
98+
[![Star History Chart](https://api.star-history.com/svg?repos=viarotel-org/escrcpy&type=Date)](https://star-history.com/#viarotel-org/escrcpy&Date)

0 commit comments

Comments
 (0)