Hatayama Uloopmcp Uloop Screenshot

uloop screenshot

Take a screenshot of any Unity EditorWindow by name and save as PNG.

Usage

uloop screenshot [--window-name <name>] [--resolution-scale <scale>] [--match-mode <mode>] [--capture-mode <mode>] [--annotate-elements] [--elements-only] [--output-directory <path>]

Parameters

Match Modes

Window Name

The window name is the text displayed in the window's title bar (tab). Common names: Game, Scene, Console, Inspector, Project, Hierarchy, Animation, Animator, Profiler. Custom EditorWindow titles are also supported.

Global Options

Examples

# Take a screenshot of Game View (default)
uloop screenshot

# Capture game rendering (coordinates match simulate-mouse, PlayMode required)
uloop screenshot --capture-mode rendering

# Annotate interactive UI elements with index labels (for simulate-mouse workflow)
uloop screenshot --capture-mode rendering --annotate-elements

# Get UI element coordinates without capturing an image (fastest)
uloop screenshot --capture-mode rendering --annotate-elements --elements-only

# Take a screenshot of Scene View
uloop screenshot --window-name Scene

# Capture all windows starting with "Project" (prefix match)
uloop screenshot --window-name Project --match-mode prefix

# Save screenshot to a specific directory
uloop screenshot --output-directory /tmp/screenshots

# Combine options
uloop screenshot --window-name Scene --resolution-scale 0.5 --output-directory /tmp/screenshots

Output

Returns JSON with:

• ScreenshotCount: Number of windows captured
• Screenshots: Array of screenshot info, each containing:
  • ImagePath: Absolute path to the saved PNG file
  • FileSizeBytes: Size of the saved file in bytes
  • Width: Captured image width in pixels
  • Height: Captured image height in pixels
  • CoordinateSystem: "gameView" (image pixel coords that must be converted with ResolutionScale and YOffset before using with simulate-mouse) or "window" (EditorWindow capture)
  • ResolutionScale: Resolution scale used for capture
  • YOffset: Y offset used in sim_y = image_y / ResolutionScale + YOffset when CoordinateSystem is "gameView"
  • AnnotatedElements: Array of annotated UI element metadata. Empty unless --annotate-elements is used. Sorted by z-order (frontmost first). Each item contains:
    • Label: Index label shown on the screenshot (A=frontmost, B=next, ...)
    • Name: Element name
    • Type: Element type (Button, Toggle, Slider, Dropdown, InputField, Scrollbar, Draggable, DropTarget, Selectable)
    • SimX, SimY: Center position in simulate-mouse coordinates (use directly with --x and --y)
    • BoundsMinX, BoundsMinY, BoundsMaxX, BoundsMaxY: Bounding box in simulate-mouse coordinates
    • SortingOrder: Canvas sorting order (higher = in front)
    • SiblingIndex: Transform sibling index under the element's direct parent (not a reliable z-order signal across nested UI hierarchies)

Coordinate Conversion (gameView)

When CoordinateSystem is "gameView", convert image pixel coordinates to simulate-mouse coordinates:

sim_x = image_x / ResolutionScale
sim_y = image_y / ResolutionScale + YOffset

When ResolutionScale is 1.0, this simplifies to sim_x = image_x, sim_y = image_y + YOffset.

When multiple windows match (e.g., multiple Inspector windows or when using contains mode), all matching windows are captured with numbered filenames (e.g., Inspector_1_*.png, Inspector_2_*.png).

Notes

• Use uloop focus-window first if needed
• Target window must be open in Unity Editor
• Window name matching is always case-insensitive

Converted and distributed by TomeVault — claim your Tome and manage your conversions.