ravenous_roll20/docs/macros.md

79 lines
2.2 KiB
Markdown

# Ravenous Roll20 macro memo
These actions can be pasted into **Collections → Macros → Action**. Install the
corresponding scripts from `roll20_mod/` first. Enable **Show as Token Action**
when the macro operates on a selected token.
## Player craft import
The player selects a token linked to a character they control. The JSON must be
stored in the GM Notes of a handout shared with or controlled by that player.
**Name:** `Ravenous — Importer un objet`
```text
!ravenous-import-craft --handout ?{ID du handout d'artisanat}
```
Players cannot import into another player's character or read an unshared
handout through the script. A GM can use the same macro with any character and
handout.
## Player character backup and replacement
Select one token linked to a character the player controls. Export creates a
handout controlled by that player, with JSON in its visible Notes.
**Name:** `Ravenous — Sauvegarder le personnage`
```text
!ravenous-export
```
To restore that JSON into the same Roll20 character while preserving its ID,
linked tokens, ownership, avatar, and GM Notes:
**Name:** `Ravenous — Restaurer le personnage`
```text
!ravenous-import --replace --handout ?{ID du handout personnage}
```
Replacement deletes the destination's existing sheet attributes and abilities.
The player must control both the selected character and the source handout.
## GM character import
Character creation remains GM-only. Put the export JSON in a private handout's
GM Notes.
**Name:** `Ravenous — Importer un personnage`
```text
!ravenous-import --handout ?{ID du handout personnage}
```
## GM character export
Select one token linked to the character to export.
**Name:** `Ravenous — Exporter le personnage`
```text
!ravenous-export
```
## GM craft import by character ID
Useful when the destination character has no token selected.
**Name:** `Ravenous — Import artisanat par ID`
```text
!ravenous-import-craft --id ?{ID du personnage} --handout ?{ID du handout d'artisanat}
```
Roll20 IDs are the final identifier in the character or handout URL. Handout
imports are preferred over pasting JSON into a query because JSON punctuation
can interfere with Roll20's query syntax.