Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

[Feature]: Keystroke telemetry capture and shortcut HUD visualization

未关闭
  • 哪里不对？
#1,317 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

  • #1320 来自 @rainyflash —— 已关闭，未合并

评估

难度
5/5
预计耗时
一周以上
新手友好度
1/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
停滞
技术栈
electron, typescript
领域
desktop, full-stack

调研方向

The request spans recording telemetry, IPC and MCP tools, the AxcutDocument model, PreviewCanvas, SceneDescription, FloatingInspector, and V4Timeline; begin by reading the existing cursor telemetry pipeline at technical-documentation/architecture/cursor.md. Check the open pull request #1320 before taking this on. Done means privacy-filtered keystroke events can be captured, edited as timeline callouts, and rendered with configurable HUD settings.

由索引模型根据 Issue 内容生成。

描述

Search existing issues
  • I have searched the existing issues
Is your feature request related to a problem?

During software tutorials, coding demos, and shortcut-heavy workflows, viewers can see where the cursor clicks (via .cursor.json telemetry) but cannot see which keyboard shortcuts or key combinations the presenter pressed (e.g. Ctrl+Shift+P, Cmd+K, Enter, Esc). Manually adding text annotations for every shortcut is tedious and error-prone. (Related to #1286)

Describe the solution you'd like

Add end-to-end Keystroke Telemetry Capture & Shortcut HUD Visualization:

  1. Keystroke Telemetry Sidecar & Recording:
    • Capture keyboard shortcut events and special keys during recording into a <video>.keys.json sidecar (or alongside cursor telemetry) with privacy-safe filtering (capturing modifier combinations like Ctrl/Cmd/Alt/Shift + key and navigation/function keys by default, avoiding raw password/text typing).
    • Provide IPC and MCP/agent support (getKeystrokeTrack / setKeystrokeTrack) to read or inject recorded keystroke events.
  2. Document Model & Timeline (AxcutDocument):
    • Add clip-anchored keystrokeRanges (and editor-level keystroke HUD appearance settings: enabled, position, theme dark/light/glass, scale, holdDurationMs, modifiersOnly) so keystrokes can be automatically derived from telemetry or authored/edited/deleted as timeline pills.
  3. Editor UI (Preview HUD, Timeline & Inspector):
    • Render stylized keycap badges (KeystrokeOverlay) in PreviewCanvas and SceneDescription with smooth pop-in/fade-out transitions.
    • Allow toggling, styling, and editing keystroke callouts in FloatingInspector and V4Timeline.
  4. AI Agent & MCP Tools:
    • Expose getKeystrokeTrack, addKeystroke, setKeystroke, and keystroke HUD settings in setEditorSettings / getCurrentDocument so agents can inspect recorded shortcuts or place shortcut callout pills on the timeline.
Describe alternatives you've considered

Baking keystrokes directly into the recorded video pixels was rejected for the same reason cursor rendering uses .cursor.json telemetry: keeping keystrokes as structured data allows restyling, repositioning, filtering out mistakes, and staying crisp under zoom or aspect-ratio changes.

Additional context

Complements the existing cursor telemetry pipeline (technical-documentation/architecture/cursor.md).

主要语言
TypeScript
星标
3.7k
派生
231
平均合并
16 小时 25 分钟
30 天内合并 PR
331

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

getopenscreen/openscreen 的其他 Issue

查看 getopenscreen/openscreen 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。