SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsunity-playmode-testing

unity-playmode-testing

Testing & quality

View repository

Updated 10-16 03:13

About this skill

Play Mode Testing

With --output json, results use {success, command, data, errors, warnings}. Check the exit status and envelope success first; tool-result fields in this skill are relative to data. Read failure codes from errors[0].code; see unity-cli-usage for exit-code recovery.

Control Play Mode, run EditMode/PlayMode tests, simulate input devices, and capture media. This skill is the runtime sibling of unity-input-system (asset authoring) and unity-ui-automation (UI interaction).

Use When

  • The user wants to run EditMode or PlayMode tests.
  • The task requires runtime input simulation.
  • The user wants screenshots or video from the current game or editor state.
  • The user wants to inspect current test progress or runtime state.

Do Not Use When

  • Configure AudioClip import, AudioMixer routing and AudioSource playback as one verified workflow: use unity-audio-setup.

  • Configure Locale/String Table assets and verify localized UI text: unity-localization.

  • Build and verify a complete sprite / Tilemap / Pixel Perfect workflow: unity-2d-sprite-tilemap.

  • Build a complete UXML/USS UI Toolkit screen and verify its interactions: use unity-ui-toolkit-build.

  • The request starts by creating a new project and installing its bridge; use unity-project-bootstrap to orchestrate the complete workflow.

  • The task is editing input action assets; use unity-input-system.

  • The task targets only UI element interaction without runtime gameplay; use unity-ui-automation.

  • The work is purely static scene or code inspection; use the corresponding read-only skill.

Preferred Flow

  1. Confirm editor state with get_editor_state before entering Play Mode or running tests.
  2. Enter Play Mode or start tests, then wait until the runtime is ready before sending input.
  3. Capture screenshots or short video only after the target state is visible.
  4. Stop Play Mode or recording cleanly and report the final status.
  5. If capture_screenshot returns "fallback": "os", the Editor did not respond (often a modal dialog). Inspect the desktop image, resolve the dialog, then retry. Pass "osFallback": false to get the timeout error instead.
unity-cli raw play_game --json '{}'
unity-cli raw input_keyboard --json '{"key":"space","action":"press"}'
unity-cli raw capture_screenshot --json '{"captureMode":"game","width":1280,"height":720}'
unity-cli raw run_tests --json '{"testMode":"PlayMode"}'
unity-cli raw get_test_status --json '{}'
unity-cli raw stop_game --json '{}'

Examples

Input simulation and InputAction notifications

Requires Input System enabled and a running Play session. Replace the asset path with an existing input asset. Enable the intended action map in the game's runtime code and observe its performed/canceled callback (for example, log a counter). get_input_actions_state inspects asset maps/actions/bindings; it does not prove that callbacks fired, and a PlayerInput runtime copy can differ from the asset.

unity-cli raw input_keyboard --json '{"key":"space","action":"press","holdSeconds":0.2}'
unity-cli raw input_gamepad --json '{"action":"button","button":"a","buttonAction":"press","holdSeconds":0.2}'
unity-cli raw input_mouse --json '{"action":"move","x":100,"y":200,"absolute":true}'
unity-cli raw input_touch --json '{"action":"tap","x":100,"y":200,"touchId":0}'
unity-cli raw create_input_sequence --json '{"sequence":[{"type":"keyboard","params":{"action":"press","key":"space","holdSeconds":0.1}},{"type":"mouse","params":{"action":"move","x":100,"y":200,"absolute":true}}],"delayBetween":80}'
unity-cli raw get_input_actions_state --json '{"assetPath":"Assets/Input/Player.inputactions","includeBindings":true}'
unity-cli raw read_console --json '{"count":20}'

Check the callback evidence after sending input. holdSeconds holds a press across frames before release; sequence delayBetween is milliseconds. Device state alone is not evidence of a gameplay notification. For gamepad sticks, x/y specify individual processed axes; a diagonally processed Vector2 can differ.

Video and PNG sequences

Requires a graphics-enabled Editor with Recorder installed and a visible Game View. Start one session, allow frames to render, inspect status, then stop before starting another. format accepts mp4, webm, or png_sequence (run the same flow for each).

unity-cli raw capture_video_start --json '{"captureMode":"game","format":"png_sequence","width":320,"height":180,"fps":10,"maxDurationSec":0}'
unity-cli raw capture_video_status --json '{}'
unity-cli raw capture_video_stop --json '{}'

Check isRecording and the final outputPath. For PNG sequences it names the first frame in a unique session directory; verify subsequent PNG files exist too.

Tests with Domain Reload enabled

Domain Reload may remain enabled in Enter Play Mode Settings. Start tests from Edit Mode; the bridge persists and recovers the result across the reload. Poll status until complete, including results, and inspect passed/failed counts. A temporary disconnect during reload is not a failed test; reconnect and query status instead of submitting a duplicate test run.

unity-cli raw run_tests --json '{"testMode":"PlayMode"}'
unity-cli raw get_test_status --json '{"includeTestResults":true}'

Method hot reload preview

Requires optional FastScriptReload 1.8.0, a supported macOS Editor, a compiled baseline and Play Mode. Replace the path with an existing eligible script. Disable Fast Script Reload's automatic and on-demand reload in its settings first; the bridge rejects concurrent patchers rather than changing those preferences. Inspect supported before beginning; do not report an unsupported preview as a pass.

unity-cli raw hot_reload_status --json '{}'
unity-cli raw hot_reload --json '{"action":"begin","path":"Assets/HotReloadProbe.cs"}'
unity-cli raw hot_reload --json '{"action":"recover"}'

begin returns appliedRevision; to apply complete candidate source and verify the actual method change, follow the Hot Reload Preview Loop. recover stops Play and recompiles; poll hot_reload_status until idle. Preview does not save source. Persist a verified edit through unity-csharp-edit afterwards. If begin returns HOT_RELOAD_BASELINE_UNPROVEN, run recover, wait for idle, then re-enter Play Mode and begin again against the freshly compiled baseline.

  • "Run PlayMode tests for the player flow and report the result."
  • "Enter Play Mode, press space, and capture a screenshot."
  • "Record a 5 second gameplay clip and stop automatically."

References