Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Journal"

From Roll20 Wiki

Jump to: navigation, search
(Avatar)
(I'm doing a rework of this page to have more emphasis on the main components (characters and handouts) and less about the folder management structure.)
Line 1: Line 1:
[[File:Journal2.0.jpg|right|frame|border]]
+
[[File:Journal2.0.jpg|right|frame|border|The Journal Tab on the Sidebar]]
The Journal is the third tab of the Sidebar. This feature allows GMs to create '''Characters''', '''Handouts''', and organizational '''Folders''' for their games. The Journal serves as a central repository for game information. These items can be made private or shared with other players. Shared items can be viewed by players with access from this same tab.   
+
The Journal is the third tab of the Sidebar. This feature allows GMs to create '''Characters''', '''Handouts'''. The Journal serves as a central repository for game information. These items can be made private or shared with other players. Shared items can be viewed by players with access from this same tab.   
  
Add a '''[[Journal#Characters|Character]]''', '''[[Journal#Handouts|Handout]]''', or '''[[Journal#Folders|Folder]]''' to the Journal by clicking the button labeled '''+ Add''' within the Journal tab. Select an item from the dropdown list to add it to the game Journal.
+
'''03-12-17 Admin Note: This Page is Currently being updated for better legibility'''
[[File:Journal1.0.jpg|thumb|Select an option to add an item to the Journal|right|400px]]
+
  
== Folders ==
+
= Characters =
[[File:Journal3.1.jpg|frame|right]]
+
Folders can be used to help organize '''Characters''' and '''Handouts''' within the Journal. Folders and the complete folder structure can be seen by all players who join the game as well as the GM, assuming there is at least one item in each folder for which players have available to their journals. If a folder contains items that are only available to the GM's journal, the players will not see that folder.
+
 
+
=== Adding Folders ===
+
Add a new folder using '''+ Add''' button as described at the top of this page, making sure to select '''Folder''' from the dropdown menu. Follow the instructions on the prompt to name the folder and hit '''OK''' to add the folder to the Journal.
+
 
+
=== Folder Options ===
+
Right click the folder to reveal a list of options. Add '''Subfolders''', '''Characters''', and '''Handouts''' using this method to automatically nest 4 additional folders under the right-clicked folder. Items can also be moved in and out of folders manually using the mouse, see '''[[Journal#Reorganizing_Journal_Items|Reorganizing Journal Items]]''' for more detail.
+
{{mbox | text = '''Note:''' Due to the limited space on the Sidebar, only 3 additional folders can be added. '''Characters''' and '''Handouts''' can only be added to the most deeply nested folder by using the right-click options menu to add items.}}
+
 
+
 
+
You can sort alphabetically, rename or delete the folder from this menu as well. Deleting folders will '''not''' delete the items inside. All items in the deleted folder will be moved to the root folder. Using the '''Delete Folder''' option requires your approval upon use, confirm when prompted to initiate your action.
+
 
+
== Characters ==
+
  
 
Characters are intended to represent either PCs or important NPCs in your Game. Each Character has a name, an avatar which represents the Character, Attributes, Abilities and a Bio and a GM Notes section.
 
Characters are intended to represent either PCs or important NPCs in your Game. Each Character has a name, an avatar which represents the Character, Attributes, Abilities and a Bio and a GM Notes section.
  
=== Adding Characters ===
+
== Adding Characters ==
 
Add a new Character using '''+ Add''' button as described at the top of this page, making sure to select '''Character''' from the dropdown menu or by right-clicking a folder and selecting '''Add Character''' from the '''[[Journal#Folder_Options|Folder Options]]''' menu. The system randomly generates a placeholder name and creates the Character.
 
Add a new Character using '''+ Add''' button as described at the top of this page, making sure to select '''Character''' from the dropdown menu or by right-clicking a folder and selecting '''Add Character''' from the '''[[Journal#Folder_Options|Folder Options]]''' menu. The system randomly generates a placeholder name and creates the Character.
  
Line 30: Line 15:
  
 
[[File:Journal7.0.png|right|frame]]
 
[[File:Journal7.0.png|right|frame]]
=== Character Options ===
+
== Character Options ==
 
Right-click the Character name to reveal a list of options, including '''Show to Players''', '''Archive Item''', or '''Delete Item'''. Your approval is needed upon use of the '''Show to Players''' and '''Delete Item''' options - confirm when prompted to initiate your action.
 
Right-click the Character name to reveal a list of options, including '''Show to Players''', '''Archive Item''', or '''Delete Item'''. Your approval is needed upon use of the '''Show to Players''' and '''Delete Item''' options - confirm when prompted to initiate your action.
  
=== Character Window ===
+
== Character Window ==
 
Click the Character name from the Sidebar to open the info window. To the left of the Character name is a '''popout''' button. Click to pop your info window out into a new browser window. Visit the '''[[My_Settings#Use_Window_Popouts_for_Characters|My Settings]]''' page to set popout windows to automatic. Click the '''Show to Players''' button to reveal the Character to all players or click the "Edit" button to customize.
 
Click the Character name from the Sidebar to open the info window. To the left of the Character name is a '''popout''' button. Click to pop your info window out into a new browser window. Visit the '''[[My_Settings#Use_Window_Popouts_for_Characters|My Settings]]''' page to set popout windows to automatic. Click the '''Show to Players''' button to reveal the Character to all players or click the "Edit" button to customize.
 
[[File:Journal6.0.jpg|left|frame]]
 
[[File:Journal6.0.jpg|left|frame]]
 
<div style='clear: both; height: 10px;'></div><br><br>
 
<div style='clear: both; height: 10px;'></div><br><br>
  
==== Bio & Info Tab ====
+
=== Bio & Info Tab ===
 
Information added to the Character window using the '''Edit''' button will be displayed here. Click the '''Edit''' button to further customize Character details.
 
Information added to the Character window using the '''Edit''' button will be displayed here. Click the '''Edit''' button to further customize Character details.
  
Line 46: Line 31:
 
File:Example.jpg|Caption2
 
File:Example.jpg|Caption2
 
</gallery>
 
</gallery>
===== Avatar =====
+
==== Avatar ====
 
You can upload an Avatar to represent this Character in the Journal listing as well as the Chat interface. Just drag and drop an image from your computer, or drag and drop an image from the [[Art_Library|Art Library]] search results into the box.
 
You can upload an Avatar to represent this Character in the Journal listing as well as the Chat interface. Just drag and drop an image from your computer, or drag and drop an image from the [[Art_Library|Art Library]] search results into the box.
  
===== Name =====
+
==== Name ====
 
Change the randomly generated placeholder name to a Character name of your choice.
 
Change the randomly generated placeholder name to a Character name of your choice.
  
===== In Player's Journals =====
+
==== In Player's Journals =====
 
By default, only the GM sees the Character. To allow other Players to see the Character in their Journal tab, add their names to the &quot;In Players Journals&quot; field. You can also choose &quot;All Players&quot; to allow everyone to view the Character.
 
By default, only the GM sees the Character. To allow other Players to see the Character in their Journal tab, add their names to the &quot;In Players Journals&quot; field. You can also choose &quot;All Players&quot; to allow everyone to view the Character.
  
 
Players who can view the Character will see the name, avatar, and any text typed on the Character's Bio & Info tab only.
 
Players who can view the Character will see the name, avatar, and any text typed on the Character's Bio & Info tab only.
  
===== Can Be Edited & Controlled By =====
+
===== Can Be Edited & Controlled By ====
 
The Controlled By field allows you to give Players in your game the ability to &quot;speak&quot; as that Character in the Text Chat. They are also able to edit the Character's information if they control it. In addition, if you use the Represents Character feature of the Tokens Settings, players who have permission to control this Character will also be able to control any tokens that represent this character. You can also choose &quot;All Players&quot; to allow everyone to control or edit the Character. In addition, if the game uses [[Character Sheets]], players who have permission to edit this Character will be able to view and edit the Character Sheet tab.
 
The Controlled By field allows you to give Players in your game the ability to &quot;speak&quot; as that Character in the Text Chat. They are also able to edit the Character's information if they control it. In addition, if you use the Represents Character feature of the Tokens Settings, players who have permission to control this Character will also be able to control any tokens that represent this character. You can also choose &quot;All Players&quot; to allow everyone to control or edit the Character. In addition, if the game uses [[Character Sheets]], players who have permission to edit this Character will be able to view and edit the Character Sheet tab.
  
===== Default Token =====
+
==== Default Token ====
 
The Default Token field gives you the ability to select a token on the tabletop to use as the default token for this Character whenever it is added to the table. Just select a token, then press the "Use Selected Token" button. A copy of the token will be stored, including any notes, player permissions settings, and bar values and links. A GM or a player that can  [[Journal#Can_Be_Edited_.26_Controlled_By|'''Edit and Control''']] this Character can then drag-and-drop the Character from the Journal listing in the right sidebar onto the tabletop, and a new copy of the Character's default token will be added to the table.
 
The Default Token field gives you the ability to select a token on the tabletop to use as the default token for this Character whenever it is added to the table. Just select a token, then press the "Use Selected Token" button. A copy of the token will be stored, including any notes, player permissions settings, and bar values and links. A GM or a player that can  [[Journal#Can_Be_Edited_.26_Controlled_By|'''Edit and Control''']] this Character can then drag-and-drop the Character from the Journal listing in the right sidebar onto the tabletop, and a new copy of the Character's default token will be added to the table.
  
Line 68: Line 53:
 
[[File:Journal9.0.gif|left|frame]]
 
[[File:Journal9.0.gif|left|frame]]
  
===== Tags =====
+
==== Tags ====
 
The Tags field allows you to tag the Character so that you can quickly find it later using the Search box at the top of the Journal tab in the sidebar.
 
The Tags field allows you to tag the Character so that you can quickly find it later using the Search box at the top of the Journal tab in the sidebar.
  
===== Duplicate =====
+
==== Duplicate ====
 
Using the Duplicate feature will create another Character Journal.  This can be useful when using a character or NPC/monster "template".
 
Using the Duplicate feature will create another Character Journal.  This can be useful when using a character or NPC/monster "template".
  
===== Archive =====
+
==== Archive ====
 
Archiving the Character will put it in long-term storage. You can easily return it to the Journal tab by clicking on the &quot;Archived Items&quot; link that will appear in the list after you've archived at least one Character.
 
Archiving the Character will put it in long-term storage. You can easily return it to the Journal tab by clicking on the &quot;Archived Items&quot; link that will appear in the list after you've archived at least one Character.
  
===== Delete =====
+
==== Delete ====
 
Deleting the Character will permanently remove it from the Game, and cannot be undone.
 
Deleting the Character will permanently remove it from the Game, and cannot be undone.
  
===== Bio & Info Field =====
+
==== Bio & Info Field ====
 
The Bio & Info field allows you to input information about the Character.
 
The Bio & Info field allows you to input information about the Character.
  
===== GM Notes Field =====
+
==== GM Notes Field ====
 
Use the GM Notes area to add additional notes that only the GM can see.
 
Use the GM Notes area to add additional notes that only the GM can see.
  
Line 92: Line 77:
 
<div style="clear: both;"></div>
 
<div style="clear: both;"></div>
  
==== Character Sheet Tab ====
+
=== Character Sheet Tab ===
  
 
Your Character may also have a Sheet tab, which is a way to display information about the character which mimics a paper character sheet for the game you are playing. Your GM will set this feature up if it's available for your game. Filling out the sheet is straightforward, just click on any field and enter your information. Some fields will also auto-update based on other information (for example, your Strength Modifier may auto-calculate based on the Strength of your Character). Finally, Character Sheets may also have roll buttons which you can click to quickly perform skill checks and other actions (such as attacks) for your Character. Again, consult with your GM for the details on your specific game.
 
Your Character may also have a Sheet tab, which is a way to display information about the character which mimics a paper character sheet for the game you are playing. Your GM will set this feature up if it's available for your game. Filling out the sheet is straightforward, just click on any field and enter your information. Some fields will also auto-update based on other information (for example, your Strength Modifier may auto-calculate based on the Strength of your Character). Finally, Character Sheets may also have roll buttons which you can click to quickly perform skill checks and other actions (such as attacks) for your Character. Again, consult with your GM for the details on your specific game.
Line 98: Line 83:
 
More information on Character Sheets, including how to set them up if you're the GM of the game, are available in the '''[[Character Sheets]]''' article.
 
More information on Character Sheets, including how to set them up if you're the GM of the game, are available in the '''[[Character Sheets]]''' article.
  
==== Attributes & Abilities Tab ====
+
=== Attributes & Abilities Tab ===
 
[[File:Journal8.0.png|right|frame]]
 
[[File:Journal8.0.png|right|frame]]
 
Characters also have Attributes and Abilities, which are used to track stats about the Character and store rolls and other chat commands that are frequently used by that Character. To access the Attributes and Abilities, click on the "Attributes and Abilities" tab along the top of the screen.
 
Characters also have Attributes and Abilities, which are used to track stats about the Character and store rolls and other chat commands that are frequently used by that Character. To access the Attributes and Abilities, click on the "Attributes and Abilities" tab along the top of the screen.
  
===== Attributes =====
+
==== Attributes ====
 
You can add Attributes to your Characters. Each attribute has a name, as well as, a current and (optional) max value. Any players that you give permission to edit/control the Character will also be able to edit the Attributes. Attributes can be used as variables in '''[[Macros|Macros]]''' and Abilities.
 
You can add Attributes to your Characters. Each attribute has a name, as well as, a current and (optional) max value. Any players that you give permission to edit/control the Character will also be able to edit the Attributes. Attributes can be used as variables in '''[[Macros|Macros]]''' and Abilities.
  
Line 109: Line 94:
 
* [[Macros#Using_a_Targeted_Token_with_a_Macro|Using a Targeted Token with a Macro]]
 
* [[Macros#Using_a_Targeted_Token_with_a_Macro|Using a Targeted Token with a Macro]]
  
===== Abilities =====
+
==== Abilities ====
 
Abilities are designed to work in conjunction with Attributes. Abilities work almost exactly as '''[[Macros|Macros]]'''. You can put any valid chat command (rolls, emotes, etc.) into the ability. By using an Attribute that is assigned to a Character as a variable modifier, you can create complex Character-based Abilities. Type "@" to view a list of Attributes that can be used. Since the variable used in the Ability is linked to a Character Attribute, the value will sync when changed in the Character editor. You can easily add and remove Abilities from your Macro Quick-Bar by selecting the Character from the Journal Tab. Shift+Clicking on an Ability on the Macro Quick-Bar will open that Character's Ability editor. Abilities can also be used as '''[[Token Actions|Token Actions]]''' which is a token specific macro feature.
 
Abilities are designed to work in conjunction with Attributes. Abilities work almost exactly as '''[[Macros|Macros]]'''. You can put any valid chat command (rolls, emotes, etc.) into the ability. By using an Attribute that is assigned to a Character as a variable modifier, you can create complex Character-based Abilities. Type "@" to view a list of Attributes that can be used. Since the variable used in the Ability is linked to a Character Attribute, the value will sync when changed in the Character editor. You can easily add and remove Abilities from your Macro Quick-Bar by selecting the Character from the Journal Tab. Shift+Clicking on an Ability on the Macro Quick-Bar will open that Character's Ability editor. Abilities can also be used as '''[[Token Actions|Token Actions]]''' which is a token specific macro feature.
  
Line 122: Line 107:
 
<div style='clear: both; height: 10px;'></div><br><br>
 
<div style='clear: both; height: 10px;'></div><br><br>
  
== Handouts ==
+
= Handouts =
  
 
Handouts are very similar to Characters and have some of the same fields.  
 
Handouts are very similar to Characters and have some of the same fields.  
Line 128: Line 113:
  
  
=== Handout Dialog ===
+
== Handout Dialog ==
 
When you click on a '''Handout''' in the '''Journal Listing''', it will open the '''Handout Dialog'''.  This is where you view the contents of the '''Handout''', including the '''Image''' (if one is associated), the '''Description &amp; Notes''' text (if any has been entered) and the '''GM Notes''' (if the viewer is a GM).   
 
When you click on a '''Handout''' in the '''Journal Listing''', it will open the '''Handout Dialog'''.  This is where you view the contents of the '''Handout''', including the '''Image''' (if one is associated), the '''Description &amp; Notes''' text (if any has been entered) and the '''GM Notes''' (if the viewer is a GM).   
  
Line 135: Line 120:
 
The '''Name''' of the '''Handout''' will be shown across the top of the '''Handout Dialog''' with several buttons:
 
The '''Name''' of the '''Handout''' will be shown across the top of the '''Handout Dialog''' with several buttons:
  
==== Pop-Out Button ====
+
=== Pop-Out Button ===
 
[[File:ShowPopupButtonPictosPipe.png|left]]
 
[[File:ShowPopupButtonPictosPipe.png|left]]
 
This button is to the left of the '''Name''' and looks like two overlapping rectangles.  Clicking it will open a window separate from the Roll20 primary window, which can then be placed on a different monitor or switched between with the OS&apos;s native commands.
 
This button is to the left of the '''Name''' and looks like two overlapping rectangles.  Clicking it will open a window separate from the Roll20 primary window, which can then be placed on a different monitor or switched between with the OS&apos;s native commands.
  
==== Show To Players Button (''GM Only'') ====
+
=== Show To Players Button (''GM Only'') ===
 
This button is to the right of the '''Name''' and allows the GM to cause the '''Handout Dialog''' to be displayed on the screens of any players that can '''View''' the '''Handout'''.  If no players can '''View''' the '''Handout''', a dialog will prompt the GM and ask if it should be shared with all players.  Clicking '''Show to Everyone''' will insert '''All Players''' into the '''In Players&apos;s Journals''' field of the '''Handout''' (see below).
 
This button is to the right of the '''Name''' and allows the GM to cause the '''Handout Dialog''' to be displayed on the screens of any players that can '''View''' the '''Handout'''.  If no players can '''View''' the '''Handout''', a dialog will prompt the GM and ask if it should be shared with all players.  Clicking '''Show to Everyone''' will insert '''All Players''' into the '''In Players&apos;s Journals''' field of the '''Handout''' (see below).
  
==== Edit Button ====
+
=== Edit Button ===
 
The GM always has this button, as do any players that can '''Edit''' the '''Handout''' because of inclusion in '''Can Be Edited By''' (see below).  Clicking this button will move the '''Handout Dialog''' into the '''Editing''' view.
 
The GM always has this button, as do any players that can '''Edit''' the '''Handout''' because of inclusion in '''Can Be Edited By''' (see below).  Clicking this button will move the '''Handout Dialog''' into the '''Editing''' view.
  
=== Editing ===
+
== Editing ==
 
[[File:EditHandoutDialog.png|right|border|300px]]
 
[[File:EditHandoutDialog.png|right|border|300px]]
 
The '''Editing''' view of the '''Handout Dialog''' allows GMs and players who can '''Edit''' to make changes to the '''Handout'''.
 
The '''Editing''' view of the '''Handout Dialog''' allows GMs and players who can '''Edit''' to make changes to the '''Handout'''.
  
==== Name ====
+
=== Name ===
 
You can change the default text of '''''Mysterious Note''''' to whatever you like.  This will be the title of the '''Handout''' in the '''Journal''' tab, and will show across the top of the '''Handout Dialog''' when it is opened.
 
You can change the default text of '''''Mysterious Note''''' to whatever you like.  This will be the title of the '''Handout''' in the '''Journal''' tab, and will show across the top of the '''Handout Dialog''' when it is opened.
  
==== In Player's Journals (''GM Only'') ====
+
=== In Player's Journals (''GM Only'') ===
 
Just like for '''Characters''', the GM is the only person that can see a '''Handout''' by default.  You can allow viewing by select players by putting their name in this field, or select '''All Players''' to allow access to all. Players with a '''Handout''' in their journal will be able to view it whenever they like.  It will be shown in whatever folder the GM has put it in, complete with the name of the folder.  You may want to move a handout before allowing your players to view it (For example, if it is in the ''Cursed Items'' folder).
 
Just like for '''Characters''', the GM is the only person that can see a '''Handout''' by default.  You can allow viewing by select players by putting their name in this field, or select '''All Players''' to allow access to all. Players with a '''Handout''' in their journal will be able to view it whenever they like.  It will be shown in whatever folder the GM has put it in, complete with the name of the folder.  You may want to move a handout before allowing your players to view it (For example, if it is in the ''Cursed Items'' folder).
  
 
You can also drag and drop a Handout from the Journal tab in the right sidebar onto a player.  That player will be given permission to view the Handout, and it will also appear on their screen immediately.
 
You can also drag and drop a Handout from the Journal tab in the right sidebar onto a player.  That player will be given permission to view the Handout, and it will also appear on their screen immediately.
  
==== Can Be Edited By (''GM Only'') ====
+
=== Can Be Edited By (''GM Only'') ===
 
Similar to the '''In Player&apos;s Folder''', by default only the GM can edit a '''Handout'''.  Placing a player's name in this field allows that player to both '''View''' and '''Edit''' that '''Handout'''.  This is particularly useful for allowing players journals or secret notes for correspondence with the GM.  The same notes about folders apply as with the above.
 
Similar to the '''In Player&apos;s Folder''', by default only the GM can edit a '''Handout'''.  Placing a player's name in this field allows that player to both '''View''' and '''Edit''' that '''Handout'''.  This is particularly useful for allowing players journals or secret notes for correspondence with the GM.  The same notes about folders apply as with the above.
  
==== Tags (''GM Only'') ====
+
=== Tags (''GM Only'') ===
 
The '''Tags''' field allows you to assign words to associate with this '''Handout''' which are useful for finding it later via the '''Search''' field or the '''Tag List Dropdown'''.
 
The '''Tags''' field allows you to assign words to associate with this '''Handout''' which are useful for finding it later via the '''Search''' field or the '''Tag List Dropdown'''.
  
==== Image ====
+
=== Image ===
 
You can upload an '''Image''' to represent this '''Handout''' in the '''Journal''' listing. Just drag and drop an image from your computer, or drag and drop an image from the '''[[Art_Library|Art Library]]''' search results into the box.
 
You can upload an '''Image''' to represent this '''Handout''' in the '''Journal''' listing. Just drag and drop an image from your computer, or drag and drop an image from the '''[[Art_Library|Art Library]]''' search results into the box.
  
==== Description &amp; Notes ====
+
=== Description &amp; Notes ===
 
This field lets you associate a freeform block of text with the '''Handout'''.  This text is visible to players that can '''View''' the '''Handout''' and editable by players that can '''Edit''' the '''Handout'''.
 
This field lets you associate a freeform block of text with the '''Handout'''.  This text is visible to players that can '''View''' the '''Handout''' and editable by players that can '''Edit''' the '''Handout'''.
  
==== GM Notes (''GM Only'') ====
+
=== GM Notes (''GM Only'') ===
 
This field is just like '''Description &amp; Notes''' save that only the GM can edit and view it, regardless of other settings.
 
This field is just like '''Description &amp; Notes''' save that only the GM can edit and view it, regardless of other settings.
  
==== Archive Handout (''GM Only'') ====
+
=== Archive Handout (''GM Only'') ===
 
The '''Archive Handout''' button will move the '''Handout''' to a special area where it will no longer show up in the '''Journal Listing''' or in results from the '''Search''' field or '''Tag List Dropdown'''.  Archived handouts can be accessed in the '''Archived Handouts Dialog''' at the bottom of the '''Journal Listing''', and can be restored there.
 
The '''Archive Handout''' button will move the '''Handout''' to a special area where it will no longer show up in the '''Journal Listing''' or in results from the '''Search''' field or '''Tag List Dropdown'''.  Archived handouts can be accessed in the '''Archived Handouts Dialog''' at the bottom of the '''Journal Listing''', and can be restored there.
  
==== Delete Handout (''GM Only'') ====
+
=== Delete Handout (''GM Only'') ===
 
The '''Delete Handout''' button will prompt for confirmation and then permanently remove the '''Handout''' from the '''Game'''.
 
The '''Delete Handout''' button will prompt for confirmation and then permanently remove the '''Handout''' from the '''Game'''.
 +
 +
= Organizing Your Journal Entries =
 +
[[File:Journal3.1.jpg|frame|right]]
 +
Folders can be used to help organize '''Characters''' and '''Handouts''' within the Journal. Folders and the complete folder structure can be seen by all players who join the game as well as the GM, assuming there is at least one item in each folder for which players have available to their journals. If a folder contains items that are only available to the GM's journal, the players will not see that folder.
 +
 +
== Adding Folders ==
 +
Add a new folder using '''+ Add''' button as described at the top of this page, making sure to select '''Folder''' from the dropdown menu. Follow the instructions on the prompt to name the folder and hit '''OK''' to add the folder to the Journal.
 +
 +
== Folder Options ==
 +
Right click the folder to reveal a list of options. Add '''Subfolders''', '''Characters''', and '''Handouts''' using this method to automatically nest 4 additional folders under the right-clicked folder. Items can also be moved in and out of folders manually using the mouse, see '''[[Journal#Reorganizing_Journal_Items|Reorganizing Journal Items]]''' for more detail.
 +
{{mbox | text = '''Note:''' Due to the limited space on the Sidebar, only 3 additional folders can be added. '''Characters''' and '''Handouts''' can only be added to the most deeply nested folder by using the right-click options menu to add items.}}
 +
 +
 +
You can sort alphabetically, rename or delete the folder from this menu as well. Deleting folders will '''not''' delete the items inside. All items in the deleted folder will be moved to the root folder. Using the '''Delete Folder''' option requires your approval upon use, confirm when prompted to initiate your action.
  
 
== Reorganizing Journal Items ==
 
== Reorganizing Journal Items ==

Revision as of 20:33, 12 March 2017

The Journal Tab on the Sidebar

The Journal is the third tab of the Sidebar. This feature allows GMs to create Characters, Handouts. The Journal serves as a central repository for game information. These items can be made private or shared with other players. Shared items can be viewed by players with access from this same tab.

03-12-17 Admin Note: This Page is Currently being updated for better legibility

Contents

Characters

Characters are intended to represent either PCs or important NPCs in your Game. Each Character has a name, an avatar which represents the Character, Attributes, Abilities and a Bio and a GM Notes section.

Adding Characters

Add a new Character using + Add button as described at the top of this page, making sure to select Character from the dropdown menu or by right-clicking a folder and selecting Add Character from the Folder Options menu. The system randomly generates a placeholder name and creates the Character.


Journal7.0.png

Character Options

Right-click the Character name to reveal a list of options, including Show to Players, Archive Item, or Delete Item. Your approval is needed upon use of the Show to Players and Delete Item options - confirm when prompted to initiate your action.

Character Window

Click the Character name from the Sidebar to open the info window. To the left of the Character name is a popout button. Click to pop your info window out into a new browser window. Visit the My Settings page to set popout windows to automatic. Click the Show to Players button to reveal the Character to all players or click the "Edit" button to customize.

Journal6.0.jpg


Bio & Info Tab

Information added to the Character window using the Edit button will be displayed here. Click the Edit button to further customize Character details.

Journal5.0.jpg

Avatar

You can upload an Avatar to represent this Character in the Journal listing as well as the Chat interface. Just drag and drop an image from your computer, or drag and drop an image from the Art Library search results into the box.

Name

Change the randomly generated placeholder name to a Character name of your choice.

In Player's Journals =

By default, only the GM sees the Character. To allow other Players to see the Character in their Journal tab, add their names to the "In Players Journals" field. You can also choose "All Players" to allow everyone to view the Character.

Players who can view the Character will see the name, avatar, and any text typed on the Character's Bio & Info tab only.

= Can Be Edited & Controlled By

The Controlled By field allows you to give Players in your game the ability to "speak" as that Character in the Text Chat. They are also able to edit the Character's information if they control it. In addition, if you use the Represents Character feature of the Tokens Settings, players who have permission to control this Character will also be able to control any tokens that represent this character. You can also choose "All Players" to allow everyone to control or edit the Character. In addition, if the game uses Character Sheets, players who have permission to edit this Character will be able to view and edit the Character Sheet tab.

Default Token

The Default Token field gives you the ability to select a token on the tabletop to use as the default token for this Character whenever it is added to the table. Just select a token, then press the "Use Selected Token" button. A copy of the token will be stored, including any notes, player permissions settings, and bar values and links. A GM or a player that can Edit and Control this Character can then drag-and-drop the Character from the Journal listing in the right sidebar onto the tabletop, and a new copy of the Character's default token will be added to the table.

Once a Token is tied to a Character in the Journal, a Shift+Click on the Settings icon when a token is selected or Shift+Double Clicking on the token directly will open the attached Character; Alt+Click opens the character to the Attributes & Abilities tab. You can also drag and drop the character name from the Journal tab to add tokens directly to the tabletop once a token has been tied to its Character.

Journal9.0.gif

Tags

The Tags field allows you to tag the Character so that you can quickly find it later using the Search box at the top of the Journal tab in the sidebar.

Duplicate

Using the Duplicate feature will create another Character Journal. This can be useful when using a character or NPC/monster "template".

Archive

Archiving the Character will put it in long-term storage. You can easily return it to the Journal tab by clicking on the "Archived Items" link that will appear in the list after you've archived at least one Character.

Delete

Deleting the Character will permanently remove it from the Game, and cannot be undone.

Bio & Info Field

The Bio & Info field allows you to input information about the Character.

GM Notes Field

Use the GM Notes area to add additional notes that only the GM can see.

Character Sheet Tab

Your Character may also have a Sheet tab, which is a way to display information about the character which mimics a paper character sheet for the game you are playing. Your GM will set this feature up if it's available for your game. Filling out the sheet is straightforward, just click on any field and enter your information. Some fields will also auto-update based on other information (for example, your Strength Modifier may auto-calculate based on the Strength of your Character). Finally, Character Sheets may also have roll buttons which you can click to quickly perform skill checks and other actions (such as attacks) for your Character. Again, consult with your GM for the details on your specific game.

More information on Character Sheets, including how to set them up if you're the GM of the game, are available in the Character Sheets article.

Attributes & Abilities Tab

Journal8.0.png

Characters also have Attributes and Abilities, which are used to track stats about the Character and store rolls and other chat commands that are frequently used by that Character. To access the Attributes and Abilities, click on the "Attributes and Abilities" tab along the top of the screen.

Attributes

You can add Attributes to your Characters. Each attribute has a name, as well as, a current and (optional) max value. Any players that you give permission to edit/control the Character will also be able to edit the Attributes. Attributes can be used as variables in Macros and Abilities.

Attribute calls (e.g. @{AC}) that are not placed within one of tabs of a Character Window (e.g. within a field on the Character Sheet Tab or within an Ability on the Attributes & Abilities Tab) must use a keyword to let the parser know which Character you intend to call that Attribute from (e.g. @{selected|AC}).

Abilities

Abilities are designed to work in conjunction with Attributes. Abilities work almost exactly as Macros. You can put any valid chat command (rolls, emotes, etc.) into the ability. By using an Attribute that is assigned to a Character as a variable modifier, you can create complex Character-based Abilities. Type "@" to view a list of Attributes that can be used. Since the variable used in the Ability is linked to a Character Attribute, the value will sync when changed in the Character editor. You can easily add and remove Abilities from your Macro Quick-Bar by selecting the Character from the Journal Tab. Shift+Clicking on an Ability on the Macro Quick-Bar will open that Character's Ability editor. Abilities can also be used as Token Actions which is a token specific macro feature.

Abilities can be called directly from the chat by typing them similarly to an Attribute. The format is %{<character name>|<ability name}, for example: %{Bob the Slayer|Massive Axe}

Finally, you can hover over Attributes and Abilities to drag and drop to re-order them or delete them.

Ability calls (e.g. %{Bob the Slayer|Massive Axe}) always require a keyword (e.g. the Character Name keyword; "Bob the Slayer"), even within a tab of a Character Window. (e.g. %{Massive Axe} won't work for Bob but %{selected|Massive Axe} can.)

Ability Command Buttons can be used to call Abilities from the text chat.



Handouts

Handouts are very similar to Characters and have some of the same fields.


Handout Dialog

When you click on a Handout in the Journal Listing, it will open the Handout Dialog. This is where you view the contents of the Handout, including the Image (if one is associated), the Description & Notes text (if any has been entered) and the GM Notes (if the viewer is a GM).

If you include an image that's larger than the Handout Dialog, a magnifying glass will appear over the image when you view the Handout. Clicking on the image in the Handout Dialog will display either the original dimensions or a full-screen version of that image.

The Name of the Handout will be shown across the top of the Handout Dialog with several buttons:

Pop-Out Button

ShowPopupButtonPictosPipe.png

This button is to the left of the Name and looks like two overlapping rectangles. Clicking it will open a window separate from the Roll20 primary window, which can then be placed on a different monitor or switched between with the OS's native commands.

Show To Players Button (GM Only)

This button is to the right of the Name and allows the GM to cause the Handout Dialog to be displayed on the screens of any players that can View the Handout. If no players can View the Handout, a dialog will prompt the GM and ask if it should be shared with all players. Clicking Show to Everyone will insert All Players into the In Players's Journals field of the Handout (see below).

Edit Button

The GM always has this button, as do any players that can Edit the Handout because of inclusion in Can Be Edited By (see below). Clicking this button will move the Handout Dialog into the Editing view.

Editing

EditHandoutDialog.png

The Editing view of the Handout Dialog allows GMs and players who can Edit to make changes to the Handout.

Name

You can change the default text of Mysterious Note to whatever you like. This will be the title of the Handout in the Journal tab, and will show across the top of the Handout Dialog when it is opened.

In Player's Journals (GM Only)

Just like for Characters, the GM is the only person that can see a Handout by default. You can allow viewing by select players by putting their name in this field, or select All Players to allow access to all. Players with a Handout in their journal will be able to view it whenever they like. It will be shown in whatever folder the GM has put it in, complete with the name of the folder. You may want to move a handout before allowing your players to view it (For example, if it is in the Cursed Items folder).

You can also drag and drop a Handout from the Journal tab in the right sidebar onto a player. That player will be given permission to view the Handout, and it will also appear on their screen immediately.

Can Be Edited By (GM Only)

Similar to the In Player's Folder, by default only the GM can edit a Handout. Placing a player's name in this field allows that player to both View and Edit that Handout. This is particularly useful for allowing players journals or secret notes for correspondence with the GM. The same notes about folders apply as with the above.

Tags (GM Only)

The Tags field allows you to assign words to associate with this Handout which are useful for finding it later via the Search field or the Tag List Dropdown.

Image

You can upload an Image to represent this Handout in the Journal listing. Just drag and drop an image from your computer, or drag and drop an image from the Art Library search results into the box.

Description & Notes

This field lets you associate a freeform block of text with the Handout. This text is visible to players that can View the Handout and editable by players that can Edit the Handout.

GM Notes (GM Only)

This field is just like Description & Notes save that only the GM can edit and view it, regardless of other settings.

Archive Handout (GM Only)

The Archive Handout button will move the Handout to a special area where it will no longer show up in the Journal Listing or in results from the Search field or Tag List Dropdown. Archived handouts can be accessed in the Archived Handouts Dialog at the bottom of the Journal Listing, and can be restored there.

Delete Handout (GM Only)

The Delete Handout button will prompt for confirmation and then permanently remove the Handout from the Game.

Organizing Your Journal Entries

Journal3.1.jpg

Folders can be used to help organize Characters and Handouts within the Journal. Folders and the complete folder structure can be seen by all players who join the game as well as the GM, assuming there is at least one item in each folder for which players have available to their journals. If a folder contains items that are only available to the GM's journal, the players will not see that folder.

Adding Folders

Add a new folder using + Add button as described at the top of this page, making sure to select Folder from the dropdown menu. Follow the instructions on the prompt to name the folder and hit OK to add the folder to the Journal.

Folder Options

Right click the folder to reveal a list of options. Add Subfolders, Characters, and Handouts using this method to automatically nest 4 additional folders under the right-clicked folder. Items can also be moved in and out of folders manually using the mouse, see Reorganizing Journal Items for more detail.


You can sort alphabetically, rename or delete the folder from this menu as well. Deleting folders will not delete the items inside. All items in the deleted folder will be moved to the root folder. Using the Delete Folder option requires your approval upon use, confirm when prompted to initiate your action.

Reorganizing Journal Items

Journal3gif.gif

Hover your mouse over the item you wish to move. Grab the "handle" that shows up along the left-side of the item name. Drag the item just below the folder that you want to move it to and then move the file to the right before dropping it in the folder.

Minimizing Journal Entries

MinimizedJournals.jpg

You can minimize journal entries by double clicking upon any currently opened character journal or handout. This will shrink the item down to a small translucent title bar with the name of the entry on it and a couple buttons listed on the bar’s right side. You can click and drag this title bar to wherever is most convenient on the browser. To maximize the journal entry again, simply double click on the minimized title bar.

While minimized, the Edit button is still available to access for both character journals and handouts. In the case for handouts, there’s also a “Show To Players” button option.

You can close minimized journal entries by clicking on the X button on the far right of the title bar.


External Journal Access

If your GM is a Plus or Pro subscriber, you can easily view your External Journal entries outside of the app. Located on the Game Details page, under the Content dropdown menu, along with access to your Chat Archive and Game Forums.

Ej1.png

This is great for checking up on things in-between gaming sessions without the hassle of loading up the whole tabletop. You can also keep the External Journal open in a separate tab or browser window, or even on another screen.

The External Journal updates in real-time. So if a change is made to a character’s bio, you don’t need to reload, you’ll see the change right away. This really enables you to use the External Journal as a play aid during your Roll20 games.

Journal Command Buttons

Within the Bio & Info and GM Notes text fields of a Character, or the Description & Notes and GM Notes text fields of a Handout, you can create Journal Command Buttons; special hyperlinks that can output macros to the Text Chat when clicked.

Here's how to create a Journal Command Button within one of the aforementioned fields:

  1. Insert a link using the link button on the redactor toolbar.
  2. At the very start of the "URL" field of the Link Window, type !&#13;
  3. Add in your macro code after the !&#13;
  4. Give your Journal Command Button a label using the "Text" field.
  5. Press the "Insert" button and Save Changes; you have created a Journal Command Button!


Note: opening the Link Window converts HTML Entities; it's necessary to restore the !&#13; (and any other HTML entities) before saving changes to a Journal Command Button via the Link Window.

Another way to create Journal Command Buttons is to copy and paste an API Command Button or Ability Command Button from the Text Chat into one of the aforementioned text fields.

Note: Journal Command Buttons will not work if you have the Use Window Popouts for Characters option enabled.

Link Between Journal Entries

You can easily link your journal entries together inside the game.

Just put single brackets around the name of a character or handout (for example: “[Mr. Bearington] is most-known for his long, flowing hair”), and when you save the entry we’ll automatically create a clickable link that will open that other journal entry.

Journallinkss.png

It works both inside and outside the app, and it’s smart enough to obey player permissions as well (so a player can’t open a handout they don’t have access to, even if they see a link to that handout).

You can use the links in character bios, GM notes (both for characters and tokens), and handout notes fields. Use links to tie entries together, or even create a “table of contents” page for your game to quickly access your most-used journal items.