Skip to content

Latest commit

 

History

History
104 lines (88 loc) · 9.8 KB

README.md

File metadata and controls

104 lines (88 loc) · 9.8 KB

文档索引

本索引按用途组织仓库文档。2026-11-12 核对基线为项目版本 1.8.5-pre5(源码基线 1eb833a)。 下载版本以 GitHub Releases 为准; 某项功能写入 main 或通过源码测试,不表示已经发布,也不表示所有设备已通过验收。

从哪里开始

任务 入口
下载、了解功能 中文 README · English README · 日本語 README
安装驱动、投屏、反控、录制 完整使用教程
编译、运行测试、打包 开发与测试指南 · 贡献规范
了解模块和进程边界 软件架构
报告问题或安全漏洞 支持说明 · 安全政策
查版本变化和待办 变更记录 · 繁體中文變更記錄 · 发布说明索引 · 路线图
查许可与来源 项目许可证 · 第三方声明 · 桥接组件说明
编写自动化脚本 本地 HTTP API · Python 示例 · PowerShell/curl 示例
查历史问题与验证证据 审计与设计记录 · Issue 记录索引
参与社区 行为准则 · PR 模板

持续维护的技术说明

领域 文档及用途
USB 协议 PROTOCOL:配置切换、QuickTime 包、CoreMedia 与协商
显示与解码 D3D11_RENDERING:生产显示路径;DECODER_GUI_ANALYSIS:设计依据与历史测量
设备外形 DEVICE_CORNER_PROFILES:ProductType 匹配、圆角与拟合边界;独立窗口边框 · 覆盖目录 · 机型与边框审查
面板目录 APPLE_DISPLAY_CATALOG:型号、面板像素与实际编码尺寸的区别
音频与输出 WASAPI_AUDIO:播放与音频输出;OBS_OUTPUT:OBS、录制、推流、虚拟摄像头
驱动 DRIVER_DEPENDENCIES:依赖及交付;PARENT_DRIVER_MANAGEMENT:父设备绑定、确认与恢复边界
首次设置 FIRST_RUN_SETUP:设置流程与草稿;SETUP_TOOLS:设置中的检查及修复工具
反控概览 USB_DIRECT_TOUCH:前置条件;USB_TOUCH_ARCHITECTURE:进程与设备链路;USB_TOUCH_DESIGN:状态机设计
反控接口 USB_TOUCH_BRIDGE_USAGE:命令行、stdin/stdout、触控与键盘消息
五点触控 FIVE_POINT_TOUCH:触摸屏、并发键位映射、有线/无线共享触点及报告布局
兼容性 USB_TOUCH_DEVICE_COMPATIBILITY:实测记录及 DDI/HID 验证条件
UI 入口 REVERSE_CONTROL_UI_INVENTORY:反控入口;ERROR_DIALOG_CATALOG:错误和确认窗口
顶部工具栏 TOP_TOOLBAR_CUSTOMIZATION:组件库、拖动排序、聚焦动画与验证范围
输入焦点 KEYBOARD-FOCUS-CONTROL:本地文本输入、快捷键与手机键盘路由
键位映射 KEYBOARD_MAPPING:创建映射、启停和输入边界
多设备控屏 MULTI_DEVICE_CONTROL:连接保留、选项卡与独立窗口焦点、验证范围
自动化接口 api/README:鉴权、设备准备、控制租约、坐标、剪贴板与截图
捐赠资源 收款码与完整性保护
台湾本地化 LOCALIZATION-TAIWAN:资源、术语及验证入口

上述技术文档中引用的历史性能数据和真机结果仍只适用于各自记录的环境。

专项审计与验证记录

这些文件保留审查时的发现、修复和验证结果。它们是特定工作区、日期或设备下的记录, 不是所有版本的功能保证,也不表示本次文档整理重新执行了其中的真机或 UI 测试。 发生冲突时,先核对当前源码和目标版本,再更新上面的持续维护文档;不要覆盖历史证据。

