Home
Games
Marketplace
Compendium Character Vault Roll20 for iPad and Android
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 "Default Sheet Settings"

From Roll20 Wiki

Jump to: navigation, search
m (cleanup msg)
 
(37 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
{{revdate}}{{BCS}}
 +
{{cleanup-msg|1=According to [https://app.roll20.net/forum/post/11603811/every-sheet-author-should-read-this/?pageforid=11603811#post-11603811 this Sept. 2023 thread], there are errors on page on when '''default''' vs. '''value''' is used for values.|2=December 2023}}
 +
This is documentation for how the '''Default Sheet Settings''' are constructed, aimed at [[Sheet Authors|sheet authors]] & creators.
 +
{{NavSheetDoc}}
 +
For the '''Default Sheet Settings''' in your game, see '''[[Game_Settings_Page#Default_Sheet_Settings|Game Settings Page - Default Sheet Settings]]'''.
  
  
−
Character Sheets can store settings for all characters in the '''useroptions''' section of the sheet.json file. These settings can be updated easily in the [[Game Settings Page|Game Settings]]. An simple example of what can be done with these settings can be found in the [https://github.com/Roll20/roll20-character-sheets/blob/master/Star%20Trek%20Adventures%20by%20Roll20/sheet.json Star Trek sheet.json file]. More complex examples can be found in the [https://github.com/Roll20/roll20-character-sheets/blob/master/5th%20Edition%20OGL%20by%20Roll20/sheet.json D&D 5e by Roll20 sheet.json file], or the [https://github.com/Roll20/roll20-character-sheets/blob/master/Pathfinder%20Official/sheet.json Pathfinder Official sheet.json].
+
'''Default Settings''' for character sheets is a feature available for some [[Character Sheets]] found in the [[Add_character_sheet#Adding_a_Character_Sheet_to_your_Campaign|Sheet Selection Dropdown]]. Default Sheet Settings can't be used with [[Using_Custom_Character_Sheets|custom character sheets]].
  
−
=== Requirements include: ===
+
They can be used to make changes in the default information, options, and presentation of [[Journal#Adding_Characters|new characters added inside a game]]. If a Character Sheet(available from the drop-down menu) have Default Settings available, they can be found on the [[Game_Settings_Page#Default_Sheet_Settings|Game Settings Page]]. Changing any Default Settings doesn't affect existing character sheets, but every new character created afterwards use the new defaults.
  
−
* '''attribute''' - the name of the sheet variable set with this option
+
'''To apply the Default Settings to all existing Character Sheets''', the GM can go to the {{My Settings}}-tab, and scroll to the bottom where a '''[[My_Settings#Apply_Default_Settings|Apply Default Settings]]'''-button can be seen.
−
* '''displayname''' - Title element of the selection
+
 
−
* '''displaytranslationkey''' - i18n [[Character Sheet i18n|translation key]] for translation into other languages
+
The [[Sheet_Sandbox#Game_Default_Settings|Sheet Sandbox]] can be used for testing Default Sheet Settings.
−
* '''type''' - HTML form element to be used in [[Game Settings Page]]. Options include select, radio, checkbox, text
+
[[File:Default-Settings-Example.png|400px|thumbnail|right|Some of the Default Settings of [[D&D 5E by Roll20]]]]
−
* '''options''' - If your form element has predefined options, the key/value pairs are listed here
+
 
−
* '''optiontranslationkeys''' - i18n translation keys for the options
+
Default Sheet Settings are stored on the '''useroptions''' section of the [[sheet.json]]-file. These settings can be updated easily in the [[Game_Settings_Page#Default_Sheet_Settings|Game Settings]].
−
* '''description''' - a text string use to give further detail about the option and the changes it controls
+
__TOC__
−
* '''descriptiontranslationkey''' - i18n translation keys used for the description
+
===Common Usage===
 +
* Change if new sheets are Player or NPC by default. Example:  [[D&D 5E by Roll20]]
 +
** If all player sheets have been made, it can be handy for the GM to change so any new sheets are NPC right away, saving a few clicks if they need to quickly create a new character.
 +
* Set default values for starting gold/credit/character points/attributes/health for a new character. Example: [[Star Wars WEG D6 character sheet|Star Wars D6]]
 +
** In many games, lvl.1/starter characters start with a set number for several stats, but if a game is started at a higher level, or with homebrew rules, it can be handy to have characters have the right values right of the bat, so the GM doesn't have to go correct each sheet before giving them to the player.
 +
* Toggle various user options, cosmetic or practical. Example: [[Star Wars WEG D6 character sheet|Star Wars D6]]
 +
** turn on/off popups that asks for roll modifiers before each roll
 +
** change if character name is shown on the roll template
 +
** changing character sheet and/or roll-template color/layout
 +
** hiding/revealing sheet sections, like hiding magic section from characters who don't have access to it
 +
* Change a shared stat between players. Example: [[Stargate|Stargate RPG]] Tension Die usually changes from session to session.
 +
** If the GM isn't a Pro user, they would be forced to manually edit each sheet if there is no Def Sheet Settings for the stat that could be used for changing the stat campaign-wide.
 +
* Token bar settings for [[Compendium#Drag_and_Drop_Functionality|Compendium Drag&drop]]
 +
 
 +
==For sheet authors==
 +
 
 +
==="useroptions" options===
 +
See also the example section down the page
 +
 
 +
* '''attribute''' - the name of the sheet attribute changed with this option. Don't include the <code>attr_</code> part.
 +
* '''displayname''' - The short desc. of what the setting does
 +
* '''displaytranslationkey''' - i18n [[Character Sheet Translation|translation key]] for translation into other languages(not needed  if sheet doesn't use translations)
 +
* '''description''' - for giving further detail about the option and the changes it controls. Text is displayed in a smaller font than '''displayname'''
 +
* '''descriptiontranslationkey''' - i18n translation key used for the description (not needed  if sheet doesn't use translations)
 +
* '''type''' - the HTML input element to be used in [[Game Settings Page]]. Options are:
 +
** <code>text</code>
 +
*** '''value''' - set the default value for the text input
 +
** <code>number</code>
 +
*** '''value''' - set the default value for the number input
 +
** <code>checkbox</code>
 +
*** '''value''' - set the value of the checkbox if checked
 +
*** '''checked''' - If you want a checkbox checked by default, add <code>"checked": "checked",</code> under the attribute
 +
** <code>select</code>
 +
*** '''options''' - If the setting-type is <code>select</code>. Storing the key/value pairs are listed here
 +
*** '''optiontranslationkeys''' - i18n translation keys for the options (not needed if sheet doesn't use translations)
 +
*** '''default''' - the default value of the select. If used for a select input with multiple options, set this to the value of the wanted default selection, not including the key.
 +
** <code>radio</code> - radio does not appear to work at this time.
 +
 
 +
===Testing your <code>sheet.json</code> file===
 +
 
 +
Default Sheet Settings may be tested via the [[Sheet Sandbox]].
 +
 
 +
Every time you want to test out a new [[sheet.json]] file, you have:
 +
* copy its contents in the "Sheet.json Editor" section of the settings page of the sandbox (which URL looks like https://app.roll20.net/sheetsandbox/settings/#######)
 +
* click the "Reload Default Sheet" in the sandbox itself (url: [https://app.roll20.net/editor/ https://app.roll20.net/editor/]).
 +
 
 +
 
 +
If you [https://github.com/Roll20/roll20-character-sheets/search?q=%22useroptions%22%3A&unscoped_q=%22useroptions%22%3A search the Roll20 Sheet repository] for uses of <code>"useroptions"</code> you can find further examples of Default option in usage.
 +
<br><br>
 +
 
 +
== Examples ==
 +
Few examples of Default Settings currently in use.
 +
 
 +
{{repo|Roll20/roll20-character-sheets/blob/master/Star%20Trek%20Adventures%20by%20Roll20/sheet.json Star Trek Adventures}} is a simple example, while {{repo|Roll20/roll20-character-sheets/tree/master/DD5thEditionLegacy/sheet.json D&D 5e by Roll20}} & {{repo|roll20-character-sheets/blob/master/Pathfinder%20by%20Roll20/sheet.json Pathfinder Official}} have a ton of settings.
 +
 
 +
==={{repo|Roll20/roll20-character-sheets/blob/master/Fate%20Core%20v2/sheet.json Fate Core}} by MagooChris===
 +
Contains example of text inputs, checkboxes(some checked by default), default values, and use of  language tags for multilingual support.
 +
<pre style="overflow:auto;white-space:pre-wrap;" data-language="json">
 +
    "useroptions": [
 +
        {
 +
            "attribute": "show_hints_flag",
 +
            "displayname": "Show First Time Hints",
 +
            "displaytranslationkey": "ShowHints-Q",
 +
            "type": "checkbox",
 +
"value": "1",
 +
"checked": "checked",
 +
            "description": "Show hints that might be useful for first time players or those upgrading from the previous sheet design.",
 +
            "descriptiontranslationkey": "ShowHints-D"
 +
},
 +
        {
 +
            "attribute": "run_firstTime_setup",
 +
            "displayname": "Run First Time Setup",
 +
            "displaytranslationkey": "RunFirstTimeSetup-Q",
 +
            "type": "checkbox",
 +
"value": "1",
 +
"checked": "checked",
 +
            "description": "Run scripts to setup the sheet for a default character.",
 +
            "descriptiontranslationkey": "RunFirstTimeSetup-D"
 +
},
 +
        {
 +
            "attribute": "default_stressSkills",
 +
            "displayname": "Default Stresses and Skills",
 +
            "displaytranslationkey": "DefaultStressSkill-Q",
 +
            "type": "text",
 +
"default": "Physical:Physique,Mental:Will",
 +
            "description": "When setting up a default sheet, what stress tracks and their guiding skill should be set up? e.g. \"Mental:Will,Extra:3\"",
 +
            "descriptiontranslationkey": "DefaultStressSkill-D"
 +
},
 +
        {
 +
            "attribute": "attr_default_consequences",
 +
            "displayname": "Default Consequences",
 +
            "displaytranslationkey": "DefaultConsequences-Q",
 +
            "type": "text",
 +
"default": "2,4,6",
 +
            "description": "When setting up a default sheet, what consequences are the default consequences? e.g. \"2,4,6\"",
 +
            "descriptiontranslationkey": "DefaultConsequences-D"
 +
},
 +
{
 +
"attribute": "show_conditions_flag",
 +
"displayname": "Use Conditions instead of Consequences",
 +
"displaytranslationkey": "ShowConditions-Q",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "Use the Conditions from the Fate Toolkit to replace Consequences",
 +
"descriptiontranslationkey": "ShowConditions-Q"
 +
},
 +
{
 +
"attribute": "show_phase0_flag",
 +
"displayname": "Show Phase 0 Tab",
 +
"displaytranslationkey": "ShowPhase0-Q",
 +
"type": "checkbox",
 +
"value": "1",
 +
"checked": "checked",
 +
"description": "If you are starting with a Phase 0, then you can use this tab to build up your ideas.",
 +
"descriptiontranslationkey": "ShowPhase0-Q"
 +
},
 +
{
 +
"attribute": "show_notesTab_flag",
 +
"displayname": "Show Notes Tab",
 +
"displaytranslationkey": "ShowNotesTab-Q",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "Set this if you would prefer the notes to show on a Tab of their own.",
 +
"descriptiontranslationkey": "ShowNotesTab-Q"
 +
}
 +
]
 +
</pre>
 +
 
 +
==={{repo|Roll20/roll20-character-sheets/blob/master/D6StarWars/sheet.json Star Wars D6}} by [[Andreas J.]]===
 +
[[File:SWD6-Default-Settings.png|250px|thumbnail|right|Default Settings of Star Wars D6 sheet(using this section's code)]]
 +
<br><br><br>
 +
<br>
 +
Contains example of:
 +
* dropdown menu(<select>)
 +
* checkboxes
 +
* number inputs
 +
* default values
 +
 
 +
 
 +
Sheet doesn't contain [[i18n|translation]] attributes, so they are also left out from the Default Settings.
 +
<br><br><br>
 +
<br><br>
 +
<br><br>
 +
 
 +
<pre style="overflow:auto;white-space:pre-wrap;" data-language="json">
 +
    "useroptions": [
 +
    {
 +
"attribute": "sheettype",
 +
"displayname": "Sheet Type: ",
 +
"type": "select",
 +
"options": [
 +
"PC|0",
 +
"NPC|1",
 +
"Ship|2",
 +
"Container|3"
 +
],
 +
"default": "0",
 +
"description": "PC is the normal sheet, NPC is a compact version of the same, Ship shows stat blocks for ship only, and Container shows only the Weapon/Armor/Equipment sections(simulating a Container or Shop display)."
 +
},
 +
    {
 +
"attribute": "gmrollswitch",
 +
"displayname": "Hide GM Rolls: ",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "When checked, the sheet hides the extra dice that makes hidden rolls to the GM."
 +
},
 +
    {
 +
"attribute": "rollmodswitch",
 +
"displayname": "Disable Roll Mods Query: ",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "If checked, rolls don't ask for roll modifiers and rolls right away when selected."
 +
},
 +
    {
 +
"attribute": "wilddie",
 +
"displayname": "Use Wild Die: ",
 +
"type": "select",
 +
"options": [
 +
"Yes|!cf1cs6",
 +
"No|cf0cs0"
 +
],
 +
"default": "!cf1cs6",
 +
"description": "If Wild Die isn't used, the last die wont explode or highlight critical successes/failures."
 +
},
 +
    {
 +
"attribute": "forceswitch",
 +
"displayname": "Hide Force Section: ",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "Practical for those who are not Force-sensitive."
 +
},
 +
    {
 +
"attribute": "equipmentswitch",
 +
"displayname": "Hide Equipment Section: ",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "Practical for those who are not Force-sensitive."
 +
},
 +
    {
 +
"attribute": "backgroundswitch",
 +
"displayname": "Hide Background Section: ",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "Hides Backstory & Misc. section"
 +
},
 +
    {
 +
"attribute": "cpswitch",
 +
"displayname": "Hide Character Point Summary: ",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "Hides the Character Point Summary table used for tracking gain/usage history"
 +
},
 +
    {
 +
"attribute": "creditswitch",
 +
"displayname": "Hide Credit Summary: ",
 +
"type": "checkbox",
 +
"value": "1",
 +
"description": "Hides the Credit Summary section used for tracking balance history"
 +
},
 +
    {
 +
"attribute": "credits",
 +
"displayname": "Starting Credits: ",
 +
"type": "number",
 +
"value": "1000",
 +
"description": "How many credits a character starts with."
 +
},
 +
    {
 +
"attribute": "characterPoints",
 +
"displayname": "Character Points: ",
 +
"type": "number",
 +
"value": "0",
 +
"description": "How many Character Points a character starts with."
 +
},
 +
    {
 +
"attribute": "forcePoints",
 +
"displayname": "Force Points: ",
 +
"type": "number",
 +
"value": "1",
 +
"description": "How many Force Points a character starts with."
 +
}
 +
]
 +
</pre>
 +
 
 +
===[[Stargate RPG]] by [[Andreas J.]]===
 +
* {{repo|Roll20/roll20-character-sheets/blob/master/Stargate-RPG/sheet.json Stargate sheet.json}}
 +
 
 +
<pre style="overflow:auto;white-space:pre-wrap;" data-language="json">
 +
  "useroptions": [
 +
    {
 +
      "attribute": "show_name",
 +
      "displayname": "Show name in rolls? ",
 +
      "type": "select",
 +
      "options": [
 +
        "Yes|{{subtitle=@{character_name} }}",
 +
        "No| "
 +
      ],
 +
      "default": "{{subtitle=@{character_name} }}",
 +
      "description": "Determine if newly created characters displayed their names in rolls by default. GMs can find useful to hide the names of NPCs in some situations. This option can be be later changed on individual sheets from the 'Settings-page.'"
 +
    },
 +
    {
 +
      "attribute": "whisper",
 +
      "displayname": "Whisper Rolls to GM?",
 +
      "type": "checkbox",
 +
      "value": "/w gm",
 +
      "description": "Determine if newly created characters only shows their rolls to the GM by default. Players and GMs can sometime find it useful to hide a roll from the other players if a secret roll needs to be made. This option can be be later changed on individual sheets from the 'Settings-page.'"
 +
    },
 +
    {
 +
      "attribute": "campaign",
 +
      "displayname": "Campaign Name: ",
 +
      "type": "text",
 +
      "value": "",
 +
      "description": "Writes the campaign name on newly created character sheets."
 +
    },
 +
    {
 +
      "attribute": "td",
 +
      "displayname": "Tension die?",
 +
      "type": "select",
 +
      "options": [
 +
        "d4|d4",
 +
        "d6|d6",
 +
        "d8|d8",
 +
        "d10|d10",
 +
        "d12|d12"
 +
      ],
 +
      "default": "d6",
 +
      "description": "Determine what the Tension Die is for newly created character."
 +
    }
 +
  ],
 +
</pre>
 +
 
 +
==={{repo|Roll20/roll20-character-sheets/blob/master/Official%20Savage%20Worlds/sheet.json Official Savage Worlds}} by finderski===
 +
Contains example of text inputs, checkboxes(some checked by default), selects, default values, and use of  language tags for multilingual support.
 +
<pre style="overflow:auto;white-space:pre-wrap;" data-language="json">
 +
"useroptions":[
 +
        {
 +
            "attribute":"WCI",
 +
            "displayname":"Wild Card Symbol",
 +
            "displaytranslationkey":"wild-card-symbol",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"Set the default icon to designate a Wild Card. Will accept most unicode characters (including emojis--though these may make it difficult to tell a Wild Card from an Extra, because they don't gray out).",
 +
            "descriptiontranslationkey":"set-default-icon-for-wild-card-characters",
 +
            "default":"✪"
 +
        },
 +
        {
 +
            "attribute":"is_npc",
 +
            "displayname":"Extra",
 +
            "displaytranslationkey":"extra",
 +
            "type":"checkbox",
 +
            "value":"1",
 +
            "description":"This option sets new characters to default as Extras, instead of Wild Cards.",
 +
            "descriptiontranslationkey":"extra-config"
 +
        },
 +
        {
 +
            "attribute":"sheet_theme",
 +
            "displayname":"sheet-theme",
 +
            "displaytranslationkey":"sheet-theme",
 +
            "type":"select",
 +
            "options":[
 +
                    "Generic|0",
 +
                    "Deadlands|1",
 +
                    "Pathfinder|2",
 +
                    "Rifts|3"
 +
            ],
 +
            "optiontranslationkeys": [
 +
                "generic",
 +
                "deadlands",
 +
                "pathfinder",
 +
                "rifts"
 +
            ],
 +
            "default":"0",
 +
            "description":"Selecting a sheet theme will set the background image, logo displayed, and any special styling associated with the theme. The theme options are: Generic (the default), Deadlands (an Old West styled theme), Pathfinder (a theme to match the Pathfinder for Savage Worlds books), and Rifts&reg; (a more sci-fi type of theme). Even if a theme is selected, you can still change the packground or logo if desired.",
 +
            "descriptiontranslationkey":"sheet-theme-paragraph"
 +
        },
 +
        {
 +
            "attribute":"dark_mode",
 +
            "displayname":"Dark Mode (inverted colors)",
 +
            "displaytranslationkey":"dark-mode-invert-colors",
 +
            "type":"checkbox",
 +
            "value":"1",
 +
            "description":"This check box will invert the colors of the character sheet, making a quasi-Dark Mode. This only affects the Character Sheet tab of the character journal (Bio & Info, and Atttributes & Abilities are unaffected, unfortunately).",
 +
            "descriptiontranslationkey":"dark-mode-paragraph"
 +
        },
 +
        {
 +
            "attribute":"staticCore",
 +
            "displayname":"Show Core Skills",
 +
            "displaytranslationkey":"show-core-skills",
 +
            "type":"checkbox",
 +
            "value":"1",
 +
            "checked": "checked",
 +
            "description":"Checking this box will show the Five Core skills (Athletics, Common Knowledge, Notice, Persuastion, and Stealth) by default.",
 +
            "descriptiontranslationkey":"show-core-skills-by-default"
 +
        },
 +
        {
 +
            "attribute":"showFightingByDefault",
 +
            "displayname":"Show Fighting by Default",
 +
            "displaytranslationkey":"show-fighting-by-default",
 +
            "type":"checkbox",
 +
            "value":"1",
 +
            "description":"Checking this box will show the Fighting skill by default.",
 +
            "descriptiontranslationkey":"show-fighting-skill-by-default"
 +
        },
 +
        {
 +
            "attribute":"dominion-table",
 +
            "displayname":"Dominion Table Name",
 +
            "displaytranslationkey":"dominion-table-name",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"This table name is needed for the dominion roll button to function. This should the name of the rollable table for Dominion rolls. This will not set up the rollable table, so you will need to be sure to do that in the game.",
 +
            "descriptiontranslationkey":"setup-the-dominion-table-for-dominion-rolls"
 +
        },
 +
        {
 +
            "attribute":"gritty",
 +
            "displayname":"Setting Rule: Gritty Damage",
 +
            "displaytranslationkey":"setting-rule-gritty-damage",
 +
            "type":"checkbox",
 +
            "value":"{{getgritty=gritty}}",
 +
            "description":"Check this to use the Gritty Damage setting rule. Need to have a rollable table set up for this to work.",
 +
            "descriptiontranslationkey":"use-the-gritty-damage-setting-rule"
 +
        },
 +
        {
 +
            "attribute":"injurytablename",
 +
            "displayname":"Injury Table Name",
 +
            "displaytranslationkey":"injury-table-name",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"If using the Gritty Damage setting rule, this table name is needed and should the name of the rollable table for the Gritty Damage rolls. You will need to be sure to set this up.",
 +
            "descriptiontranslationkey":"only-need-if-using-gritty-damage-rule"
 +
        },
 +
        {
 +
            "attribute":"moneyfields",
 +
            "displayname":"Number of Money Fields",
 +
            "displaytranslationkey":"number-of-money-fields",
 +
            "type":"select",
 +
            "options":[
 +
                    "1",
 +
                    "2",
 +
                    "3",
 +
                    "4"
 +
                ],
 +
            "default":"1",
 +
            "description":"If there's more than one form of currency AND the wealth system isn't being used, this allows you to show up 4 different currencies.",
 +
            "descriptiontranslationkey":"number-of-money-fields-description"
 +
        },
 +
        {
 +
            "attribute":"moneyname",
 +
            "displayname":"Money Label",
 +
            "displaytranslationkey":"money-label",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"The label used for tracking money when the Wealth System isn't being used. This could be the name of a currency, if only a single currency is used (e.g. Credits), or the generic term for all currencies (e.g. Money) if more than a single currency is used.",
 +
            "descriptiontranslationkey":"money-label-description"
 +
        },
 +
        {
 +
            "attribute":"moneyonename",
 +
            "displayname":"Currency1 Label",
 +
            "displaytranslationkey":"currency1-label",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"If more than one currency is used, use this field to label the first currency type (e.g. Gold).",
 +
            "descriptiontranslationkey":"first-currency-label-description"
 +
        },
 +
        {
 +
            "attribute":"moneytwoname",
 +
            "displayname":"Currency2 Label",
 +
            "displaytranslationkey":"currency2-label",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"If more than one currency is used, use this field to label the second currency type (e.g. Silver).",
 +
            "descriptiontranslationkey":"second-currency-label-description"
 +
        },
 +
        {
 +
            "attribute":"moneythreename",
 +
            "displayname":"Currency3 Label",
 +
            "displaytranslationkey":"currency3-label",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"If more than one currency is used, use this field to label the third currency type (e.g. Electrum).",
 +
            "descriptiontranslationkey":"third-currency-label-description"
 +
        },
 +
        {
 +
            "attribute":"moneyfourname",
 +
            "displayname":"Currency4 Label",
 +
            "displaytranslationkey":"currency4-label",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"If more than one currency is used, use this field to label the fourth currency type (e.g. Copper).",
 +
            "descriptiontranslationkey":"fourth-currency-label-description"
 +
        },
 +
        {
 +
            "attribute":"faithname",
 +
            "displayname":"Rename Faith",
 +
            "displaytranslationkey":"rename-faith",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"Change the name of the Faith skill. This will change the name only, it won't change it's order in the list, etc.",
 +
            "descriptiontranslationkey":"change-skill-name-of-faith"
 +
        },
 +
        {
 +
            "attribute":"focusname",
 +
            "displayname":"Rename Focus",
 +
            "displaytranslationkey":"rename-focus",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"Rename the name of the Focus skill. This will change the name only, it won't change it's order in the list, etc.",
 +
            "descriptiontranslationkey":"change-skill-name-of-focus"
 +
        },
 +
        {
 +
            "attribute":"performancename",
 +
            "displayname":"Rename Performance",
 +
            "displaytranslationkey":"rename-performance",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"Rename the name of the Performance skill. This will change the name only, it won't change it's order in the list, etc.",
 +
            "descriptiontranslationkey":"change-skill-name-of-performance"
 +
        },
 +
        {
 +
            "attribute":"psionicsname",
 +
            "displayname":"Rename Psionics",
 +
            "displaytranslationkey":"rename-psionics",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"Rename the name of the Psionics skill. This will change the name only, it won't change it's order in the list, etc.",
 +
            "descriptiontranslationkey":"change-skill-name-of-psionics"
 +
        },
 +
        {
 +
            "attribute":"spellcastingname",
 +
            "displayname":"Rename Spellcasting",
 +
            "displaytranslationkey":"rename-spellcasting",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"Rename the name of the Spellcasting skill. This will change the name only, it won't change it's order in the list, etc.",
 +
            "descriptiontranslationkey":"change-skill-name-of-spellcasting"
 +
        },
 +
        {
 +
            "attribute":"weirdsciencename",
 +
            "displayname":"Rename Weird Science",
 +
            "displaytranslationkey":"rename-weird-science",
 +
            "type":"text",
 +
            "value":"",
 +
            "description":"Change the name of the Weird Science skill. This will change the name only, it won't change it's order in the list, etc.",
 +
            "descriptiontranslationkey":"change-skill-name-of-weird-science"
 +
        }
 +
  ]
 +
}
 +
</pre>
 +
 
 +
===translation===
 +
using [[i18n|translations]] in the user options:
 +
 
 +
* {{repo|Roll20/roll20-character-sheets/tree/master/DD5thEditionLegacy/sheet.json D&D 5e by Roll20}}
 +
 
 +
==See Also==
 +
* [[Building Character Sheets]]
 +
** '''[[sheet.json]]'''
 +
** [[Custom Sheet Sandbox]] - The way to test your Default Settings
 +
** [[Beginner%27s_Guide_to_GitHub|Beginner's Guide to GitHub]]
 +
*** [[Git|Git Guide]]
 +
** [[Character Sheet Translation]]
 +
** {{repo|Roll20/roll20-character-sheets Roll20 Character Sheet GitHub repository}}
 +
* [[Game Management]]
 +
** [[Game Settings Page]]
 +
* {{hc|articles/360041542554-Default-Sheet-Settings Roll20 Help Center}} - Almost always outdated/lacking compared to any pages on sheet development on the wiki
 +
<br />
 +
[[Category:Character Sheet Creation]]
 +
[[Category:Game Management]]

Latest revision as of 03:31, 12 December 2023

Wiki-Logo 75x49.png
Page Updated:
  2023-12-12
Octicons-terminal.png
This is related to Editing(coding) Character Sheets, which require
Pro
info to be able to use.
Main Page: Building Character Sheets
According to this Sept. 2023 thread, there are errors on page on when default vs. value is used for values.
You can help the Community Wiki by improving it. (December 2023)

This is documentation for how the Default Sheet Settings are constructed, aimed at sheet authors & creators.

Character Sheet Development
Getting Started

General

Reference

Tools & Tips

Git/GitHub Githublogo.png

Other

For the Default Sheet Settings in your game, see Game Settings Page - Default Sheet Settings.


Default Settings for character sheets is a feature available for some Character Sheets found in the Sheet Selection Dropdown. Default Sheet Settings can't be used with custom character sheets.

They can be used to make changes in the default information, options, and presentation of new characters added inside a game. If a Character Sheet(available from the drop-down menu) have Default Settings available, they can be found on the Game Settings Page. Changing any Default Settings doesn't affect existing character sheets, but every new character created afterwards use the new defaults.

To apply the Default Settings to all existing Character Sheets, the GM can go to the y My Settings-tab, and scroll to the bottom where a Apply Default Settings-button can be seen.

The Sheet Sandbox can be used for testing Default Sheet Settings.

Some of the Default Settings of D&D 5E by Roll20

Default Sheet Settings are stored on the useroptions section of the sheet.json-file. These settings can be updated easily in the Game Settings.

Contents

[edit] Common Usage

  • Change if new sheets are Player or NPC by default. Example: D&D 5E by Roll20
    • If all player sheets have been made, it can be handy for the GM to change so any new sheets are NPC right away, saving a few clicks if they need to quickly create a new character.
  • Set default values for starting gold/credit/character points/attributes/health for a new character. Example: Star Wars D6
    • In many games, lvl.1/starter characters start with a set number for several stats, but if a game is started at a higher level, or with homebrew rules, it can be handy to have characters have the right values right of the bat, so the GM doesn't have to go correct each sheet before giving them to the player.
  • Toggle various user options, cosmetic or practical. Example: Star Wars D6
    • turn on/off popups that asks for roll modifiers before each roll
    • change if character name is shown on the roll template
    • changing character sheet and/or roll-template color/layout
    • hiding/revealing sheet sections, like hiding magic section from characters who don't have access to it
  • Change a shared stat between players. Example: Stargate RPG Tension Die usually changes from session to session.
    • If the GM isn't a Pro user, they would be forced to manually edit each sheet if there is no Def Sheet Settings for the stat that could be used for changing the stat campaign-wide.
  • Token bar settings for Compendium Drag&drop

[edit] For sheet authors

[edit] "useroptions" options

See also the example section down the page

  • attribute - the name of the sheet attribute changed with this option. Don't include the attr_ part.
  • displayname - The short desc. of what the setting does
  • displaytranslationkey - i18n translation key for translation into other languages(not needed if sheet doesn't use translations)
  • description - for giving further detail about the option and the changes it controls. Text is displayed in a smaller font than displayname
  • descriptiontranslationkey - i18n translation key used for the description (not needed if sheet doesn't use translations)
  • type - the HTML input element to be used in Game Settings Page. Options are:
    • text
      • value - set the default value for the text input
    • number
      • value - set the default value for the number input
    • checkbox
      • value - set the value of the checkbox if checked
      • checked - If you want a checkbox checked by default, add "checked": "checked", under the attribute
    • select
      • options - If the setting-type is select. Storing the key/value pairs are listed here
      • optiontranslationkeys - i18n translation keys for the options (not needed if sheet doesn't use translations)
      • default - the default value of the select. If used for a select input with multiple options, set this to the value of the wanted default selection, not including the key.
    • radio - radio does not appear to work at this time.

[edit] Testing your sheet.json file

Default Sheet Settings may be tested via the Sheet Sandbox.

Every time you want to test out a new sheet.json file, you have:


If you search the Roll20 Sheet repository for uses of "useroptions" you can find further examples of Default option in usage.

[edit] Examples

Few examples of Default Settings currently in use.

Star Trek Adventures is a simple example, while D&D 5e by Roll20 & Pathfinder Official have a ton of settings.

[edit] Fate Core by MagooChris

Contains example of text inputs, checkboxes(some checked by default), default values, and use of language tags for multilingual support. 

    "useroptions": [
        {
            "attribute": "show_hints_flag",
            "displayname": "Show First Time Hints",
            "displaytranslationkey": "ShowHints-Q",
            "type": "checkbox",
			"value": "1",
			"checked": "checked",
            "description": "Show hints that might be useful for first time players or those upgrading from the previous sheet design.",
            "descriptiontranslationkey": "ShowHints-D"
		},
        {
            "attribute": "run_firstTime_setup",
            "displayname": "Run First Time Setup",
            "displaytranslationkey": "RunFirstTimeSetup-Q",
            "type": "checkbox",
			"value": "1",
			"checked": "checked",
            "description": "Run scripts to setup the sheet for a default character.",
            "descriptiontranslationkey": "RunFirstTimeSetup-D"
		},
        {
            "attribute": "default_stressSkills",
            "displayname": "Default Stresses and Skills",
            "displaytranslationkey": "DefaultStressSkill-Q",
            "type": "text",
			"default": "Physical:Physique,Mental:Will",
            "description": "When setting up a default sheet, what stress tracks and their guiding skill should be set up? e.g. \"Mental:Will,Extra:3\"",
            "descriptiontranslationkey": "DefaultStressSkill-D"
		},
        {
            "attribute": "attr_default_consequences",
            "displayname": "Default Consequences",
            "displaytranslationkey": "DefaultConsequences-Q",
            "type": "text",
			"default": "2,4,6",
            "description": "When setting up a default sheet, what consequences are the default consequences? e.g. \"2,4,6\"",
            "descriptiontranslationkey": "DefaultConsequences-D"
		},
		{
			"attribute": "show_conditions_flag",
			"displayname": "Use Conditions instead of Consequences",
			"displaytranslationkey": "ShowConditions-Q",
			"type": "checkbox",
			"value": "1",
			"description": "Use the Conditions from the Fate Toolkit to replace Consequences",
			"descriptiontranslationkey": "ShowConditions-Q"
		},
		{
			"attribute": "show_phase0_flag",
			"displayname": "Show Phase 0 Tab",
			"displaytranslationkey": "ShowPhase0-Q",
			"type": "checkbox",
			"value": "1",
			"checked": "checked",
			"description": "If you are starting with a Phase 0, then you can use this tab to build up your ideas.",
			"descriptiontranslationkey": "ShowPhase0-Q"
		},
		{
			"attribute": "show_notesTab_flag",
			"displayname": "Show Notes Tab",
			"displaytranslationkey": "ShowNotesTab-Q",
			"type": "checkbox",
			"value": "1",
			"description": "Set this if you would prefer the notes to show on a Tab of their own.",
			"descriptiontranslationkey": "ShowNotesTab-Q"
		}
	]

[edit] Star Wars D6 by Andreas J.

Default Settings of Star Wars D6 sheet(using this section's code)





Contains example of:

  • dropdown menu(<select>)
  • checkboxes
  • number inputs
  • default values


Sheet doesn't contain translation attributes, so they are also left out from the Default Settings. 






    "useroptions": [
    		{
					"attribute": "sheettype",
					"displayname": "Sheet Type: ",
					"type": "select",
					"options": [
						"PC|0",
						"NPC|1",
						"Ship|2",
						"Container|3"
					],
					"default": "0",
					"description": "PC is the normal sheet, NPC is a compact version of the same, Ship shows stat blocks for ship only, and Container shows only the Weapon/Armor/Equipment sections(simulating a Container or Shop display)."
			},
    		{
					"attribute": "gmrollswitch",
					"displayname": "Hide GM Rolls: ",
					"type": "checkbox",
					"value": "1",
					"description": "When checked, the sheet hides the extra dice that makes hidden rolls to the GM."
			},
    		{
					"attribute": "rollmodswitch",
					"displayname": "Disable Roll Mods Query: ",
					"type": "checkbox",
					"value": "1",
					"description": "If checked, rolls don't ask for roll modifiers and rolls right away when selected."
			},
    		{
					"attribute": "wilddie",
					"displayname": "Use Wild Die: ",
					"type": "select",
					"options": [
						"Yes|!cf1cs6",
						"No|cf0cs0"
					],
					"default": "!cf1cs6",
					"description": "If Wild Die isn't used, the last die wont explode or highlight critical successes/failures."
			},
    		{
					"attribute": "forceswitch",
					"displayname": "Hide Force Section: ",
					"type": "checkbox",
					"value": "1",
					"description": "Practical for those who are not Force-sensitive."
			},
    		{
					"attribute": "equipmentswitch",
					"displayname": "Hide Equipment Section: ",
					"type": "checkbox",
					"value": "1",
					"description": "Practical for those who are not Force-sensitive."
			},
    		{
					"attribute": "backgroundswitch",
					"displayname": "Hide Background Section: ",
					"type": "checkbox",
					"value": "1",
					"description": "Hides Backstory & Misc. section"
			},
    		{
					"attribute": "cpswitch",
					"displayname": "Hide Character Point Summary: ",
					"type": "checkbox",
					"value": "1",
					"description": "Hides the Character Point Summary table used for tracking gain/usage history"
			},
    		{
					"attribute": "creditswitch",
					"displayname": "Hide Credit Summary: ",
					"type": "checkbox",
					"value": "1",
					"description": "Hides the Credit Summary section used for tracking balance history"
			},
    		{
					"attribute": "credits",
					"displayname": "Starting Credits: ",
					"type": "number",
					"value": "1000",
					"description": "How many credits a character starts with."
			},
    		{
					"attribute": "characterPoints",
					"displayname": "Character Points: ",
					"type": "number",
					"value": "0",
					"description": "How many Character Points a character starts with."
			},
    		{
					"attribute": "forcePoints",
					"displayname": "Force Points: ",
					"type": "number",
					"value": "1",
					"description": "How many Force Points a character starts with."
			}		
		]

[edit] Stargate RPG by Andreas J.

  "useroptions": [
    {
      "attribute": "show_name",
      "displayname": "Show name in rolls? ",
      "type": "select",
      "options": [
        "Yes|{{subtitle=@{character_name} }}",
        "No| "
      ],
      "default": "{{subtitle=@{character_name} }}",
      "description": "Determine if newly created characters displayed their names in rolls by default. GMs can find useful to hide the names of NPCs in some situations. This option can be be later changed on individual sheets from the 'Settings-page.'"
    },
    {
      "attribute": "whisper",
      "displayname": "Whisper Rolls to GM?",
      "type": "checkbox",
      "value": "/w gm",
      "description": "Determine if newly created characters only shows their rolls to the GM by default. Players and GMs can sometime find it useful to hide a roll from the other players if a secret roll needs to be made. This option can be be later changed on individual sheets from the 'Settings-page.'"
    },
    {
      "attribute": "campaign",
      "displayname": "Campaign Name: ",
      "type": "text",
      "value": "",
      "description": "Writes the campaign name on newly created character sheets."
    },
    {
      "attribute": "td",
      "displayname": "Tension die?",
      "type": "select",
      "options": [
        "d4|d4",
        "d6|d6",
        "d8|d8",
        "d10|d10",
        "d12|d12"
      ],
      "default": "d6",
      "description": "Determine what the Tension Die is for newly created character."
    }
  ],

[edit] Official Savage Worlds by finderski

Contains example of text inputs, checkboxes(some checked by default), selects, default values, and use of language tags for multilingual support. 

"useroptions":[
        {
            "attribute":"WCI",
            "displayname":"Wild Card Symbol",
            "displaytranslationkey":"wild-card-symbol",
            "type":"text",
            "value":"",
            "description":"Set the default icon to designate a Wild Card. Will accept most unicode characters (including emojis--though these may make it difficult to tell a Wild Card from an Extra, because they don't gray out).",
            "descriptiontranslationkey":"set-default-icon-for-wild-card-characters",
            "default":"✪"
        },
        {
            "attribute":"is_npc",
            "displayname":"Extra",
            "displaytranslationkey":"extra",
            "type":"checkbox",
            "value":"1",
            "description":"This option sets new characters to default as Extras, instead of Wild Cards.",
            "descriptiontranslationkey":"extra-config"
        },
        {
            "attribute":"sheet_theme",
            "displayname":"sheet-theme",
            "displaytranslationkey":"sheet-theme",
            "type":"select",
            "options":[
                    "Generic|0",
                    "Deadlands|1",
                    "Pathfinder|2",
                    "Rifts|3"
            ],
            "optiontranslationkeys": [
                "generic",
                "deadlands",
                "pathfinder",
                "rifts"
            ],
            "default":"0",
            "description":"Selecting a sheet theme will set the background image, logo displayed, and any special styling associated with the theme. The theme options are: Generic (the default), Deadlands (an Old West styled theme), Pathfinder (a theme to match the Pathfinder for Savage Worlds books), and Rifts® (a more sci-fi type of theme). Even if a theme is selected, you can still change the packground or logo if desired.",
            "descriptiontranslationkey":"sheet-theme-paragraph"
        },
        {
            "attribute":"dark_mode",
            "displayname":"Dark Mode (inverted colors)",
            "displaytranslationkey":"dark-mode-invert-colors",
            "type":"checkbox",
            "value":"1",
            "description":"This check box will invert the colors of the character sheet, making a quasi-Dark Mode. This only affects the Character Sheet tab of the character journal (Bio & Info, and Atttributes & Abilities are unaffected, unfortunately).",
            "descriptiontranslationkey":"dark-mode-paragraph"
        },
        {
            "attribute":"staticCore",
            "displayname":"Show Core Skills",
            "displaytranslationkey":"show-core-skills",
            "type":"checkbox",
            "value":"1",
            "checked": "checked",
            "description":"Checking this box will show the Five Core skills (Athletics, Common Knowledge, Notice, Persuastion, and Stealth) by default.",
            "descriptiontranslationkey":"show-core-skills-by-default"
        },
        {
            "attribute":"showFightingByDefault",
            "displayname":"Show Fighting by Default",
            "displaytranslationkey":"show-fighting-by-default",
            "type":"checkbox",
            "value":"1",
            "description":"Checking this box will show the Fighting skill by default.",
            "descriptiontranslationkey":"show-fighting-skill-by-default"
        },
        {
            "attribute":"dominion-table",
            "displayname":"Dominion Table Name",
            "displaytranslationkey":"dominion-table-name",
            "type":"text",
            "value":"",
            "description":"This table name is needed for the dominion roll button to function. This should the name of the rollable table for Dominion rolls. This will not set up the rollable table, so you will need to be sure to do that in the game.",
            "descriptiontranslationkey":"setup-the-dominion-table-for-dominion-rolls"
        },
        {
            "attribute":"gritty",
            "displayname":"Setting Rule: Gritty Damage",
            "displaytranslationkey":"setting-rule-gritty-damage",
            "type":"checkbox",
            "value":"{{getgritty=gritty}}",
            "description":"Check this to use the Gritty Damage setting rule. Need to have a rollable table set up for this to work.",
            "descriptiontranslationkey":"use-the-gritty-damage-setting-rule"
        },
        {
            "attribute":"injurytablename",
            "displayname":"Injury Table Name",
            "displaytranslationkey":"injury-table-name",
            "type":"text",
            "value":"",
            "description":"If using the Gritty Damage setting rule, this table name is needed and should the name of the rollable table for the Gritty Damage rolls. You will need to be sure to set this up.",
            "descriptiontranslationkey":"only-need-if-using-gritty-damage-rule"
        },
        {
            "attribute":"moneyfields",
            "displayname":"Number of Money Fields",
            "displaytranslationkey":"number-of-money-fields",
            "type":"select",
            "options":[
                    "1",
                    "2",
                    "3",
                    "4"
                ],
            "default":"1",
            "description":"If there's more than one form of currency AND the wealth system isn't being used, this allows you to show up 4 different currencies.",
            "descriptiontranslationkey":"number-of-money-fields-description"
        },
        {
            "attribute":"moneyname",
            "displayname":"Money Label",
            "displaytranslationkey":"money-label",
            "type":"text",
            "value":"",
            "description":"The label used for tracking money when the Wealth System isn't being used. This could be the name of a currency, if only a single currency is used (e.g. Credits), or the generic term for all currencies (e.g. Money) if more than a single currency is used.",
            "descriptiontranslationkey":"money-label-description"
        },
        {
            "attribute":"moneyonename",
            "displayname":"Currency1 Label",
            "displaytranslationkey":"currency1-label",
            "type":"text",
            "value":"",
            "description":"If more than one currency is used, use this field to label the first currency type (e.g. Gold).",
            "descriptiontranslationkey":"first-currency-label-description"
        },
        {
            "attribute":"moneytwoname",
            "displayname":"Currency2 Label",
            "displaytranslationkey":"currency2-label",
            "type":"text",
            "value":"",
            "description":"If more than one currency is used, use this field to label the second currency type (e.g. Silver).",
            "descriptiontranslationkey":"second-currency-label-description"
        },
        {
            "attribute":"moneythreename",
            "displayname":"Currency3 Label",
            "displaytranslationkey":"currency3-label",
            "type":"text",
            "value":"",
            "description":"If more than one currency is used, use this field to label the third currency type (e.g. Electrum).",
            "descriptiontranslationkey":"third-currency-label-description"
        },
        {
            "attribute":"moneyfourname",
            "displayname":"Currency4 Label",
            "displaytranslationkey":"currency4-label",
            "type":"text",
            "value":"",
            "description":"If more than one currency is used, use this field to label the fourth currency type (e.g. Copper).",
            "descriptiontranslationkey":"fourth-currency-label-description"
        },
        {
            "attribute":"faithname",
            "displayname":"Rename Faith",
            "displaytranslationkey":"rename-faith",
            "type":"text",
            "value":"",
            "description":"Change the name of the Faith skill. This will change the name only, it won't change it's order in the list, etc.",
            "descriptiontranslationkey":"change-skill-name-of-faith"
        },
        {
            "attribute":"focusname",
            "displayname":"Rename Focus",
            "displaytranslationkey":"rename-focus",
            "type":"text",
            "value":"",
            "description":"Rename the name of the Focus skill. This will change the name only, it won't change it's order in the list, etc.",
            "descriptiontranslationkey":"change-skill-name-of-focus"
        },
        {
            "attribute":"performancename",
            "displayname":"Rename Performance",
            "displaytranslationkey":"rename-performance",
            "type":"text",
            "value":"",
            "description":"Rename the name of the Performance skill. This will change the name only, it won't change it's order in the list, etc.",
            "descriptiontranslationkey":"change-skill-name-of-performance"
        },
        {
            "attribute":"psionicsname",
            "displayname":"Rename Psionics",
            "displaytranslationkey":"rename-psionics",
            "type":"text",
            "value":"",
            "description":"Rename the name of the Psionics skill. This will change the name only, it won't change it's order in the list, etc.",
            "descriptiontranslationkey":"change-skill-name-of-psionics"
        },
        {
            "attribute":"spellcastingname",
            "displayname":"Rename Spellcasting",
            "displaytranslationkey":"rename-spellcasting",
            "type":"text",
            "value":"",
            "description":"Rename the name of the Spellcasting skill. This will change the name only, it won't change it's order in the list, etc.",
            "descriptiontranslationkey":"change-skill-name-of-spellcasting"
        },
        {
            "attribute":"weirdsciencename",
            "displayname":"Rename Weird Science",
            "displaytranslationkey":"rename-weird-science",
            "type":"text",
            "value":"",
            "description":"Change the name of the Weird Science skill. This will change the name only, it won't change it's order in the list, etc.",
            "descriptiontranslationkey":"change-skill-name-of-weird-science"
        }
   ]
}

[edit] translation

using translations in the user options:

[edit] See Also


Retrieved from "https://wiki.roll20.net/index.php?title=Default_Sheet_Settings&oldid=33530"