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 "Character Sheets"

From Roll20 Wiki

Jump to: navigation, search
m
m (Default Sheet Settings, cleanup, links)
Line 98: Line 98:
 
<br>
 
<br>
 
<br>
 
<br>
=Advanced Character Sheet Usage=
+
=Default Sheet Settings=
 +
'''Default Sheet Settings''' will determine default values & settings for any new character sheets added to the {{Journal}}, which the [[GM]] can change from the [[Game_Settings_Page#Default_Sheet_Settings|Game Settings Page]].
  
 +
 +
If you want to apply these settings to '''existing''' character sheets in the game, go to {{My Settings}} in-game, and press the [[My_Settings#Apply_Default_Settings|Apply Default Settings]]-button.
 +
=Advanced Usage=
 +
 +
==Attributes==
 +
{{main|Journal#Attributes}}
 
'''Interaction with Attributes'''
 
'''Interaction with Attributes'''
  
Sheets in Roll20 are a presentation layer for the Attributes system. This means that every field on the sheet is "backed" by a corresponding Attribute on the Character. For example, if there is a field called "Strength" on the sheet, there will also be an attribute called "Strength" in the Attributes & Abilities listing tab. As you update the sheet, the attribute is updated, and vice versa. This also allows you to link the sheet to a token the same way you would link an Attribute to a token, via the "Represents" box on the Token Settings dialog.  
+
Sheets in Roll20 are a presentation layer for the Attributes system. This means that every field on the sheet is "backed" by a corresponding Attribute on the Character. For example, if there is a field called "Strength" on the sheet, there will also be an attribute called "Strength" in the [[Journal#Attributes_.26_Abilities_Tab|Attributes & Abilities]]-tab. As you update the sheet, the attribute is updated, and vice versa. This also allows you to link the sheet to a [[token]] the same way you would link an Attribute to a token, via the "Represents" box on the Token Settings dialog.  
  
 +
==Macros and Abilities==
 +
{{main|Macor Guide}}
 
'''Interaction with Macros and Abilities'''
 
'''Interaction with Macros and Abilities'''
  
You can reference sheet values in your Macros and Abilities by referencing the corresponding Attribute. For example, <code>@{Character Name|Strength}</code> would use the "Strength" attribute, which is also the "Strength" field on the sheet (which would have <code>name='attr_Strength'</code> in the sheet builder). If the Sheet has a "Strength" field which hasn't been edited yet by the player, then the result of the variable will be either the default value for the field specified on the sheet by the sheet designer, or it will be "" (an empty string).
+
You can reference sheet values in your Macros and Abilities by referencing the corresponding Attribute. For example, <code>@{Bob|strength}</code> would use the <code>strength</code> attribute, which is also the <code>strength</code> field on the sheet (which would have <code>name='attr_strength'</code> in the sheet code). If the Sheet has a <code>strength</code> field which hasn't been edited yet by the [[player]], then the result of the variable will be either the default value for the field specified on the sheet by the sheet designer, or it will be "" (an empty string).
  
Note that at present you cannot reference auto-calculated values or sheet rolls from the character sheet using the auto-complete function (discussed in [[Macros]]) in custom macros on the abilities page or in the text chat. You can, however, reference all of them by typing them out manually (for example, <code>/roll 1d20+@{Character Name|STR-mod}</code> for a strength check using the Pathfinder character sheet). You can also create an ability that contains the macro or sheet roll(s) you wish to use, and then you can reference that ability with the auto-complete function. To find the specific name of a given auto-calculated field, read the specific notes about the character sheet you are using. Some sheets have tooltips telling you the name of the attribute, but this is at the discretion of the sheet author.
+
Note that at present you cannot reference [[Auto-Calc|auto-calculated]] values or sheet rolls from the character sheet using the auto-complete function (discussed in [[Macros]]) in custom macros on the abilities page or in the {{Text Chat}}. You can, however, reference all of them by typing them out manually (for example, <code>/roll 1d20+@{Alice|STR-mod}</code> for a strength check using the Pathfinder character sheet). You can also create an ability that contains the macro or sheet roll(s) you wish to use, and then you can reference that ability with the auto-complete function. To find the specific name of a given auto-calculated field, read the specific notes about the character sheet you are using. Some sheets have tooltips telling you the name of the attribute, but this is at the discretion of the sheet author.
  
 +
==API==
 
'''Interaction with API''' ''([[Pro]] feature)''
 
'''Interaction with API''' ''([[Pro]] feature)''
  
Line 118: Line 128:
 
<code>getAttrByName(character_id, attribute_name, value_type);</code>
 
<code>getAttrByName(character_id, attribute_name, value_type);</code>
  
'''Roll Templates'''
+
==Roll Templates==
 +
{{main|Roll Templates}}
  
Roll Templates are a special facet of the Character Sheets system which can be added by the sheet author to provide additional layout and styling options for the display of roll results. See the '''[[Roll_Templates|Roll Templates]]''' wiki to learn more.
+
Roll Templates are a special facet of the Character Sheets system which can be added by the sheet author to provide additional layout and styling options for the display of roll results.
  
'''Modifying a Community Sheet'''
+
==Modifying Community Sheet==
 +
{{pro only}}
 +
If you are interested in creating your own Character Sheet for a new game system, improving an existing sheet, or creating your own sheet that's fully customized for your individual play style, you can build your own custom character sheet .
 +
 
 +
Read More at '''[[Building Character Sheets]]'''
  
 
If you run a slightly modified version of a common game system (such as Pathfinder with your own homebrew rules), you may want to modify the existing sheet. To do so, you must be a '''Pro''' subscriber. If you are:
 
If you run a slightly modified version of a common game system (such as Pathfinder with your own homebrew rules), you may want to modify the existing sheet. To do so, you must be a '''Pro''' subscriber. If you are:
  
# Go to the Game Details => Game Settings page of your game (outside of the game). Make sure that the "Custom" option is selected under the Character Sheet Template section. You will see an editor with 3 tabs.
+
# Go to the [[Game Details]] => [[Game Settings]] page of your game (outside of the game). Make sure that the "Custom" option is selected under the Character Sheet Template section. You will see an editor with 3 tabs.
# Go to the Github repository for the community sheets: [https://github.com/Roll20/roll20-character-sheets https://github.com/Roll20/roll20-character-sheets]
+
# Go to the {{repo|Roll20/roll20-character-sheets Github repository}} for the community sheets.
 
# Find the folder for the sheet you are using (e.g. "Pathfinder").
 
# Find the folder for the sheet you are using (e.g. "Pathfinder").
 
# There should be an HTML file and a CSS file in the folder. You can ignore any other files. Copy the contents of the HTML file and paste them into the HTML/Layout tab of the sheet editor for your game. Do the same for the CSS file and the CSS/Style tab.
 
# There should be an HTML file and a CSS file in the folder. You can ignore any other files. Copy the contents of the HTML file and paste them into the HTML/Layout tab of the sheet editor for your game. Do the same for the CSS file and the CSS/Style tab.
 
# Make your modifications. Those modifications will only apply to this game, and they don't have to approved by anyone else. You can find more information about how to create new fields and other sheet tools on the [[Building Character Sheets]] page.
 
# Make your modifications. Those modifications will only apply to this game, and they don't have to approved by anyone else. You can find more information about how to create new fields and other sheet tools on the [[Building Character Sheets]] page.
 
# '''NOTE:''' If you decide to use a custom version of a community sheet, you will not receive future updates for the community sheet.
 
# '''NOTE:''' If you decide to use a custom version of a community sheet, you will not receive future updates for the community sheet.
 +
 +
  
 
=Character Sheet in a separate window=
 
=Character Sheet in a separate window=
Line 139: Line 156:
 
'''Things that don't work when sheet is in a separate window:'''
 
'''Things that don't work when sheet is in a separate window:'''
  
* '''Charactermancer doesn't work.''' - You might be able to open it, but the final step to finish building doesn't work.
+
* '''[[Charactermancer]] doesn't work.''' - You might be able to open it, but the final step to finish building doesn't work.
* '''Can't drag-n-drop''' - you can't drag-n-drop from the compendium to the sheet when it's in its own window
+
* '''Can't [[drag-n-drop]]''' - drag-n-drop from the {{compendium}} to the sheet when it's in its own window is inconsistent, and doesn't work in all situations.
* '''Can't re-order things in repeating sections''' - You can check/uncheck the "lock" and delete entries, but not re-order them
+
* '''Can't re-order things in [[#Repeating Sections]]''' - You can check/uncheck the "lock" and delete entries, but not re-order them
* '''Edit "Bio & Info"-tab''' - when you press on the edit button, Roll20 opens the sheet inside the main Roll20 application on the "Bio & Info" page for the sheet
+
* '''Edit "[[Journal#Bio_.26_Info_Tab|Bio & Info]]"-tab''' - when you press on the edit button, Roll20 opens the sheet inside the main Roll20 application on the "Bio & Info" page for the sheet
* '''Nothing in the "Attributes & Abilities"-tab can be re-ordered''' - you can add & delete Attributes and add Abilities, but not re-order them
+
* '''Nothing in the "[[Journal#Attributes_.26_Abilities_Tab|Attributes & Abilities]]"-tab can be re-ordered''' - you can add & delete Attributes and add Abilities, but not re-order them
  
 
[[File:Char-sheet-popped-out.png|thumb|Example of how the character sheet looks while in a separate window(Firefox 75/Linux Mint 19/April 14th 2020)|left|500px]]
 
[[File:Char-sheet-popped-out.png|thumb|Example of how the character sheet looks while in a separate window(Firefox 75/Linux Mint 19/April 14th 2020)|left|500px]]
Line 164: Line 181:
 
<br>
 
<br>
 
<br>
 
<br>
 
=Building a Character Sheet=
 
{{pro only}}
 
If you are interested in creating your own Character Sheet for a new game system, improving an existing sheet, or creating your own sheet that's fully customized for your individual play style, you can build your own custom character sheet .
 
 
Read More at '''[[Building Character Sheets]]'''
 
  
 
=Community Sheets=
 
=Community Sheets=
  
There is a library of sheets contributed by the community that you can choose to use instead of creating your own from scratch. If you want to help improve those sheets or add a sheet for a new game, see the [https://github.com/Roll20/roll20-character-sheets Github repository] and [[Beginner's Guide to GitHub]].
+
There is a library of sheets contributed by the community that you can choose to use instead of creating your own from scratch. If you want to help improve those sheets or add a sheet for a new game, see the {{repo|Roll20/roll20-character-sheets Github repository}} and [[Beginner's Guide to GitHub]].
  
 
==Character Sheet Guides==
 
==Character Sheet Guides==

Revision as of 12:54, 14 May 2021

Attention: Roll20 is no longer maintaining this document on the community wiki. For the most up-to-date information please visit this page on our help center for assistance: Character Sheet Tips & Tricks.

Main Page Journal, "Characters"-section

D&D 5E by Roll20 Character Sheet

Character Sheets allow you to use a digital sheet that's similar to a traditional paper character sheet while playing your game in Roll20. The creator of a game can choose a character sheet template when setting up the game, and all characters in the game will use that sheet template.

Contents

Choosing a Character Sheet Template

Depending on what game system you want to play, or even choosing between options available for some systems, you must decide what template, if any, to use in your game.

If you choose None, then all characters will only have a Bio & Attributes & Abilites-tabs, but no tab for "Character Sheet."

How a sheet without template looks like
The menu to choose Character Sheet Template

Starting a New Game

When starting a new game, you(as the game's Creator have the option to choose the Character Sheet Template you want to use from the handy drop-down available on the New Game creation screen. The Sheet Template can be changed after game creation form the Game Settings-page. If you're making a Game that's a copy based on an existing Game, the copy will keep all relevant sheet template information to match the original. Finally, you need to click the (I'm Ready, Create Game) button to save.

For an Existing Game

To change or add Character Sheet, the Creator of the game should visit the Game Settings page. This page is accessed from the Settings dropdown on the Game Details page. Links to the Game Details pages of games that you belong to can be found on the My Games page.

In the Character Sheet Template section, select a template from the dropdown. Pro subscribers can also choose Custom, and then enter their own HTML/CSS/Translation code into the Sheet Editor. Finally, you need to click the (Save Changes) button found at the bottom of the screen.

Game Settings
The Add button in the Journal Tab

Add Individual Sheets In-Game

The Game's Creator (or anyone promoted to GM) can add individual character sheets in-game that can be assigned to people(players can't do so). You go to the {{Journal}-tab and click on the + Add button and select Character from the dropdown menu.

You can also add a character by right-clicking an existing folder in the N Journal-tab, and selecting Add Character from the Folder Options menu. Adding new Characters or Handouts using the right-click method places them directly into the right-clicked folder.

Regardless of how you create the Character entry, Roll20 will randomly generate a random name for the new Character.



Character Sheet Basics

Drag and drop sheet buttons to the macro quick bar.

If there is a character sheet template enabled for your game, there will be a new tab on when you open up a Character in your Journal labeled "Character Sheet". Clicking this tab will open the Character Sheet. The layout and look of your sheet, as well as what fields are available, will be determined by the template that the creator of the game has chosen.

The most basic way to interact with a sheet is simply by filling in values. You can type in text boxes, choose from drop-down menus, use checkboxes and radio buttons, etc. As you fill out the sheet, all of your changes are automatically saved.

Some fields may have default values already included. You can modify these values as needed for your particular Character. Some fields are also auto-calculating. As you fill out other parts of the sheet, those fields will auto-update to reflect their new values. You cannot modify those fields directly.




Repeating Sections

In addition to fields, your sheet may feature repeating sections. These are sections (for example, the "Skills" section in the example sheet shown to the right) where you can put more than one item in a list. Just click the & button beneath the section to add a new entry.

You can click the ( "Modify/Lock"-button to enable deleting existing entries, or reorganizing them.

Sheet Rolls

Your sheet may also feature roll buttons. These are pre-defined rolls included with the sheet which allow you to quickly make attacks, roll checks, etc. These rolls will use the values that you have filled in on the sheet to function, so they're always up-to-date.

To acquire the contents of a sheet roll button:

  1. Click on the sheet roll button.
  2. Focus the q Text Chat's input box (by clicking into to it, or using the Advanced Shortcut c c). When it's focused, a blue outline appears around it.
  3. Press the up arrow key on your keyboard.
  4. The contents of the sheet roll button will then populate the text chat input box.


To acquire the Ability call corresponding to that sheet roll button, drag the sheet button down to the Macro Quick Bar, click on what you just dragged down, and then complete steps 2 to 4.

Drag and Drop Buttons

You can drag and drop sheet buttons to the macro quick bar. Buttons may be dragged directly off of the character sheet and placed onto the Macro Quick Bar at the bottom of the screen, simply by clicking and dragging the button into place. The buttons can be removed by dragging the button out of the quick bar into open space, the button will turn red and then vanish when the mouse is released. Please note, if you have the pop-out option enabled for the character sheets you must first disable it under your user settings (ycog icon) before the drag and drop function will work. You can then turn it back on after you arrange your macro buttons.

Example of an Initiative Roll that appears on the Turn Tracker

To delete a button that was added to the macro bar simply drag the button off the bar.

Initiative Rolls

For an Initiative roll to end up on the Turn Tracker, a token must first be selected, otherwise the roll only appears in the q Text Chat.

The Initiative roll can be made from a character sheet or use stats from one, but doesn't have to. See Dice Reference#Roll To Initiative for details on initiative rolls.

See also Linking Tokens to Characters.







Default Sheet Settings

Default Sheet Settings will determine default values & settings for any new character sheets added to the N Journal, which the GM can change from the Game Settings Page.


If you want to apply these settings to existing character sheets in the game, go to y My Settings in-game, and press the Apply Default Settings-button.

Advanced Usage

Attributes

Main Page: Journal#Attributes

Interaction with Attributes

Sheets in Roll20 are a presentation layer for the Attributes system. This means that every field on the sheet is "backed" by a corresponding Attribute on the Character. For example, if there is a field called "Strength" on the sheet, there will also be an attribute called "Strength" in the Attributes & Abilities-tab. As you update the sheet, the attribute is updated, and vice versa. This also allows you to link the sheet to a token the same way you would link an Attribute to a token, via the "Represents" box on the Token Settings dialog.

Macros and Abilities

Main Page: Macor Guide

Interaction with Macros and Abilities

You can reference sheet values in your Macros and Abilities by referencing the corresponding Attribute. For example, @{Bob|strength} would use the strength attribute, which is also the strength field on the sheet (which would have name='attr_strength' in the sheet code). If the Sheet has a strength field which hasn't been edited yet by the player, then the result of the variable will be either the default value for the field specified on the sheet by the sheet designer, or it will be "" (an empty string).

Note that at present you cannot reference auto-calculated values or sheet rolls from the character sheet using the auto-complete function (discussed in Macros) in custom macros on the abilities page or in the q Text Chat. You can, however, reference all of them by typing them out manually (for example, /roll 1d20+@{Alice|STR-mod} for a strength check using the Pathfinder character sheet). You can also create an ability that contains the macro or sheet roll(s) you wish to use, and then you can reference that ability with the auto-complete function. To find the specific name of a given auto-calculated field, read the specific notes about the character sheet you are using. Some sheets have tooltips telling you the name of the attribute, but this is at the discretion of the sheet author.

API

Interaction with API (Pro feature)

Since all sheet fields are attributes, you can simply use the existing API methods for Attributes to read or update sheet values as needed. Note that if a sheet field has not been edited yet for a Character, that Character will not have an attribute for that field. So be sure to check for "undefined" Attributes when fetching values. Once a sheet has been edited for a Character, the Attribute is available to the API for reading. You can always write to the Attribute even if the sheet hasn't been edited yet by creating that Attribute yourself -- the sheet in-game will update accordingly.

You can get the value of attributes via the following function call. If the attribute has not been edited, it returns the default value, if it is an auto-calc value, it returns the auto-cal formula, not the calculated value. Note that value_type appears to be optional.

getAttrByName(character_id, attribute_name, value_type);

Roll Templates

Main Page: Roll Templates

Roll Templates are a special facet of the Character Sheets system which can be added by the sheet author to provide additional layout and styling options for the display of roll results.

Modifying Community Sheet

If you are interested in creating your own Character Sheet for a new game system, improving an existing sheet, or creating your own sheet that's fully customized for your individual play style, you can build your own custom character sheet .

Read More at Building Character Sheets

If you run a slightly modified version of a common game system (such as Pathfinder with your own homebrew rules), you may want to modify the existing sheet. To do so, you must be a Pro subscriber. If you are:

  1. Go to the Game Details => Game Settings page of your game (outside of the game). Make sure that the "Custom" option is selected under the Character Sheet Template section. You will see an editor with 3 tabs.
  2. Go to the Github repository for the community sheets.
  3. Find the folder for the sheet you are using (e.g. "Pathfinder").
  4. There should be an HTML file and a CSS file in the folder. You can ignore any other files. Copy the contents of the HTML file and paste them into the HTML/Layout tab of the sheet editor for your game. Do the same for the CSS file and the CSS/Style tab.
  5. Make your modifications. Those modifications will only apply to this game, and they don't have to approved by anyone else. You can find more information about how to create new fields and other sheet tools on the Building Character Sheets page.
  6. NOTE: If you decide to use a custom version of a community sheet, you will not receive future updates for the community sheet.


Character Sheet in a separate window

Highlighted in red, the button to open a character in a separate window

It's possible to have the character sheet "popped out" in a separate browser window from Roll20, but while in this mode, a number of things don't work quite as well as when it's viewed inside the VTT. The popping out feature is more of a convenience during play to keep the window uncluttered, but if you want to make lots of changes to the sheet, it's generally a good idea to not have it "popped out".

Things that don't work when sheet is in a separate window:

  • Charactermancer doesn't work. - You might be able to open it, but the final step to finish building doesn't work.
  • Can't drag-n-drop - drag-n-drop from the i Compendium to the sheet when it's in its own window is inconsistent, and doesn't work in all situations.
  • Can't re-order things in #Repeating Sections - You can check/uncheck the "lock" and delete entries, but not re-order them
  • Edit "Bio & Info"-tab - when you press on the edit button, Roll20 opens the sheet inside the main Roll20 application on the "Bio & Info" page for the sheet
  • Nothing in the "Attributes & Abilities"-tab can be re-ordered - you can add & delete Attributes and add Abilities, but not re-order them
Example of how the character sheet looks while in a separate window(Firefox 75/Linux Mint 19/April 14th 2020)



















Community Sheets

There is a library of sheets contributed by the community that you can choose to use instead of creating your own from scratch. If you want to help improve those sheets or add a sheet for a new game, see the Github repository and Beginner's Guide to GitHub.

Character Sheet Guides

Here is a list of some of the Guides for popular or well-documented character sheet. See also: Full list of Character Sheet Guides
Full list of Character Sheet Guides



Other Official/Publisher-made Sheets


Other well-documented sheets:

Related Pages