Pintool [ Demonstration Video ] The full documentation is shown below for completeness, but you don't need to read it all to ba bel to use the basic features of the script. Watch the video for a quick and intuitive introduction. NOTE: This is a brand new script for a feature that is in public beta. It has destructive potential if not used carefully. Work with a copy of your page until you are comfortable with it. PinTool provides bulk creation, inspection, and modification of map pins It also provides commands for conversion of old-style note tokens to new map pins . Modify pin properties in bulk Target selected pins, all pins on a page, or explicit pin IDs Convert map tokens into structured handouts Place Map Pins onto map automatically from specified handout and header level Display images directly into chat Base Command: !pintool Primary Commands --set — Modify properties on one or more pins (selected pins, or all pins on a page). --convert — Convert map tokens into a handout. Can optionall replace existing token pins upon creation --place — Places pins on map based on specified handout and header level. --purge — Removes all tokens on the map similar to the selected token, or pins similar to the selected pin. --help — Open this help handout. Set Command Format: !pintool --set property|value [property|value ...] [filter|target] All supplied properties apply to every pin matched by the filter. Filter Options filter|selected — (default) Selected pins filter|all — All pins on the current page filter|ID ID ID — Space-separated list of pin IDs Settable Properties Values are case-sensitive unless otherwise noted. Values indicated by "" just mean no value. Do not actually type quotes. See examples at end of Help document. Position x — Horizontal position on page, in pixels, number y — Vertical position on page, in pixels, number Text & Content title — The title text displayed on the pin, string notes — Notes content associated with the pin, string tooltipImage — Roll20 image identifier for the tooltip image displayed on the pin, URL Links link — The ID of a handout or other object this pin links to., string (id) linkType — The type of object linked, "handout" or "" subLink| — A sub-link identifier, typically a header in the handout, used for linking to specific sections , string subLinkType| — The type of sub-link (which section of handout: notes or gmnotes) — ""headerPlayer", "headerGM, "" Visibility visibleTo — Controls overall visibility — "all" or "" (empty string) tooltipVisibleTo — Controls who can see the tooltip — "all" or "" (empty string) nameplateVisibleTo — Controls who can see the nameplate — "all" or "" (empty string) imageVisibleTo — Controls who can see the image — "all" or "" (empty string) notesVisibleTo| — Controls who can see the notes — "all" or "" (empty string) gmNotesVisibleTo — Controls who can see GM notes — "all" or "" (empty string) Notes Behavior autoNotesType — Controls whether blockquote style in handout determines player visibility — "blockquote" or "" (empty string) Appearance scale — Range: 0.25 – 2.0 State imageDesynced|false — Whether the pin's image is desynced from its linked object. Setting any desynced property sets all three to the same value. — true, false notesDesynced|false — Whether the pin's notes are desynced from its linked object. Setting any desynced property sets all three to the same value. — true, false gmNotesDesynced|false — Whether the pin's GM notes are desynced from its linked object. Setting any desynced property sets all three to the same value. — true, false Convert Command The convert command builds or updates a handout by extracting data from map tokens. Format: !pintool --convert key|value key|value ... A single token must be selected. All tokens on the same page that represent the same character are processed. This script requires that all note pins must represent a common character. Required Arguments name|h1–h5 Header level used for each token’s name. title|string Name of the handout to create or update. May contain spaces. Optional Arguments gmnotes|format tooltip|format bar1_value|format bar1_max|format bar2_value|format bar2_max|format bar3_value|format bar3_max|format Format may be: h1–h6 blockquote code normal Behavior Flags supernotesGMText|true Wraps GM Notes text before a visible separator line (-----) in a blockquote. If there is no ----- and this setting is true, than the contents of that section will be set to blockquote. The purpose of this is to make all notes that are not specified as gmnotes, player-visible. If you do not use this feature in supernotes, you can ignore this setting. imagelinks|true Adds clickable [Image] links after images that send them to chat. This is a feature in progress, since inline images in a pin may yet eventually be supported. Convert Rules Arguments are not prefixed with --, only the base commands (see beginning of help document for a list of these). Argument order is preserved and controls output order. title| values may contain spaces. Images in notes are converted to inline images links. Only tokens on the same page representing the same character are included in the handout. Place Command The place command creates or replaces map pins on the current page based on headers found in an existing handout. Format: !pintool --place name|h1–h4 handout|Exact Handout Name Required Arguments name|h1–h4 Header level to scan for in the handout. Each matching header becomes a pin. handout|string Exact, case-sensitive name of an existing handout. Must be unique. Do not use quotes. Behavior Both Notes and GM Notes of the handout are scanned. Headers found in Notes create pins with subLinkType|headerPlayer. Headers found in GM Notes create pins with subLinkType|headerGM. If a pin already exists for a given header on the page, it is replaced and retains its existing position. New pins are placed left-to-right across the top grid row of the page, continuing onto additional rows as needed. Pins are created using the same default properties as --convert replace|true. Notes Handout names may contain spaces. If no matching headers are found, no pins are created. If more than one handout matches the given name, the command aborts. Purge Command The purge command removes all tokens on the map similar to the selected token (i.e. that represent the same character), or pins similar to the selected pin (i.e. that are linked to the same handout) . Format: !pintool --purge tokens Required Arguments tokens or pins Example Macros !pintool --set scale|1 — Sets selected pin to size Medium !pintool --set scale|1 filter|all — Sets all pins on page to size Medium !pintool --set scale|1 filter|-123456789abcd - 123456789abce - 123456789abcf — Sets 3 specific pins on page to size Medium !pintool --set title|Camp notesVisibleTo|all — Sets title on selected custom pin and makes notes visible to all !pintool --set autoNotesType| — changes blockquote behavior on pins. !pintool --convert name|h2 title|Goblin Notes gmnotes|blockquote — Good all-purpose conversion command General Rules All commands are GM-only. Invalid values abort the entire command. Converting, Placing, or Purging pins can take considerable time, up to 1 second per pin. This is because of the need for the Roll20 engine (not the script) to update the handout to keep all pink links in sync. This is unavoidable
