Skip to content

docs: prove a safe EditorWindow capture path and replace draft tooling screenshots #314

Description

Problem

PLAN.md WS-7.3 is the last open editor-tooling convergence item. The inspector-overlay screenshot manifest and guide still mark the current images as draft/stale because the Linux-devcontainer-to-Windows-host MCP topology has no proven first-class EditorWindow capture path.

Previous experiments established important safety boundaries:

  • Do not call UnityEditorInternal.InternalEditorUtility.ReadScreenPixel.
  • Do not automate native PrintWindow capture.
  • Do not switch Unity editor skins programmatically during capture.
  • Start from a Personal/light editor, record the actual skin, inspect every image, and clean the host state after capture.
  • Scene View and camera capture tools do not prove EditorWindow or Inspector rendering.

Desired outcome

Establish a repeatable, visually verified capture workflow for the package-owned Inspector, Project Settings, Message Monitor, and Flow Graph surfaces, then replace the draft/stale screenshot set with images of the shipped UI.

Acceptance criteria

  • Document one capture method that works from the configured Windows host editor without blocked native screen-reading primitives.
  • Prove the method on the Inspector and at least one package-owned EditorWindow before replacing any manifest entry.
  • Capture on Personal/light and record the Unity version and skin with each artifact.
  • Visually inspect each image for clipping, stale prototype UI, duplicate windows, incorrect theme classes, and sensitive project data.
  • Update docs/guides/inspector-overlay.md and the screenshot manifest together.
  • Remove every draft/stale marker only when its corresponding image has been replaced and reviewed.
  • Leave the host with no temporary scenes, windows, imported prototype assets, or changed skin preferences.
  • Keep scripts/__tests__/design-system-dumps.test.js green, including the bans on ReadScreenPixel and PrintWindow automation.
  • Run the relevant EditMode editor-tool contract fixtures through Unity MCP after the documentation update.

Related

  • PLAN.md WS-7.3 / D9
  • docs/images/inspector-overlay/README.md
  • docs/guides/inspector-overlay.md

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions