Create or update a GM sticky note
dos2_put_noteDestructiveIdempotent
Creates or updates a Game Master-only sticky note on an Overview map, finding existing notes by key or title and backing up the note file before writing.
Instructions
Creates a Game Master sticky note on an Overview map, or changes an existing note. Players never see these notes. An existing note is found by key if given, otherwise by an equal title; if none matches, a new one is created on the map.
A note inside a scene hangs on an invisible marker item of the level, so new scene notes have to be placed in
the game; for one that already exists this tool changes title, text and folder and keeps its binding.
Writes Notes.lsf. The previous file is backed up first; undo with dos2_restore. Fails with an error while the game process is running unless allow_running=true.
Fails with an error if the map is not found or has to be specified. Returns created, the note's uuid, where it
sits and the backup id. Read notes with dos2_notes; remove one with dos2_delete_note.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"campaign": "<campaign>",
"title": "<title>",
"text": "<text>"
},
"name": "dos2_put_note"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | Horizontal position on the map in map pixels. Default 600 for a new note. | |
| y | No | Vertical position on the map in map pixels. Default 400 for a new note. | |
| key | No | Stable identifier of your choice. The note's UUID is derived from it, so the same key always addresses the same note even after its title changes. | |
| map | No | Overview map to put the note on: the map's title or UUID from dos2_campaign. May be omitted when the campaign has exactly one map or the note already exists. | |
| text | Yes | Note text. Line breaks are kept. | |
| title | Yes | Note title. Without key, an existing note with the same title is updated. | |
| folder | No | Folder the note is filed under in the notes overview. Omit to keep the current one. | |
| campaign | Yes | The campaign to work on: its name, its folder name, its UUID, or a unique part of any of them. dos2_status lists the campaigns. | |
| allow_running | No | Keep false. Set true only after the user has confirmed that the running game sits in the main menu: a write into a campaign that is loaded in the game gets lost or damages it. |