主题 记录
项目文档核对 2026-11-12 复审 · 2026-11-05 完善 · 2026-10-01 核对
GitHub 问题 2026-09-23 审计 · 2026-10-01 审计 · 2026-10-01 修复记录
驱动错误 DRIVER_ERROR_AUDIT
USB 蓝屏研究 软件内部的探测、配置切换与句柄释放调用链
USB 反控打包与签名错误 USB_BACKEND_PACKAGING_REPAIR
外接键盘状态 连接注册、定时更新与取消清理审查
有线恢复 WIRED_RECOVERY_FIX · WIRED_RECOVERY_REAUDIT · WIRED_RECOVERY_LATENCY · WIRED_CONTROL_COUNTDOWN_FIX
近期反控与预览排查 API 截图与反控稳定性 · 最后一次完整重试 · 预览黑屏
原画横竖屏与方形画布 能力协商、实际帧和有效区域调查
Metal 性能 HUD 应用重启接入、自动化验证及 USB/AirPlay 实机边界
启动与设置绑定 隐藏启动绑定 · 托盘启动设置页
启动布局闪退 v1.8.5-pre5 Grid 数组越界复现与修复
设备实验室调研 rPlayHub 调研记录
交互与性能 INTERACTION-STABILITY-AUDIT · PERFORMANCE-AUDIT
UI 标准与一致性 UI-STANDARDS-REVIEW · UI-CONSISTENCY-AUDIT
布局与圆角 UI-ADAPTIVE-LAYOUT-AUDIT · UI-ROUNDED-WINDOW-AUDIT
本地化 LOCALIZATION-AUDIT · LOCALIZATION-RECHECK · LOCALIZATION-VALIDATION · 机器可读改动记录

此表只列常用入口,全部专项记录见审计与设计记录索引。 历史报告中的 work/、outputs/、outputs-next/、artifacts/ 等路径通常是审查者本机产物, 不随 Git 仓库分发;源码链接已统一为相对路径,历史行号不保证对应当前文件。

USB_TOUCH_DEMO_README.txt 是早期独立 Demo 的交付说明, 不代表 build.ps1 会生成该 Demo。当前桥接器的构建配方见 scripts/usb-bridge-recipe/SOURCE.md。

仓库其他说明

内容 入口
本地推流验证 Stream Lab · 旧版 SRS Docker 环境
原生协议测试夹具 fixtures/README
无线组件来源 AirPlay 源码与许可 · UxPlay 来源
USB 桥接构建来源 配方来源 · 固定依赖

第三方许可证及供应商附带说明按原文保留,由第三方声明定位; CMakeLists.txt、依赖清单和配置文件属于构建输入,不按普通叙述文档改写。

文档维护约定

  • 用户操作变化:同步中文、英文和日文 README 及使用教程,再补技术说明。
  • 协议、驱动、端口、进程或输出行为变化:更新对应专题和架构说明,写明实现入口。
  • 构建与测试变化:同步开发指南、贡献规范和实际脚本;示例默认读取项目版本,避免锁死旧版本。
  • 发布说明描述该版本的变化;审计记录保留日期、范围、证据和未验证项。
  • 截图、日志及示例使用脱敏设备标识;机器绝对路径改为仓库相对路径或明确的占位路径。
  • 新增文档时更新本索引;移动文件时同步所有相对链接。
  • 当前指南使用“已实现 / 待实机验证 / 计划”区分状态;历史报告保留原日期和结果,新增更正说明而不改写原测试结论。
  • 文档修改后从仓库根目录运行 python scripts/verify_docs.py,检查所有 Markdown 的本地链接、图片、标题锚点、围栏和 docs 索引可达性。 检查仅使用 Git 跟踪及未忽略文件,忽略目录中的本机产物不能使失效链接误报通过;外部 URL 不在离线检查范围内。