Skip to content

Commit 1f06361

Browse files
authored
Fix typos and enhance clarity in readme.md
Corrected typos and improved clarity in the readme.
1 parent db78ee5 commit 1f06361

1 file changed

Lines changed: 19 additions & 22 deletions

File tree

PinTool/readme.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,39 @@
11
# PinTool
22

3-
PinTool is a GM-only Roll20 API script for creating, inspecting, converting, and managing **map pins** at scale. It can convert older token-based note workflows into Roll20’s newer map pin system, allowing structured handouts and pins to stay in sync.
3+
PinTool is a GM-only Roll20 API script for creating, inspecting, converting, and managing **map pins** at scale. It can convert older token-based note workflows with Roll20’s newer map pin system, allowing structured handouts and pins to stay in sync.
44

55
---
66

77
## Core Capabilities
88

9-
- Bulk modification of map pin properties.
10-
- Precise targeting of selected pins, all pins on a page, or explicit pin IDs.
11-
- Conversion of legacy token notes into structured handouts.
12-
- Automatic placement of map pins from handout headers (player and GM).
13-
- Optional chat display of images referenced in notes.
14-
- **Pin Library (`--library`)** lets GMs Keep a library of pin styles for quick application.
9+
- Bulk modification of map pin properties
10+
- Precise targeting of selected pins, all pins on a page, or explicit pin IDs
11+
- Conversion of legacy note tokens into structured handouts
12+
- Automatic placement of map pins from handout headers (player and GM)
13+
- Optional chat display of images referenced in notes
1514

16-
**Base Command:** `!pintool` opens a control panel for commonly used editing controls. Add primary commands afterward to access specific functions.
15+
**Base Command:** `!pintool` opens a control panel for commonly used editing controls. Add priaru commands afterward to access specific functions.
16+
17+
`!pintool --help` creates a handout with full documentation
1718

18-
`!pintool --help` creates a handout with full documentation.
1919

2020
---
2121

2222
## Primary Commands
2323

24-
- `--set` — Update one or more properties across many pins at once.
25-
- `--convert` — Extract data from tokens representing the same character and build or update a handout.
26-
- `--place` — Create or replace pins based on handout headers, linking directly to those sections.
27-
- `--purge` — Remove related tokens or pins in bulk.
28-
- `--library` — Open the Pin Library to copy preset pin styles to selected pins.
29-
- `--transform` — Apply transformations to pins, e.g., auto-generating icon text from titles.
30-
- `--help` — Display the full PinTool help panel.
24+
- `--set` updates one or more properties across many pins at once.
25+
- `--convert` extracts data from tokens representing the same character and builds or updates a handout.
26+
- `--place` scans a handout for headers and creates or replaces pins linked directly to those sections.
27+
- `--purge` removes related tokens or pins in bulk.
28+
- `--help` creates full documentation handout.
3129

3230
---
3331

3432
## Highlights
3533

36-
- Pins created via `--place` link directly to specific headers in Notes or GM Notes.
37-
- Existing pins are replaced in-place, preserving their positions.
38-
- Conversion supports header levels, blockquotes, code blocks, and inline image links.
39-
- Visibility, scale, links, and sync state can all be controlled programmatically.
40-
- Pin customization modes allow you to quickly switch the pin image between icons, text icons, or images.
34+
- Pins created via `--place` link directly to specific headers in Notes or GM Notes.
35+
- Existing pins are replaced in-place, preserving their positions.
36+
- Conversion supports header levels, blockquotes, code blocks, and inline image links.
37+
- Visibility, scale, links, and sync state can all be controlled programmatically.
4138

42-
Designed for GMs who want more automated control over pin placement, appearance, and management.
39+
Designed for GMs who want more automated control over pin placement and management.

0 commit comments

Comments
 (0)