spoopyghosty0--frameport/docs/showcase/shots.yaml

# The docs screenshots: scripts/showcase/render_docs.py renders each into docs/images/<name>.png from the demo
# library (demo-library.yaml) with a pretend Frame, and rewrites a file only when the picture really changed.
# Steps: see scripts/showcase/steps.py. Each shot starts in a fresh window (its own app session).
#
#   viewport: [w, h]   browser size in px (default below); scale: UI scale (1.0)
#   crop:     {dialog: true, pad}: the open dialog; {anchor: <name>, left, top, width, height}: a box placed
#             relative to the top-left corner of the element called <name> (left/top may be negative);
#             or {x, y, width, height} in page px
#   docs:     where the image is used (checked by the tests: every image a doc shows has an entry here)

vars:
  game: com.camouflaj.manta          # installed on the pretend Frame
  new_game: com.CyanWorlds.Riven     # in the library, not installed yet

defaults:
  viewport: [1280, 820]

shots:
  - name: library
    docs: [README.md]
    steps:
      - go: library
      - wait_for: "On your Frame"
      - settle: true

  - name: game
    docs: [docs/INSTALL.md, docs/SHOWCASE.md]
    viewport: [1280, 1100]
    steps:
      - open_game: ${game}
      - wait_for: "Where it's installed"

  - name: game-settings
    docs: [docs/INSTALL.md]
    steps:
      - open_game: ${game}
      - call: {fn: settings_dialog, args: ["${game}"]}
      - wait_for: "Game settings"
    crop: {dialog: true}

  - name: patches
    docs: [docs/COMPATIBILITY.md]
    viewport: [1280, 2600]
    steps:
      - open_game: {package: "${game}", advanced: true}
      - wait_for: "What FramePort will do"
    crop: {anchor: "What FramePort will do", left: -32, top: -12, width: 1044, height: 820}

  - name: frame
    docs: [docs/COMPATIBILITY.md]
    steps:
      - go: frame
      - wait_for: "Ready to play"

  - name: files
    docs: [docs/INSTALL.md]
    steps:
      - go: files
      - wait_for: "Upload files…"
      - wait: 1.0
      - hook: {name: select_files, args: [1, 2]}

  - name: screenshots
    docs: [README.md]
    steps:
      - go: screenshots
      - wait_for: "Take screenshot"

  - name: screenshot-viewer
    docs: [README.md]
    steps:
      - go: screenshots
      - wait_for: "Take screenshot"
      - wait: 1.5
      - call: {fn: screenshots_view.viewer, args: [0]}
      - wait_for: "Close"

  - name: type-on-frame
    docs: [docs/INSTALL.md]
    steps:
      - hook: type_tab
      - wait_for: "Keyboard connected"

  - name: monitor
    docs: [README.md]
    viewport: [1280, 1150]
    steps:
      - go: monitor
      - wait_for: "Processes"
      - hook: monitor_settled   # the history replay finished (a slow runner shot it halfway: numbers differed)

  # newer screens (docs/SHOWCASE.md's gallery; the README picks what it needs)
  - name: live-view        # idle: a running stream shows its relay's random port and the data rate (no stable picture)
    docs: [docs/SHOWCASE.md]
    steps:
      - go: live
      - wait_for: "Ready when you are"

  - name: install-progress
    docs: [docs/SHOWCASE.md]
    steps:
      - hook: {name: held_install, args: ["${new_game}"]}
      - open_game: ${new_game}
      - wait_for: "Cancel"

  - name: appearance
    docs: [docs/SHOWCASE.md]
    steps:
      - go: settings
      - wait_for: "Portal (OLED)"

  - name: room             # experimental: the pretend Frame's made-up bedroom scan (fakes.fake_room), no real scan
    docs: [README.md, docs/INSTALL.md]
    viewport: [1280, 1690]
    steps:
      - hook: open_room
      - wait_for: "Furniture & screens"
      - park: true

  - name: room-editing     # a box picked in the list (its type, place and size) next to the clean-up's labels
    docs: [docs/INSTALL.md]
    viewport: [1280, 2000]  # (tall enough that nothing scrolls)
    steps:
      - hook: open_room
      - wait_for: "Furniture & screens"
      - hook: {name: room_editing, args: [box]}
      - park: true
    crop: {anchor: "Furniture & screens", left: -26, top: -28, width: 670, height: 1262}