screenshot

Takes a picture of the game as it is now, interface included. Other windows on top of the game do not get in the way. source:

  • window (the default): Windows draws the game’s window at once, even while the game is not drawing frames. If the display is asleep or the session locked, the picture is all black (black); use game then.
  • game: the game takes its own screenshot, as its screenshot key does, a frame or more later. While another plugin’s free view flies (a photo camera’s), the game hides its interface and that plugin keeps its own panel out of this picture, so it is the frame alone.

Returns the picture as an image, with its width, height and file (in Screenshots\Eluvian; for game, the game’s own file is original). Pass image: false to get only the file and save tokens. width or height scales the picture, the other side kept to the frame’s aspect; both must be the frame’s aspect, or with crop true the middle of the frame at theirs is taken. The game draws at its window’s size, so a larger picture is no sharper: frame is the size it was drawn at. To draw the same frame elsewhere, camera’s projection is the one it was drawn with.

Read-only: it changes nothing in the game.

Arguments

Name Type Required What
source "window" | "game"   Who takes the picture. Default window.
image boolean   Include the picture itself in the answer. Default true.
quality number   With window: JPEG quality, 0.1 to 1. Default 0.8.
width integer   The picture’s width in pixels, 16 to 8192. Default: the frame’s.
height integer   The picture’s height in pixels, 16 to 8192. Default: the frame’s.
crop boolean   With both width and height of another aspect than the frame’s: take the middle of the frame at theirs. Default false: refused.

Call it as screenshot over MCP, or POST /api/tool/screenshot with the arguments as JSON.