gdharness 1.1.29 → 1.1.30

package/build/cli.js

@@ -17841,7 +17841,7 @@ var init_tool_definitions = __esm(() => {
     },
     {
       name: "runtime_capture",
-      description: "A picture of the running game: the whole screen or one viewport, as an image. The whole screen includes the game's own dialogs and popups where they sit, also when a project opens them as windows of their own (subwindows not embedded). Needs the game running with a window. A capture asked for before the game's first frame is drawn waits for that frame, since the game announces itself before it and the viewport holds nothing it drew until then.",
+      description: "A picture of the running game: the whole screen, one region or node of it at full resolution, or one viewport, as an image. The whole screen includes the game's own dialogs and popups where they sit, also when a project opens them as windows of their own (subwindows not embedded). Needs the game running with a window. A capture asked for before the game's first frame is drawn waits for that frame, since the game announces itself before it and the viewport holds nothing it drew until then.",
       parameters: {
         projectPath: RUNNING_PROJECT_PATH,
         pid: RUNNING_PID,
@@ -17860,6 +17860,22 @@ var init_tool_definitions = __esm(() => {
           minimum: 1,
           description: "Scale the image to this height. Given alone, the width keeps the picture's proportions."
         },
+        region: {
+          type: "object",
+          ops: ["screenshot"],
+          description: "screenshot: capture only this rectangle of the window, at the game's own pixels: x, y, width and height in window pixels, or the window rectangle runtime_inspect rect answers, passed as it came. A region partly outside the window is cut to it and the answer says clipped; one wholly outside is refused. The answer names the region captured in window pixels, and drawnAt when the project draws at its own size and stretches that to the window, since the picture then has the game's pixels rather than the window's."
+        },
+        nodePath: {
+          type: "string",
+          ops: ["screenshot"],
+          description: "screenshot: capture only where this node is drawn, as runtime_inspect rect answers it: a Control's rectangle, what a 3D node's geometry covers, or what a Sprite2D draws. A node with a position and no extent is refused; give region around it instead. Not with region."
+        },
+        zoom: {
+          type: "integer",
+          minimum: 1,
+          maximum: 16,
+          description: "Enlarge the picture this many times, each pixel made a square of pixels rather than blended with its neighbours, so a thin line or a corner can be read. Not with width or height. Default 1."
+        },
         outputPath: {
           type: "string",
           description: "Also save the picture as a PNG at this absolute path, for somebody to open later; the answer says where. Refused unless it ends in .png, its directory exists, it is outside the project, and no file is there already."
@@ -39645,6 +39661,25 @@ function captureDestinationRefusal(outputPath, projects) {
   }
   return null;
 }
+function captureDetail(payload) {
+  const parts = [];
+  const region = payload["region"];
+  if (region !== null && typeof region === "object") {
+    const named = region;
+    const at = (key) => String(Math.round(Number(named[key]) * 100) / 100);
+    parts.push(`of the window region at ${at("x")},${at("y")}, ${at("width")}x${at("height")} window pixels${payload["clipped"] === true ? ", clipped to the window" : ""}`);
+  }
+  const drawnAt = payload["drawnAt"];
+  if (drawnAt !== null && typeof drawnAt === "object") {
+    const drawn = drawnAt;
+    parts.push(`at the game's own pixels: it draws at ${String(drawn["width"])}x${String(drawn["height"])} and stretches that to its window`);
+  }
+  if (typeof payload["zoom"] === "number") {
+    parts.push(`enlarged ${payload["zoom"]} times`);
+  }
+  const note = typeof payload["note"] === "string" ? `. ${payload["note"]}` : "";
+  return parts.length === 0 ? note : `, ${parts.join(", ")}${note}`;
+}
 function patienceForFrames(frames, atLeast) {
   return Math.max(atLeast, frames / SLOWEST_FRAME_RATE * 1000 + atLeast);
 }
@@ -44398,7 +44433,7 @@ ${staleNote}`);
         content: [
           {
             type: "text",
-            text: `Screenshot captured: ${dimensions}${chosenAmongSeveral ? ` from pid ${own}, the game this server holds` : ""}${saveTo === null ? "" : `. Saved to ${saveTo}`}${staleNote === undefined ? "" : `
+            text: `Screenshot captured: ${dimensions}${chosenAmongSeveral ? ` from pid ${own}, the game this server holds` : ""}${captureDetail(payload)}${saveTo === null ? "" : `. Saved to ${saveTo}`}${staleNote === undefined ? "" : `
 
 ${staleNote}`}`
           },

package/build/godot/addons/gdharness_runtime/runtime_autoload.gd

@@ -58,7 +58,7 @@ var _queries: Queries = Queries.new(self, values)
 var _changes: Changes = Changes.new(self, values)
 var _input: InputCommands = InputCommands.new(self, values)
 var _typing: Typing = Typing.new(self)
-var _capture: Capture = Capture.new(self)
+var _capture: Capture = Capture.new(self, values)
 var _waits: Waits = Waits.new(self, values)
 
 var _server: TCPServer

package/build/godot/addons/gdharness_runtime/runtime_capture.gd

@@ -4,12 +4,20 @@ extends RefCounted
 
 const Read = preload("reading.gd")
 const Values = preload("runtime_values.gd")
+const Queries = preload("runtime_queries.gd")
+const Screen = preload("runtime_screen.gd")
+
+## How far zoom enlarges at most. Sixteen makes a 3-pixel ring 48 pixels across, past any need to
+## see it, and a 200-pixel region 3200, past the size anybody reads a picture at.
+const ZOOM_MOST: int = 16
 
 var _host: Node
+var _values: Values
 
 
-func _init(host: Node) -> void:
+func _init(host: Node, values: Values) -> void:
 	_host = host
+	_values = values
 
 
 func capture_screenshot(params: Dictionary) -> Dictionary:
@@ -88,12 +96,155 @@ static func scaled_to(drawn: Vector2i, width: int, height: int) -> Vector2i:
 	return drawn
 
 
+## What part of the picture a capture is cut to and how far it is enlarged, from what was asked, or
+## a refusal saying what is wrong with the asking. Read before a frame is waited for, so a call that
+## cannot be answered costs no wait.
+##
+## A region and a node are asked for because width and height scale the whole picture, and a
+## question about a 3-pixel ring in a 1600-pixel window was answered by capturing the window, saving
+## it and cropping it with a script of the caller's own, three calls for every look.
+func _cut_asked(params: Dictionary, in_window: bool) -> Dictionary:
+	var region_given: Variant = params.get("region")
+	var node_path: String = str(params.get("nodePath", ""))
+	var zoom: int = Read.as_int(params.get("zoom", 1), 1)
+	var sized: bool = Read.as_int(params.get("width", 0)) > 0 or Read.as_int(params.get("height", 0)) > 0
+	if region_given != null and not node_path.is_empty():
+		return _refused("region and nodePath each name the part to capture; give one of them")
+	if (region_given != null or not node_path.is_empty()) and not in_window:
+		return _refused(
+			(
+				"region and nodePath are in the window's pixels, and this viewport's texture is in its "
+				+ "own: capture the screen with them, or this viewport whole"
+			)
+		)
+	if zoom < 1 or zoom > ZOOM_MOST:
+		return _refused("zoom is a whole factor from 1 to %d, and %d was asked for" % [ZOOM_MOST, zoom])
+	if zoom > 1 and sized:
+		return _refused(
+			(
+				"zoom enlarges by a whole factor and keeps every pixel square, and width and height "
+				+ "scale to a size; give one or the other"
+			)
+		)
+	var asked: Dictionary = {"zoom": zoom}
+	if region_given != null:
+		var region: Variant = region_of(_values, region_given)
+		if region == null:
+			var shape: String = (
+				"region is a rectangle in window pixels with an area: x, y, width and height, or the "
+				+ "window rectangle runtime_inspect rect answers, passed back as it came. %s is neither"
+			)
+			return _refused(shape % JSON.stringify(region_given))
+		asked["region"] = region
+	if not node_path.is_empty():
+		asked["node_path"] = node_path
+	return asked
+
+
+static func _refused(message: String) -> Dictionary:
+	return {"type": "error", "message": message}
+
+
+## The rectangle [param given] names: the four numbers x, y, width and height, or a rectangle as the
+## runtime answers one, its two corners tagged with their type, passed back as it came. Null when it
+## is neither or has no area.
+static func region_of(values: Values, given: Variant) -> Variant:
+	if not given is Dictionary:
+		return null
+	var fields: Dictionary = given
+	fields = fields.duplicate()
+	if not fields.has("_type"):
+		fields["_type"] = "Rect2"
+	var rebuilt: Variant = values.deserialize(fields)
+	var region: Rect2
+	if rebuilt is Rect2:
+		region = rebuilt
+	elif rebuilt is Rect2i:
+		var whole: Rect2i = rebuilt
+		region = Rect2(whole)
+	else:
+		return null
+	if not region.has_area():
+		return null
+	return region
+
+
+## Where [param node] is drawn, in window pixels, as runtime_inspect rect answers it: a Control's
+## rectangle, what a 3D node's geometry covers, or what a 2D node that knows its own rectangle draws.
+## A refusal's message when it has no extent on screen.
+static func drawn_rect_of(node: Node) -> Variant:
+	if node is Control:
+		var control: Control = node
+		return Screen.rect_in_window(
+			control.get_viewport(),
+			control.get_global_transform_with_canvas() * Rect2(Vector2.ZERO, control.size)
+		)
+	if node is Node3D:
+		var spatial: Node3D = node
+		var found: Dictionary = Queries.in_frame(spatial)
+		if not found.has("rect"):
+			return "%s is not drawn by any current camera, so it covers nothing on screen" % node.get_path()
+		var covered: Rect2 = found["rect"]
+		return Screen.rect_in_window(spatial.get_viewport(), covered)
+	if node is Node2D and node.has_method("get_rect"):
+		var item: Node2D = node
+		var own: Rect2 = item.call("get_rect")
+		return Screen.rect_in_window(item.get_viewport(), item.get_global_transform_with_canvas() * own)
+	var no_extent: String = (
+		"%s is a %s, which has a position on screen and no extent; give region around the point "
+		+ "runtime_inspect rect answers for it"
+	)
+	return no_extent % [node.get_path(), node.get_class()]
+
+
+## [param region], in window pixels, as pixels of a picture drawn at [param drawn] in a window
+## [param window] pixels across: the same rectangle when the two match, scaled when the project draws
+## at its own size and stretches that to the window. Widened to whole pixels, so an edge falling
+## inside a pixel keeps that pixel, and cut to the picture. Without area when none of it is in it.
+static func in_picture(region: Rect2, window: Vector2i, drawn: Vector2i) -> Rect2i:
+	return widened(region, window, drawn).intersection(Rect2i(Vector2i.ZERO, drawn))
+
+
+## [param region] in the picture's pixels as [method in_picture] takes it, before it is cut to the
+## picture, which is what tells a region that was clipped from one that fitted.
+static func widened(region: Rect2, window: Vector2i, drawn: Vector2i) -> Rect2i:
+	var scale: Vector2 = Vector2.ONE
+	if window.x > 0 and window.y > 0:
+		scale = Vector2(drawn) / Vector2(window)
+	var start: Vector2 = (region.position * scale).floor()
+	var end: Vector2 = (region.end * scale).ceil()
+	return Rect2i(Vector2i(start), Vector2i(end - start))
+
+
+## [param picture], pixels of a picture drawn at [param drawn], as the window pixels it covers in a
+## window [param window] pixels across: what an answer names, since the region was asked for in them.
+static func in_window_pixels(picture: Rect2i, window: Vector2i, drawn: Vector2i) -> Dictionary:
+	var scale: Vector2 = Vector2.ONE
+	if drawn.x > 0 and drawn.y > 0 and window.x > 0 and window.y > 0:
+		scale = Vector2(window) / Vector2(drawn)
+	var start: Vector2 = Vector2(picture.position) * scale
+	var size: Vector2 = Vector2(picture.size) * scale
+	return {"x": start.x, "y": start.y, "width": size.x, "height": size.y}
+
+
+## [param image] cut to [param picture] and enlarged [param zoom] times, each pixel made a square of
+## them rather than blended with its neighbours, so a pixel in the answer is a pixel the game drew.
+static func cut(image: Image, picture: Rect2i, zoom: int) -> Image:
+	var part: Image = image.get_region(picture)
+	if zoom > 1:
+		part.resize(part.get_width() * zoom, part.get_height() * zoom, Image.INTERPOLATE_NEAREST)
+	return part
+
+
 ## The server names the file, so a game cannot point it at a path of its own choosing; a call
 ## with no path is a call the server did not make.
 func _capture(viewport: Viewport, params: Dictionary, with_windows: bool = false) -> Dictionary:
 	var requested_path: String = str(params.get("output_path", ""))
 	if requested_path.is_empty():
 		return {"type": "error", "message": "output_path required"}
+	var asked: Dictionary = _cut_asked(params, with_windows)
+	if asked.has("message"):
+		return asked
 
 	# Godot draws nothing to a minimised window and nothing at all without one, and the
 	# texture keeps whatever was drawn last. A capture then comes back byte for byte the same
@@ -127,12 +278,57 @@ func _capture(viewport: Viewport, params: Dictionary, with_windows: bool = false
 	if with_windows:
 		_lay_native_windows(image)
 
-	var drawn: Vector2i = Vector2i(image.get_width(), image.get_height())
-	var target: Vector2i = scaled_to(
-		drawn, Read.as_int(params.get("width", 0)), Read.as_int(params.get("height", 0))
-	)
-	if target != drawn:
-		image.resize(target.x, target.y)
+	var described: Dictionary = {}
+	var region: Variant = asked.get("region")
+	if asked.has("node_path"):
+		var node_path: String = asked["node_path"]
+		var standing: Dictionary = Values.node_at(_host.get_tree().root, node_path)
+		if standing.has("message"):
+			return standing
+		var node: Node = standing["node"]
+		var placed: Variant = drawn_rect_of(node)
+		if placed is String:
+			var why: String = placed
+			return _refused(why)
+		region = placed
+		# A hidden node's rectangle is still a place, and what is drawn there is whatever is behind it.
+		if not Queries.shown(node):
+			described["note"] = (
+				"%s is hidden, so this is what is drawn where it would be rather than the node" % node_path
+			)
+	if region != null:
+		var asked_region: Rect2 = region
+		var window: Vector2i = _host.get_tree().root.size
+		var picture_size: Vector2i = image.get_size()
+		var whole: Rect2i = widened(asked_region, window, picture_size)
+		var picture: Rect2i = whole.intersection(Rect2i(Vector2i.ZERO, picture_size))
+		if not picture.has_area():
+			return _refused(
+				(
+					"The region at %s, %s pixels across, is outside the window, which is %dx%d pixels"
+					% [asked_region.position, asked_region.size, window.x, window.y]
+				)
+			)
+		image = cut(image, picture, 1)
+		described["region"] = in_window_pixels(picture, window, picture_size)
+		if picture != whole:
+			described["clipped"] = true
+		# The project draws at its own size and stretches that to the window, so the picture's pixels
+		# are not the window's: said, because a caller sizing a region by window pixels gets fewer.
+		if picture_size != window:
+			described["drawnAt"] = {"width": picture_size.x, "height": picture_size.y}
+
+	var zoom: int = asked["zoom"]
+	if zoom > 1:
+		image = cut(image, Rect2i(Vector2i.ZERO, image.get_size()), zoom)
+		described["zoom"] = zoom
+	else:
+		var drawn: Vector2i = Vector2i(image.get_width(), image.get_height())
+		var target: Vector2i = scaled_to(
+			drawn, Read.as_int(params.get("width", 0)), Read.as_int(params.get("height", 0))
+		)
+		if target != drawn:
+			image.resize(target.x, target.y)
 
 	var screenshot_path: String = requested_path
 	if screenshot_path.begins_with("user://") or screenshot_path.begins_with("res://"):
@@ -141,10 +337,12 @@ func _capture(viewport: Viewport, params: Dictionary, with_windows: bool = false
 	if save_error != OK:
 		return {"type": "error", "message": "Failed to save screenshot as PNG: " + str(save_error)}
 
-	return {
+	var answer: Dictionary = {
 		"type": "screenshot_file",
 		"format": "png",
 		"width": image.get_width(),
 		"height": image.get_height(),
 		"path": screenshot_path
 	}
+	answer.merge(described)
+	return answer

package/build/index.js

@@ -31825,7 +31825,7 @@ var TOOL_SPECS = [
   },
   {
     name: "runtime_capture",
-    description: "A picture of the running game: the whole screen or one viewport, as an image. The whole screen includes the game's own dialogs and popups where they sit, also when a project opens them as windows of their own (subwindows not embedded). Needs the game running with a window. A capture asked for before the game's first frame is drawn waits for that frame, since the game announces itself before it and the viewport holds nothing it drew until then.",
+    description: "A picture of the running game: the whole screen, one region or node of it at full resolution, or one viewport, as an image. The whole screen includes the game's own dialogs and popups where they sit, also when a project opens them as windows of their own (subwindows not embedded). Needs the game running with a window. A capture asked for before the game's first frame is drawn waits for that frame, since the game announces itself before it and the viewport holds nothing it drew until then.",
     parameters: {
       projectPath: RUNNING_PROJECT_PATH,
       pid: RUNNING_PID,
@@ -31844,6 +31844,22 @@ var TOOL_SPECS = [
         minimum: 1,
         description: "Scale the image to this height. Given alone, the width keeps the picture's proportions."
       },
+      region: {
+        type: "object",
+        ops: ["screenshot"],
+        description: "screenshot: capture only this rectangle of the window, at the game's own pixels: x, y, width and height in window pixels, or the window rectangle runtime_inspect rect answers, passed as it came. A region partly outside the window is cut to it and the answer says clipped; one wholly outside is refused. The answer names the region captured in window pixels, and drawnAt when the project draws at its own size and stretches that to the window, since the picture then has the game's pixels rather than the window's."
+      },
+      nodePath: {
+        type: "string",
+        ops: ["screenshot"],
+        description: "screenshot: capture only where this node is drawn, as runtime_inspect rect answers it: a Control's rectangle, what a 3D node's geometry covers, or what a Sprite2D draws. A node with a position and no extent is refused; give region around it instead. Not with region."
+      },
+      zoom: {
+        type: "integer",
+        minimum: 1,
+        maximum: 16,
+        description: "Enlarge the picture this many times, each pixel made a square of pixels rather than blended with its neighbours, so a thin line or a corner can be read. Not with width or height. Default 1."
+      },
       outputPath: {
         type: "string",
         description: "Also save the picture as a PNG at this absolute path, for somebody to open later; the answer says where. Refused unless it ends in .png, its directory exists, it is outside the project, and no file is there already."
@@ -32161,6 +32177,25 @@ function captureDestinationRefusal(outputPath, projects) {
   }
   return null;
 }
+function captureDetail(payload) {
+  const parts = [];
+  const region = payload["region"];
+  if (region !== null && typeof region === "object") {
+    const named = region;
+    const at = (key) => String(Math.round(Number(named[key]) * 100) / 100);
+    parts.push(`of the window region at ${at("x")},${at("y")}, ${at("width")}x${at("height")} window pixels${payload["clipped"] === true ? ", clipped to the window" : ""}`);
+  }
+  const drawnAt = payload["drawnAt"];
+  if (drawnAt !== null && typeof drawnAt === "object") {
+    const drawn = drawnAt;
+    parts.push(`at the game's own pixels: it draws at ${String(drawn["width"])}x${String(drawn["height"])} and stretches that to its window`);
+  }
+  if (typeof payload["zoom"] === "number") {
+    parts.push(`enlarged ${payload["zoom"]} times`);
+  }
+  const note = typeof payload["note"] === "string" ? `. ${payload["note"]}` : "";
+  return parts.length === 0 ? note : `, ${parts.join(", ")}${note}`;
+}
 function patienceForFrames(frames, atLeast) {
   return Math.max(atLeast, frames / SLOWEST_FRAME_RATE * 1000 + atLeast);
 }
@@ -36978,7 +37013,7 @@ ${staleNote}`);
         content: [
           {
             type: "text",
-            text: `Screenshot captured: ${dimensions}${chosenAmongSeveral ? ` from pid ${own}, the game this server holds` : ""}${saveTo === null ? "" : `. Saved to ${saveTo}`}${staleNote === undefined ? "" : `
+            text: `Screenshot captured: ${dimensions}${chosenAmongSeveral ? ` from pid ${own}, the game this server holds` : ""}${captureDetail(payload)}${saveTo === null ? "" : `. Saved to ${saveTo}`}${staleNote === undefined ? "" : `
 
 ${staleNote}`}`
           },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdharness",
-  "version": "1.1.29",
+  "version": "1.1.30",
   "mcpName": "io.github.Aureliolo/gdharness",
   "description": "A harness for driving a Godot 4 project from an agent: editor addons, a runtime bridge into the running game, an MCP server in front of them, and a CLI that installs and diagnoses the Godot side.",
   "type": "module",