retroarch_show_message
Show an on-screen notification in RetroArch to provide user feedback or debug information during script execution.
Instructions
Display a notification message overlaid on the RetroArch window. Useful for debugging or telling the user something during a long-running script.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | Yes | Message text. Spaces are kept; line breaks are not. |
Implementation Reference
- src/tools.ts:122-132 (schema)Tool schema definition for retroarch_show_message, defining the 'message' string input parameter.
{ name: "retroarch_show_message", description: "Display a notification message overlaid on the RetroArch window. Useful for debugging or telling the user something during a long-running script.", inputSchema: { type: "object", required: ["message"], properties: { message: { type: "string", description: "Message text. Spaces are kept; line breaks are not." }, }, }, }, - src/tools.ts:231-234 (handler)Handler that calls ra.showMessage() with the message argument and returns a confirmation string.
case "retroarch_show_message": { await ra.showMessage(p.message as string); return ok(`Showed: ${p.message}`); } - src/retroarch.ts:195-195 (helper)Helper method in RetroArchClient that sends the SHOW_MSG command with the message text via UDP to RetroArch's Network Control Interface.
async showMessage(msg: string): Promise<void> { await this.send(`SHOW_MSG ${msg}`); }