Atlas48/grungnet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Mitchell McCaffrey 2021-08-12 17:19:42 +10:00
parent 8fff6ee395
commit 1616d8d2af
6 changed files with 65 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
src/docs/assets/UsingDrawing.mp4
View File

Binary file not shown.

BIN
src/docs/assets/WorkingWithTokens.mp4
View File

Binary file not shown.

86
src/docs/howTo/shortcuts.md
View File

@ -1,50 +1,58 @@
## General ## General
| Shortcut | Description | | Shortcut | Description |
| ---------------- | -------------- | | ---------------- | ----------------------- |
| W | Move Tool | | W | Move Tool |
| Space Bar (Hold) | Move Tool | | Space Bar (Hold) | Move Tool |
| F | Fog Tool | | F | Fog Tool |
| D | Drawing Tool | | D | Drawing Tool |
| M | Measure Tool | | M | Measure Tool |
| Q | Pointer Tool | | Q | Pointer Tool |
| N | Note Tool | | N | Note Tool |
| + | Zoom In | | + | Zoom In |
| - | Zoom Out | | - | Zoom Out |
| Shift + Zoom | Precision Zoom | | Shift + Zoom | Precision Zoom |
| Ctrl + Z | Undo |
| Ctrl + Shift + Z | Redo |
| Ctrl (Hold) | Disabled Grid Snapping |
| Alt + Drag | Duplicate Token or Note |
## Select Tool
| Shortcut | Description |
| -------- | --------------- |
| Ctrl + C | Copy Selection |
| Ctrl + V | Paste Selection |
## Fog Tool ## Fog Tool
| Shortcut | Description | | Shortcut | Description |
| ---------------- | ---------------------- | | --------- | ---------------------- |
| P | Fog Polygon | | P | Fog Polygon |
| Enter | Accept Fog Polygon | | Enter | Accept Fog Polygon |
| Escape | Cancel Fog Polygon | | Escape | Cancel Fog Polygon |
| Backspace | Undo Fog Polygon Point | | Backspace | Undo Fog Polygon Point |
| R | Fog Rectangle | | R | Fog Rectangle |
| B | Fog Brush | | B | Fog Brush |
| T | Toggle Fog | | T | Toggle Fog |
| E | Erase Fog | | E | Erase Fog |
| C | Cut Fog | | C | Cut Fog |
| L | Multilayer Toggle | | L | Multilayer Toggle |
| F | Fog Preview Toggle | | F | Fog Preview Toggle |
| Ctrl + Z | Undo |
| Ctrl + Shift + Z | Redo |
## Drawing Tool ## Drawing Tool
| Shortcut | Description | | Shortcut | Description |
| ---------------- | --------------- | | -------- | ----------------- |
| B | Brush | | B | Brush |
| P | Paint | | P | Paint |
| L | Line | | L | Line |
| R | Rectangle | | R | Rectangle |
| C | Circle | | C | Circle |
| T | Triangle | | T | Triangle |
| E | Erase | | E | Erase |
| O | Blending Toggle | | O | Blending Toggle |
| Ctrl + Z | Undo | | G | Shape Fill Toggle |
| Ctrl + Shift + Z | Redo |
## Select Map/Token Screen ## Select Map/Token Screen

27
src/docs/howTo/usingDrawing.md
View File

@ -6,17 +6,16 @@ The Drawing Tool allows you to draw on top of a map. To access the Drawing Tool
A summary of the Drawing Tool options are listed below. A summary of the Drawing Tool options are listed below.
| Option | Description | | Option | Description |
| --------- | --------------------------------------------------- | | ---------- | --------------------------------------------------- |
| Color | Change the color of the drawings | | Color | Change the color of the drawings |
| Brush | Draw free form lines | | Brush | Draw free form lines |
| Paint | Draw free form shapes | | Paint | Draw free form shapes |
| Line | Draw a single straight line | | Line | Draw a single straight line |
| Rectangle | Draw a rectangle | | Rectangle | Draw a rectangle |
| Circle | Draw a circle | | Circle | Draw a circle |
| Triangle | Draw a triangle | | Triangle | Draw a triangle |
| Erase | Click and drag to select drawings, release to erase | | Erase | Click and drag to select drawings, release to erase |
| Erase All | Erases all drawings on the map | | Erase All | Erases all drawings on the map |
| Blending | Enables/Disables alpha blending | | Blending | Enables/Disables alpha blending |
| Undo | Undo drawing or erasing | | Shape Fill | Enables/Disables shape fill |
| Redo | Redo drawing or erasing |

2
src/docs/howTo/usingFog.md
View File

@ -18,5 +18,3 @@ A summary of the Fog Tool options are listed below.
| Fog Cutting | Enables/Disables fog cutting | | Fog Cutting | Enables/Disables fog cutting |
| Layer Toggle | Changes between single layer and multilayer fog | | Layer Toggle | Changes between single layer and multilayer fog |
| Fog Preview | Enables/Disables a preview of the final fog shapes | | Fog Preview | Enables/Disables a preview of the final fog shapes |
| Undo | Undo a fog action |
| Redo | Redo a fog action |

8
src/docs/howTo/usingTokens.md
View File

@ -18,10 +18,11 @@ An overview of each setting is listed below:
- Label: allows you to write text that is then displayed at the bottom of the token. - Label: allows you to write text that is then displayed at the bottom of the token.
- Status: allows you to overlay a coloured ring on top of the token, these can be useful for showing status effects. - Status: allows you to overlay a coloured ring on top of the token, these can be useful for showing status effects.
- Size: controls the size of the token each notch represents how many grid cells the token takes up in the horizontal direction.
- Rotation: the direction the token faces, restrained to 15 degree increments.
- Hide / Show (GM Only): toggle the visibility of the token, useful for tracking invisible enemies. - Hide / Show (GM Only): toggle the visibility of the token, useful for tracking invisible enemies.
- Lock / Unlock (GM Only): when a token is locked it can't be moved until it is unlocked again. - Lock / Unlock (GM Only): when a token is locked it can't be moved until it is unlocked again.
- Category (GM Only): Change the token category. See Editing Tokens for more information about token categories.
Tokens can be resized by using the controls on the left and right of the token or rotated with the control on the top.
To delete a token drag in into the delete button that appears when dragging. To delete a token drag in into the delete button that appears when dragging.
@ -55,7 +56,8 @@ Next you can change the Category of your token, a summary of the options is belo
- Character - when selected this token will render on top of all other tokens. Used for things like players or enemies. - Character - when selected this token will render on top of all other tokens. Used for things like players or enemies.
- Prop - when selected this token will render beneath all other tokens. Used for things like items or markers. - Prop - when selected this token will render beneath all other tokens. Used for things like items or markers.
- Vehicle / Mount - when selected this token will render beneath characters but above props and when moved a character on top of this token will also be moved. - Mount - when selected this token will render beneath characters but above props and when moved a character on top of this token will also be moved.
- Attachment - when selected this token will attach to any character underneath it. Used for auras or markers.
Lastly you can adjust the default size that is used when adding the token to the map by adjusting the Default Size Input. Lastly you can adjust the default size that is used when adding the token to the map by adjusting the Default Size Input.