diff --git a/src/docs/assets/CustomTokens.mp4 b/src/docs/assets/CustomTokens.mp4 index a22be23..40353a9 100644 Binary files a/src/docs/assets/CustomTokens.mp4 and b/src/docs/assets/CustomTokens.mp4 differ diff --git a/src/docs/assets/FilteringTokens.mp4 b/src/docs/assets/FilteringTokens.mp4 new file mode 100644 index 0000000..e1c3203 Binary files /dev/null and b/src/docs/assets/FilteringTokens.mp4 differ diff --git a/src/docs/assets/GroupAndRemovingTokens.mp4 b/src/docs/assets/GroupAndRemovingTokens.mp4 new file mode 100644 index 0000000..c5c7f23 Binary files /dev/null and b/src/docs/assets/GroupAndRemovingTokens.mp4 differ diff --git a/src/docs/assets/TokenEditor.mp4 b/src/docs/assets/TokenEditor.mp4 new file mode 100644 index 0000000..2335a67 Binary files /dev/null and b/src/docs/assets/TokenEditor.mp4 differ diff --git a/src/docs/assets/index.js b/src/docs/assets/index.js index ce87b21..7c2bb32 100644 --- a/src/docs/assets/index.js +++ b/src/docs/assets/index.js @@ -13,7 +13,7 @@ import defaultTokens from "./DefaultTokens.mp4"; import workingWithTokens from "./WorkingWithTokens.mp4"; import deletingTokens from "./DeletingTokens.mp4"; import customTokens from "./CustomTokens.mp4"; -import customTokensAdvanced from "./CustomTokensAdvanced.jpg"; +import tokenEditor from "./TokenEditor.mp4"; import addPartyMember from "./AddPartyMember.mp4"; import changeNickname from "./ChangeNickname.mp4"; import sharingAudio from "./SharingAudio.mp4"; @@ -23,6 +23,8 @@ import usingTimer from "./UsingTimer.mp4"; import usingPointer from "./UsingPointer.mp4"; import mapEditor from "./MapEditor.mp4"; import filteringMaps from "./FilteringMaps.mp4"; +import groupAndRemovingTokens from "./GroupAndRemovingTokens.mp4"; +import filteringTokens from "./FilteringTokens.mp4"; export default { defaultMaps, @@ -40,7 +42,7 @@ export default { workingWithTokens, deletingTokens, customTokens, - customTokensAdvanced, + tokenEditor, addPartyMember, changeNickname, sharingAudio, @@ -50,4 +52,6 @@ export default { usingPointer, mapEditor, filteringMaps, + groupAndRemovingTokens, + filteringTokens, }; diff --git a/src/docs/howTo/usingTokens.md b/src/docs/howTo/usingTokens.md index 7a9c099..8f271eb 100644 --- a/src/docs/howTo/usingTokens.md +++ b/src/docs/howTo/usingTokens.md @@ -35,35 +35,48 @@ When you need more then the default tokens Owlbear Rodeo allows you to upload a ![Custom Tokens](customTokens) -To upload a custom token select the Edit Tokens Button at the bottom of the Token List. This will open the Edit Token Screen which allows you to upload and edit tokens. +To upload a custom token select the Edit Tokens Button at the bottom of the Token List. This will open the Edit Tokens Screen which allows you to upload and edit tokens. -To upload a new token either click the Add Token Button or drag an image into the Edit Token Screen. - -Once a token has been uploaded you can adjust the default size that is used when adding the token to the map by adjusting the Default Size Input. - -`Note: The size input for a non-square image represents the number of grid cells a token takes up on the horizontal axis. The number of cells in the vertical axis is determined by the aspect ratio of the uploaded image.` +To upload a new token either click the Add Token Button or drag an image into the Edit Tokens Screen. `Tip: Owlbear Rodeo has full transparency support for tokens. This means that players can only interact with visible parts of a token so feel free to upload creatures that might have large extended areas like wings.` -## Custom Tokens (Advanced) +## Editing Tokens -When uploading a custom token there are a couple of more advanced options that may come in handy. +![Token Editor](tokenEditor) -To get access to these settings select the desired token in the Edit Token Screen and click the Show More Button under the Default Size Input. +Once a custom token has been added there are a few settings you can edit if you wish. -![Custom Tokens Advanced](customTokensAdvanced) +To get access to these settings you can click the Edit Token button while a token is selected. -A brief summary of these settings is listed below. +The topmost view of the Edit Token Screen is a preview of what the token will look like on a map. -- Name: The name of the custom token. -- Category: - - 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. - - 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. -- Hide in Sidebar: When enabled the token will not show up in the Token List on the right side of the screen. +The first setting available is the Name input which allows you to change the name of the token that shows up in the Edit Tokens Screen. -## Removing a Custom Token +Next you can change the Category of your token, a summary of the options is below. -To remove a custom token open the Token Edit Screen, select the desired token and click the Remove Token Button on the token tile. +- 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. +- 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. -`Warning: This operation cannot be undone` +Lastly you can adjust the default size that is used when adding the token to the map by adjusting the Default Size Input. + +`Note: The size input for a non-square image represents the number of grid cells a token takes up on the horizontal axis. The number of cells in the vertical axis is determined by the aspect ratio of the uploaded image.` + +## Removing, Grouping and Hiding Tokens + +![Hiding, Removing and Grouping Tokens](groupAndRemovingTokens) + +To remove a custom token select the token in the Edit Tokens Screen then click the Remove Token button or use the Delete keyboard shortcut. + +Once a token has been added you can use the Hide/Show Token in Sidebar toggle to prevent it from taking up room in the Token List on the right side of your screen. + +Tokens can also be grouped to allow for better organisation. To do this with a token selected click on the Group Token button then select or create a new group. + +`Tip: You can select multiple tokens at the same time using the Select Multiple option or using the Ctrl/Cmd or Shift keyboard shortcuts` + +## Filtering Tokens + +![Filtering Tokens](filteringTokens) + +In the Edit Tokens Screen you can filter the tokens that are being shown by entering a term in the Search Bar. This will show tokens whose names or groups best match your search term.