127 lines
5.6 KiB
Markdown
127 lines
5.6 KiB
Markdown
# Notes and markdown
|
|
|
|
Notes are where a campaign is written down: sessions, NPCs, the lore of a city, the ritual the party
|
|
found in a dungeon. They are plain markdown, so anything you already know from README files and
|
|
Obsidian works as it is.
|
|
|
|
## Opening and editing a note
|
|
|
|
Clicking a note in the sidebar opens it in the note column, where you can have several open side by
|
|
side. A note opens in **display mode**, showing its formatted markdown. Press **Cmd+E** (**Ctrl+E**)
|
|
to edit its source, and **Cmd+S** (**Ctrl+S**) to save it; a dot in the note's title bar reminds you
|
|
that there is something to save. The cross in the title bar closes the note — it does not delete it.
|
|
|
|
## Folders
|
|
|
|
The sidebar's sections hold notes in folders, and folders hold folders, so a campaign can be nested as
|
|
deep as it needs. Right-clicking gives the commands:
|
|
|
|
| Right-click on… | You get |
|
|
| --- | --- |
|
|
| a note | Open, Rename, a colour, the folder to move it to, Delete |
|
|
| a folder | New note in it, Rename, a colour, Delete folder |
|
|
|
|
Dragging a note onto a folder moves it there, and dropping it at the bottom of the list takes it back
|
|
to the root. Colouring a note or a folder tints its row in the sidebar, which is a quick way to mark
|
|
what matters.
|
|
|
|
Deleting a folder does not delete your notes: the notes it held move up to its parent folder, its
|
|
sub-folders move up with them, and only the empty folders go away.
|
|
|
|
## Markdown
|
|
|
|
Headings, **bold**, *italic*, lists, quotes, tables, code and links all work:
|
|
|
|
```markdown
|
|
## The Wreck of the Salt Gull
|
|
|
|
- [ ] Burn the manifest
|
|
- [x] Ask the harbourmaster
|
|
|
|
| Cargo | Worth |
|
|
| --- | --- |
|
|
| Salted fish | 20 gp |
|
|
```
|
|
|
|
Clicking a heading **folds** the section under it — handy when you are reading a long note on a
|
|
projector and only want the part you are talking about. Sub-headings fold with their parent.
|
|
|
|
## Linking to characters, items and other entries
|
|
|
|
A note can point at the rest of the campaign. While editing, type `[[` and the editor offers the
|
|
campaign's notes, characters, items and maps; choose one and it writes a link like `[[Mira]]` (or
|
|
`[[Rope of Climbing]]`). The list narrows as you type and the arrow keys, Enter or Tab, and Escape
|
|
work the same way as in the widget menu.
|
|
|
|
In display mode the link shows the entry's name. Resting the pointer on a link to a **character** or
|
|
an **item** opens a small preview — the portrait or icon, the class and level, armour class, hit
|
|
points and speed for a character; the rarity, weight and description for an item — and clicking it
|
|
opens the full sheet in its window. A link to a note opens that note beside the current one, and a
|
|
link to a map anchors the map where the notes are.
|
|
|
|
Links are written by name, so renaming an entry leaves the old link pointing at nothing: it is shown
|
|
dimmed and no longer opens anything. Write `[[` again to link the entry under its new name.
|
|
|
|
### Embedding a character or an item
|
|
|
|
Put a **!** in front of the link — `![[Mira]]` or `![[Rope of Climbing]]` — and the note shows the
|
|
entry itself instead of a link. A character arrives as a small sheet: portrait, class, level and
|
|
species, armour class, hit points, speed and ability scores, with the traits, proficiencies and
|
|
spells below. An item arrives with its icon, category, rarity, weight, properties and description.
|
|
|
|
The embedded card is part of the note in display mode, and its **Open** button opens the full sheet,
|
|
the same window the sidebar opens. Only characters and items can be embedded; a note or a map written
|
|
with the **!** stays as plain text. Name resolution works exactly like a normal link, so an embed of
|
|
an entry that has been renamed is shown dimmed.
|
|
|
|
## Rolling dice in a note
|
|
|
|
A note can hold a dice widget: a button that rolls and shows the result right there, so the book of a
|
|
spell does not need a second app next to it.
|
|
|
|
Write `@roll` and the expression in square brackets to drop it in the middle of a sentence:
|
|
|
|
```markdown
|
|
The goblin attacks with @roll[1d20+4].
|
|
```
|
|
|
|
The editor offers the widgets for you: while editing, typing `@` opens a list of the widgets a note
|
|
can use, and choosing one writes its syntax — the inline `@roll[...]` or the block below — with the
|
|
cursor where the expression goes. Arrow keys move through the list, Enter or Tab takes the widget,
|
|
and Escape closes it.
|
|
|
|
Or in a block of its own, between `@roll` and `@end`, when the roll is worth showing on its own line:
|
|
|
|
```markdown
|
|
@roll
|
|
8d6
|
|
@end
|
|
```
|
|
|
|
Either way the widget shows the expression as a button: press it and the dice land, with every die and
|
|
the total spelled out. Press it again to roll again. Only the expression itself goes between `@roll`
|
|
and `@end` — write the note about the roll next to the widget, not inside it.
|
|
|
|
When the note reaches a linked [Foundry world](/docs/foundry), its dice widgets are buttons on the
|
|
journal page too: pressing one rolls the expression with Foundry's dice and posts the result to chat,
|
|
where the whole table sees it.
|
|
|
|
The expression understands:
|
|
|
|
| Written | Meaning |
|
|
| --- | --- |
|
|
| `d20`, `1d20` | one die; the number in front is how many, so `4d6` |
|
|
| `d20adv`, `d20dis` | roll twice and keep the higher / the lower |
|
|
| `4d6kh1`, `4d6kl1` | keep the highest / lowest one of four (any number after `kh` / `kl`) |
|
|
| `+`, `-`, `*`, `/` | arithmetic; `2d6+3`, `1d8/2` |
|
|
| `( )` | grouping, as in `(1d8+4)*2` |
|
|
| `-3` | a negative number |
|
|
|
|
Division rounds down, the way damage does. Spaces between the parts of an expression do not matter, but
|
|
a modifier belongs right after the dice: write `4d6kh1`, not `4d6 kh 1`.
|
|
|
|
## Next
|
|
|
|
- Put the people and things of your notes on [sheets](/docs/characters-and-items).
|
|
- Pin a note onto a spot on a [map](/docs/maps).
|