[docs] update README guides and desktop screenshots

This commit is contained in:
dijunkun committed 2026-11-11 22:24:56 +08:00
1 parent 6414f2317f
commit b15a63cc9d
32 files changed
+267 -60

No files matched your search

+30 -8
View File
@@ -118,8 +118,8 @@ sudo apt install "./crossdesk-virtual-desktop-xfce-linux-amd64-<version>.deb"
| 键盘 | 发送组合键;Windows 的 `Ctrl+Alt+Del` 依赖远端服务 |
| 鼠标 | 控制 / 释放远端鼠标 |
| 扬声器 | 播放声音 / 静音 |
| 文件夹 | 选择文件发送到远端,并查看传输进度 |
| 画面设置 | 在当前会话中调整画面质量、采集帧率与画面偏好 |
| 文件夹 | 打开双栏文件浏览窗口,浏览本机和远端目录,双向传输文件与文件夹 |
| 画面设置 | 在当前会话中调整画面质量、采集帧率、受支持的远端分辨率与画面偏好 |
| 网络状态 | 查看流量、丢包率、帧率、分辨率、直连 / 中继、加密状态,以及被控端编码器和控制端解码器 |
| 隐私屏 | 开启或关闭被控电脑的隐私屏;悬停查看当前状态与可用操作 |
| 全屏 | 进入 / 退出全屏 |
@@ -135,6 +135,16 @@ macOS 保留一个 CrossDesk Dock 应用图标,主窗口与远程控制窗口
桌面端普通会话、桌面墙和移动端(Android、iOS、鸿蒙)的网络状态均显示“被控端编码器”和“控制端解码器”,使用实际的视频编解码器名称,包括回退后的软件编解码器。名称保持单行,超出可用宽度时自动横向滚动,完整显示时保持静止。名称统一采用“实现名称 (编码格式)”,名称首字母大写、技术缩写保留全大写,例如 `VideoToolbox (H.264)`、`NVENC (H.264)`、`NVDEC (H.264)`、`SVT-AV1 (AV1)`、`Dav1d (AV1)` 和 `LibAOM (AV1)`;Media Foundation 额外标注 `HW`(硬件)或 `SW`(软件)。被控端需要支持编码器状态上报;旧版本或尚未获取到的信息显示“—”。
### 浏览目录与传输文件
点击会话工具栏中的文件夹按钮,同时查看本机和远端文件列表。可输入路径、返回上级目录、按名称筛选、选择多个文件或文件夹,再点击 **发送到远端** / **发送到本机**,也可在两栏之间拖放。目标目录需已存在,同名文件按冲突命名规则另存;远端目录浏览需要兼容的被控端。
底部任务列表显示传输状态和进度,支持取消未完成任务与清除已完成记录。图中的路径、文件名和完成状态均为演示数据。
<p align="center">
<img src="images/desktop-files-zh.png" width="960" alt="文件传输窗口:本机和远端文件列表、发送方向与任务状态;数据为演示" />
</p>
### 在会话中调整画面
连接成功后,点击工具栏中的 **画面设置**(滑杆图标),直接选择低 / 中 / 高画质、**30 / 60 fps**,以及帧率优先 / 画质优先 / 平衡。选项会发送给当前被控端,无需断开重连;实际画面效果取决于网络、设备与编码器能力。旧版被控端不支持时,菜单会提示并禁用选项。
@@ -142,9 +152,11 @@ macOS 保留一个 CrossDesk Dock 应用图标,主窗口与远程控制窗口
被控端为 Windows、macOS 或 Linux X11 时,还可在 **画面设置 → 分辨率** 中选择当前显示器支持的桌面分辨率。调整无需重连,最后一个控制端断开后会恢复连接期间首次调整前的显示模式。Linux 需要使用 X11 采集及支持 RandR 的显示服务器;Wayland、XWayland 和使用自定义缩放或平移的显示配置暂不支持。可选分辨率由显示器或虚拟显示服务器提供,仅提供一个模式的虚拟屏不会额外生成模式。
<p align="center">
<img src="images/desktop-stream-video-settings-zh.png" width="800" alt="当前远程会话的画面设置菜单:画面质量、采集帧率与画面偏好;背景为公开页面演示图" />
<img src="images/desktop-stream-video-settings-zh.png" width="800" alt="当前远程会话的画面设置菜单:分辨率、画面质量、采集帧率与画面偏好;背景为公开页面演示图" />
</p>
桌面和原生移动端会按远端设备及显示器记住已确认成功的分辨率。再次连接时,若该显示器仍支持保存的模式,会重新请求应用;被控端在最后一个控制端断开时恢复原显示模式的行为不变。
<a id="settings"></a>
## 客户端设置与更新
@@ -157,15 +169,15 @@ macOS 保留一个 CrossDesk Dock 应用图标,主窗口与远程控制窗口
| 设置 | 说明 |
| --- | --- |
| 语言 | 中文、English、Русский |
| 语言 | 默认跟随系统,也可手动选择简体中文、繁体中文、英语、俄语、日语、韩语、德语、法语、西班牙语或巴西葡萄牙语,见 [本地化说明](../localization/README.md) |
| 视频编码格式 | H.264 / AV1;H.264 自动优先使用硬件编解码,不可用或初始化失败时回退到软件;桌面端 AV1 使用软件编解码 |
| 启用 IP 直连 | 默认开启;保存后即时启停 IP 直连。关闭会断开 IP 会话、停止监听并隐藏主窗口模式按钮,重启后保持 |
| 强制中继连接 | 关闭时自动选择连接方式,允许 P2P 和 TURN 中继回退;开启时仅通过中继连接 |
| 保存远程画面预览 | 默认开启,保存远程画面预览;关闭后缩略图区域显示被控端平台,并清除已有预览,保留连接记录和密码 |
| 被连接时开启隐私屏 | 设置本机被远程连接时是否自动启用隐私屏;会话中可从控制端工具栏切换 |
| 自托管配置 | 点击“编辑”填写服务器地址和信令服务端口,使用右侧开关启用 |
| 开机自启 | Windows 安装版 Release:使用现有 ID、密码在登录前提供远控;用户登录后自动启动普通客户端并接管同一身份,恢复完整功能。Windows 便携版和 Debug 不支持此开关。其他桌面平台保存后设置登录桌面时自动启动 |
| 启用守护进程 | Windows / Linux 桌面模式保存后立即启用或停用异常退出后的自动重启,无需重启程序;正常退出或注销不会重新拉起。macOS 下次启动生效,无头控制台模式不启用内置守护 |
| 开机自启 | Windows 安装版 Release:使用现有 ID、密码在登录前提供远控;用户登录后 GUI 自动启动并接入后台服务,恢复完整功能。Windows 便携版和 Debug 不支持此开关。其他桌面平台保存后设置登录桌面时自动启动 |
| 启用守护进程 | Windows / macOS / Linux 桌面模式保存后立即启用或停用异常退出后的自动重启,无需重启程序;正常退出或注销不会重新拉起,无头控制台模式不启用内置守护 |
| 文件保存路径 | 选择接收文件的目录 |
网络连接分组中的 IP 直连开关独立于 ID 连接使用的中继设置:
@@ -195,7 +207,17 @@ macOS 保留一个 CrossDesk Dock 应用图标,主窗口与远程控制窗口
客户端启动后会在后台检查版本,发现新版本时自动弹出更新提示,可查看更新说明并前往下载页面。关闭提示后,本次运行中的后台检查不会再次弹窗,主窗口菜单入口仍会显示更新提示;重新启动客户端后,如仍有新版本则再次提示。打开 **☰ → 关于** 可查看版本;有新版本时,点击版本信息下方的 **更新日志** 可再次打开更新提示,也可点击 **检查更新** 手动检查。
<p align="center">
<img src="images/desktop-about-zh.png" width="720" alt="关于窗口与检查更新按钮,版本号和检查结果为演示数据" />
<img src="images/desktop-about-zh.png" width="720" alt="关于窗口与检查更新按钮,development 为演示版本,未执行在线版本检查" />
</p>
<a id="feedback"></a>
### 反馈与诊断日志
打开主窗口 **☰ → 反馈与建议**,点击 **前往 GitHub 反馈** 提交问题或建议;点击 **导出诊断日志** 可将 CrossDesk、MiniRTC 日志及基本版本信息保存为 ZIP 文件。导出成功后界面显示保存位置,可在问题中附上日志包,并说明两端系统、版本、连接方式及复现步骤。
<p align="center">
<img src="images/desktop-feedback-zh.png" width="720" alt="反馈与建议:GitHub 反馈入口和导出诊断日志按钮" />
</p>
<a id="ios"></a>
@@ -204,7 +226,7 @@ macOS 保留一个 CrossDesk Dock 应用图标,主窗口与远程控制窗口
仓库的 [`apps/ios`](../apps/ios/README.md) 提供原生控制端,与桌面端使用同一套 MiniRTC 协议。它可以控制远端电脑;当前不提供将 iPhone / iPad 作为被控桌面的功能。
1. 按 [iOS 开发说明](../apps/ios/README.md) 使用 Xcode 构建并签名,安装到 iOS 16+ 的真机。
1. 从 [App Store](https://apps.apple.com/app/id6828859211) 安装,具体系统要求以商店页面为准;也可按 [iOS 开发说明](../apps/ios/README.md) 使用 Xcode 构建并签名,当前源码目标为 iOS 16+。
2. 在首页输入对端 ID,点击连接并填写密码;成功连接后可从“最近连接”中重连。
3. 在设置中选择鼠标模式:**相对位置**像触控板一样移动光标,**绝对位置**将触摸位置直接映射到远端画面。
4. 点击悬浮图标展开菜单,可切换显示器、显示键盘、控制声音或发送文件。收到的文件位于应用的 `Documents/Received`,可通过传输状态旁的分享按钮导出。