Skip to content

Commit 07cce26

Browse files
matthttamclaude
andcommitted
chore: update features.md with unit conversion, text visibility, and max markers docs
Document the unit conversion system (auto-convert, fixed mode, unit exclusions), update measurement panel references to toolbar, add missing global and per-map settings (max rendered markers, default text visibility), and fix stale scale range values (25-300% to 10-1000%). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent eb1e873 commit 07cce26

1 file changed

Lines changed: 41 additions & 10 deletions

File tree

docs/features.md

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ A comprehensive reference for every feature in the TTRPG Maps plugin.
3030
- [Calibration](#calibration)
3131
- [Point-to-Point Measurement](#point-to-point-measurement)
3232
- [Freehand Measurement](#freehand-measurement)
33+
- [Unit Conversion](#unit-conversion)
3334
- [Rounding](#rounding)
3435
- [Decimal Places](#decimal-places)
3536
- [Visibility Layers](#visibility-layers)
@@ -360,18 +361,21 @@ A **Restore Defaults** button resets all templates and folders to the built-in d
360361

361362
## Distance Measurement
362363

363-
The measurement panel is accessed via the **ruler icon** button in the top-right area of the map.
364+
The measurement toolbar is accessed via the **ruler icon** button in the top-right area of the map. It provides inline controls for calibration, measurement mode, and display settings.
364365

365366
<img width="341" height="287" alt="image" src="https://github.com/user-attachments/assets/0fcb9f41-1a94-4b8c-95b8-b0f133016fca" />
366367

367368
### Calibration
368369

369370
Calibration sets the distance scale for the map.
370371

371-
1. Click the **Calibrate** button in the measurement panel
372+
1. Click the **Calibrate** button in the measurement toolbar
372373
2. The cursor changes to a crosshair
373374
3. Click two points on the map (a dashed orange line is drawn between them)
374-
4. A modal asks how many units the line represents and what the unit label is (e.g. "100", "feet")
375+
4. A modal asks for:
376+
- The **distance** the line represents (e.g. "100")
377+
- The **measurement system** (Imperial, Metric, or Custom)
378+
- The **unit** (e.g. feet, meters) or a free-text label for custom systems
375379
5. Click **Save Scale**
376380

377381
The scale is saved per-map and persists across sessions. You must calibrate before measuring. A zero-length calibration line (clicking the same point twice) is rejected with a notice. Clicking **Cancel** or closing the calibration modal clears the drawn line and returns to calibration mode.
@@ -380,7 +384,7 @@ The scale is saved per-map and persists across sessions. You must calibrate befo
380384

381385
### Point-to-Point Measurement
382386

383-
1. Click the **Measure** button in the measurement panel
387+
1. Click the **Measure** button in the measurement toolbar
384388
2. Click a point on the map to start
385389
3. A **preview line** follows the cursor from the last point, showing the distance in real-time
386390
4. Click to commit the point and start the next segment
@@ -394,7 +398,7 @@ The live preview is useful for finding a specific distance from a point before c
394398

395399
### Freehand Measurement
396400

397-
1. Click the **Freehand** button in the measurement panel
401+
1. Click the **Freehand** button in the measurement toolbar
398402
2. Click and drag to draw a curve on the map
399403
3. Release to end a stroke (its distance label appears at the midpoint)
400404
4. Start additional strokes by clicking and dragging again
@@ -403,9 +407,21 @@ The live preview is useful for finding a specific distance from a point before c
403407

404408
![Measuring Free Hand](https://github.com/user-attachments/assets/abfbd0f7-a0aa-4a60-a444-36f87b373fa6)
405409

410+
### Unit Conversion
411+
412+
When the map is calibrated with Imperial or Metric units, the map settings modal (Measurement section) provides unit conversion controls:
413+
414+
| Setting | Description |
415+
| -------------------- | ------------------------------------------------------------------------------------------------- |
416+
| **Unit conversion** | How distances are converted for display: No conversion, Auto-convert, or Always show as... |
417+
| **Display unit** | The target unit when using "Always show as..." mode |
418+
| **Conversion units** | Toggle individual units on/off for auto-conversion (e.g. disable yards to skip straight to miles) |
419+
420+
In **auto-convert** mode, distances cascade through enabled units from largest to smallest (e.g. "1 mi 2,640 ft"). In **fixed** mode, all distances display in the chosen unit. Custom unit systems show distances with the free-text label and do not support conversion.
421+
406422
### Rounding
407423

408-
The measurement panel includes rounding controls:
424+
The measurement toolbar includes rounding controls (also available in the map settings modal):
409425

410426
| Mode | Behavior |
411427
| ----------- | ----------------------------------- |
@@ -534,7 +550,7 @@ The Markers, Text, Controls, and Layers sections are collapsible accordion group
534550
### Marker scale (per-map override)
535551

536552
- **Toggle** to enable a map-level size override (when off, uses the global default)
537-
- **Slider** to set the scale (25-300%)
553+
- **Slider** to set the scale (10-1000%)
538554
- Description shows the effective value and the global default for comparison
539555

540556
### Scale to zoom (per-map override)
@@ -543,6 +559,11 @@ The Markers, Text, Controls, and Layers sections are collapsible accordion group
543559
- **Screen-constant** - Markers stay the same screen size at all zoom levels
544560
- **Fixed to map** - Markers scale proportionally with zoom
545561

562+
### Max rendered markers (per-map override)
563+
564+
- **Toggle** to enable a per-map override (when off, uses the global default)
565+
- **Input** to set the maximum number of markers rendered at once
566+
546567
### Lock markers (per-map)
547568

548569
- **Lock markers** - Prevent moving markers by click-and-drag
@@ -555,6 +576,13 @@ Same controls as marker scale, but for label text.
555576

556577
- **Label font** - Inherit / Default, plus any installed fonts from the 12 available families. Sets the font for all marker labels on this map
557578

579+
### Text visibility (per-map override)
580+
581+
- **Inherit** - Use the global default
582+
- **Always visible** - Labels always shown
583+
- **Mouseover only** - Labels appear on hover
584+
- **Hidden** - Labels not shown
585+
558586
### Controls (per-map override)
559587

560588
Each control can be set to **Inherit** (use the global default), **Show**, or **Hide**. The description shows the current global default for reference. See [Controls section](#controls-section) under Global Settings for the full list.
@@ -574,14 +602,16 @@ Access via **Settings** > **TTRPG Maps**.
574602

575603
### Markers section
576604

577-
- **Default Marker Scale** - Size of markers on all maps (slider, 25-300%, default 100%)
605+
- **Default Marker Scale** - Size of markers on all maps (slider, 10-1000%, default 100%)
578606
- **Scale Markers to Zoom** - Screen-constant or Fixed to map
607+
- **Max Rendered Markers** - Maximum number of markers rendered at once (default 200). Reduces lag on maps with many markers. Only markers within the current viewport are added to the DOM
579608

580609
### Text section
581610

582-
- **Default Text Scale** - Size of marker labels on all maps (slider, 25-300%, default 100%)
611+
- **Default Text Scale** - Size of marker labels on all maps (slider, 10-1000%, default 100%)
583612
- **Scale Text to Zoom** - Screen-constant or Fixed to map
584613
- **Default Label Font** - Font family for marker labels. 12 fonts available; only those installed on the current system are shown
614+
- **Default Text Visibility** - Control whether marker labels are shown on all maps (Always visible / Mouseover only / Hidden)
585615

586616
### Navigation section
587617

@@ -751,7 +781,8 @@ Static map configuration: image path, dimensions, zoom settings. The plugin writ
751781
Mutable per-map state, including:
752782

753783
- All marker positions and properties
754-
- Distance scale calibration
784+
- Distance scale calibration (unit system, unit, and label)
785+
- Unit conversion settings (mode, display unit, excluded units)
755786
- Rounding mode, multiple, raw toggle, and decimal places
756787
- Per-map marker and text scale overrides
757788
- Layer definitions and zoom ranges

0 commit comments

Comments
 (0)