> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dietrich-development.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Persistent collaborative pinboards for RedM with notes, photos, drawings, threads and individual card reservations

Persistent pinboards for RedM, opened at configured world locations. Players arrange notes, photos, drawings and coloured threads together, with board content saved in MySQL.

With DD Pinboard, lawmen build a case board, a gang plans a job, and a saloon keeps a public notice board. Walk up and open the board to place cards, write notes and connect clues. Several players can work at once: a card in use is reserved for its editor while the other cards stay available.

<Info>
  This guide covers version 1.3.0. The board opens as an interactive interface at a configured location. Saved cards and threads survive relogs and server restarts; cursor positions, card reservations and undo history are session state.
</Info>

## Features

* Persistent boards at configured world locations, with notes, rich text, URL photos, pins and freehand drawings saved in MySQL
* Several players edit together; cards in use are reserved individually, with a presence bar and optional live cursors
* Place cards by mouse, select groups, move, resize and layer them; pan and zoom independently of other players
* Coloured threads connect any card to another card or a pin and follow their endpoints when cards move or rotate
* Pencil and stroke eraser, three stroke widths, and transparent, paper, lined, grid or dotted drawing backgrounds
* Five board surfaces: cork, parchment, wood, slate and linen; optional fixed backgrounds and framed boards with bounded dimensions
* Undo up to 100 steps of your own edits within a session, subject to card permissions and conflicting edits; history resets on close or resync
* Replace a photo from its URL while keeping its position, size, rotation, layer and threads; built-in controls help
* A prepared investigation board, configurable showcase presets, admin commands and server exports to read, clear, seed or inspect board viewers
* VORP and RSG support, native RedM prompts, English and German translations; oxmysql is the only hard resource dependency

## How it works

<Steps>
  <Step title="Open a board">
    Walk to a configured location and press the native interaction prompt (`E` by default). Everyone may read; the location's edit permission determines who may change its content.
  </Step>

  <Step title="Work together">
    Players with edit rights can work simultaneously. A card being moved, resized, rotated, typed in or drawn on is reserved for that player and marked in their colour. Other cards remain available.
  </Step>

  <Step title="Save changes">
    Changes are sent after the configured autosave delay (two seconds after the last edit by default). The server validates and saves accepted changes, then forwards them to the other viewers. Closing the board sends pending edits too.
  </Step>

  <Step title="Release a card">
    Reservations are released when work finishes, the player closes the board or disconnects, or the reservation times out (30 seconds of inactivity by default). Other players never need to take over the whole board.
  </Step>
</Steps>

## Controls

Use the toolbar's **?** button for the in-game controls guide, available in English and German.

| Action                         | Control                                                                                  |
| ------------------------------ | ---------------------------------------------------------------------------------------- |
| Place a note, text card or pin | Choose its toolbar tool, then click on the board; Esc cancels placement                  |
| Add a photo                    | Choose Add image, enter its URL, then place it                                           |
| Select                         | Left-click a card or thread                                                              |
| Select several cards           | Shift-click cards or drag a selection rectangle on empty board                           |
| Move cards                     | Drag a selected card to move the selection                                               |
| Resize                         | Drag the selected card's resize handle; photos, pins and drawings keep their proportions |
| Rotate                         | Drag the rotation handle on a selected card; pins have no rotation handle                |
| Change stacking                | Use the front/back buttons below a selected card                                         |
| Delete                         | Use the delete button or Delete / Backspace while not typing                             |
| Pan                            | Hold the right mouse button and drag, including over cards                               |
| Zoom                           | Scroll the mouse wheel; zoom follows the pointer                                         |
| Undo                           | Use Undo or Ctrl+Z                                                                       |
| Close or cancel                | Esc cancels the current tool or dialog first; with none active it closes the board       |

Pan and zoom are independent for each viewer. A saved board viewport supplies the starting view when someone next opens it.

### Notes and text

Click a note or text card to select it and place the caret. The formatting toolbar provides five bundled fonts, font sizes, bold, italic, underline, strikethrough, lists and text colours. New notes grow with their text; resizing them manually fixes their dimensions and wraps text inside the card.

### Photos

Photo URLs load on each player's machine. Use a direct image URL reachable by your players; the optional server allow-list restricts permitted hosts. Select a photo and choose **Replace image** to change its URL without changing its position, dimensions, rotation, layer or connected threads.

### Threads

Drag the gold anchor on a selected card onto another card to connect them. Drop it on empty board to create a pin there. Connect mode also lets you string threads by clicking cards or empty board. Threads can attach to any card, follow moves and rotations, and use the selected colour.

Select a thread or its pin head, then use its delete button or Delete / Backspace to remove it. The right mouse button pans.

### Drawing

Select the pencil tool and draw directly on the board. The first stroke creates a drawing, or joins an existing drawing under it. Choose pencil or stroke eraser, one of three widths, and a transparent, paper, lined, grid or dotted background. The eraser removes whole strokes; removing the last stroke removes the drawing. Resizing a drawing scales its strokes too.

### Undo

Undo keeps up to 100 steps of your own edits in the current session, including deleted cards and threads. It respects permissions and card reservations. Other players' changes remove conflicting undo steps. Closing the board or receiving a full resync clears the history; it is not a database backup or a way to reverse an admin clear or seed.

### Surfaces and board size

Players can choose cork, parchment, wood, slate or linen unless the location fixes its background. A location can also define a bounded sheet in a wooden frame. Cards and the view stay within its configured limits.

### Presence and privacy

The presence bar identifies viewers by colour. Live cursors are optional. With `Config.anonymizeCollaborators`, numbered visitor names replace character names in the presence bar, cursor labels and card reservations.

## Next steps

<Columns cols={2}>
  <Card title="Setup" icon="screwdriver-wrench" href="/scripts/pinboard/setup">
    Installation, configuration, permissions, presets and troubleshooting.
  </Card>

  <Card title="Developers" icon="code" href="/scripts/pinboard/developers">
    Server exports, persistence and integration examples.
  </Card>
</Columns>
