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
m (Add new example)
 
Line 1: Line 1:
 
''Main Page:'' '''[[Building Character Sheets]]'''
 
''Main Page:'' '''[[Building Character Sheets]]'''
 
{{NavSheetDoc}}
 
{{NavSheetDoc}}
'''Default Settings''' for character sheets is an advanced feature available for some [[Character Sheets]] found in the [[Add_character_sheet#Adding_a_Character_Sheet_to_your_Campaign|Sheet Selection Dropdown]].
 
  
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 drowdown 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.
+
This is documentation for how to '''Default Sheet Settings''' are constructed, aimed at [[Sheet Authors|sheet authors]] & creators. For their actual use in your game, see '''[[Game_Settings_Page#Default_Sheet_Settings|Game Settings Page - Default Sheet Settings]]'''.
  
On the {{My Settings}}-tab, there is a '''[[My_Settings#Apply_Default_Settings|My_Settings#Apply Default Settings]]'''-button that the [[GM]] can use to apply the Default Settings to ''existing'' Character Sheets.
 
  
You can test your Default Settings in the [[Custom Sheet Sandbox]] before submitting them to Roll20.
+
'''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]].
 +
 
 +
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.
 +
 
 +
'''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..
 +
 
 +
The [[Sheet_Sandbox#Game_Default_Settings|Sheet Sandbox]] can be used for testing Default Sheet Settings.
 
[[File:Default-Settings-Example.png|400px|thumbnail|right|Some of the Default Settings of [[D&D 5E by Roll20]]]]
 
[[File:Default-Settings-Example.png|400px|thumbnail|right|Some of the Default Settings of [[D&D 5E by Roll20]]]]
  
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#Character_Sheet_Default_Settings|Game Settings]]. An simple example of what can be done with these settings can be found in the {{repo|Roll20/roll20-character-sheets/blob/master/Star%20Trek%20Adventures%20by%20Roll20/sheet.json Star Trek Adventures}}. More complex examples can be found in the {{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}} , or {{repo|roll20-character-sheets/blob/master/Fate%20Core%20v2/sheet.json Fate Core}}.
+
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]].
 
__TOC__
 
__TOC__
 
===Common Usage===
 
===Common Usage===
* Toggle default mode of a sheet between PC/NPC. Example: [[D&D 5E by Roll20]]
+
* Change if new sheets are Player or NPC by default. Example: [[D&D 5E by Roll20]]
* Adjusting default amount of starting gold/credit a new character sheet starts with. Example: [[Star Wars WEG D6 character sheet|Star Wars D6]]
+
** 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.
* Toggle user options, such as turning on/off roll query popups from roll buttons. Example: [[Star Wars WEG D6 character sheet|Star Wars D6]]
+
* 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-drop]]
  
 
==For sheet authors==
 
==For sheet authors==
Line 21: Line 34:
 
===Data fields options===
 
===Data fields options===
  
* '''attribute''' - the name of the sheet variable set with this option. Don't include the <code>attr_</code> prefix in the name.
+
* '''attribute''' - the name of the sheet attribute changed with this option. Don't include the <code>attr_</code> part.
* '''displayname''' - Title element of the selection
+
* '''displayname''' - The short desc. of what the setting does
* '''displaytranslationkey''' - i18n [[Character Sheet Translation|translation key]] for translation into other languages(not mandatory if sheet doesn't use translations)
+
* '''displaytranslationkey''' - i18n [[Character Sheet Translation|translation key]] for translation into other languages(not needed  if sheet doesn't use translations)
* '''type''' - the HTML input element to be used in [[Game Settings Page]]. Options include: <code>select</code>, <code>radio</code>, <code>checkbox</code>, <code>text</code>, <code>number</code>
+
* '''description''' - for giving further detail about the option and the changes it controls. Text is displayed in a smaller font than '''displayname'''
** '''checked''' - If you want a checkbox checked by default, add <code>"checked": "checked",</code> under the attribute
+
* '''descriptiontranslationkey''' - i18n translation key used for the description (not needed  if sheet doesn't use translations)
** '''options''' - If your input element has predefined options, the key/value pairs are listed here
+
* '''type''' - the HTML input element to be used in [[Game Settings Page]]. Options are:
** '''optiontranslationkeys''' - i18n translation keys for the options (not mandatory if sheet doesn't use translations)
+
** <code>text</code>
** '''default''' or '''value''' - the default value of the attribute. If used for a select input with multiple options, set this to the value of the wanted default selection, not incuding the key. Use either ''default'' or ''value''.
+
*** '''value''' - set the default value for the text input
* '''description''' - a text string use to give further detail about the option and the changes it controls
+
** <code>number</code>
* '''descriptiontranslationkey''' - i18n translation key used for the description (not mandatory if sheet doesn't use translations)
+
*** '''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>
  
 
===Testing your <code>sheet.json</code> file===
 
===Testing your <code>sheet.json</code> file===
  
Default Sheet Settings may be tested via the [[Custom Sheet Sandbox]].
+
Default Sheet Settings may be tested via the [[Sheet Sandbox]].
  
 
Every time you want to test out a new [[sheet.json]] file, you have:
 
Every time you want to test out a new [[sheet.json]] file, you have:
Line 43: Line 63:
  
 
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.
 
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 ==
 
== Examples ==
 
Few examples of Default Settings currently in use.
 
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===
 
==={{repo|Roll20/roll20-character-sheets/blob/master/Fate%20Core%20v2/sheet.json Fate Core}} by MagooChris===
Line 235: Line 257:
 
</pre>
 
</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>
 
==See Also==
 
==See Also==
 
* [[Building Character Sheets]]
 
* [[Building Character Sheets]]

Latest revision as of 11:53, 14 May 2021

Main Page: Building Character Sheets

Character Sheet Creation
Getting Started


Reference


Tools & Tips


Git/GitHub GitHubLogo.png


Other

This is documentation for how to Default Sheet Settings are constructed, aimed at sheet authors & creators. For their actual use 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-drop

[edit] For sheet authors

[edit] Data fields options

  • 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

[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.

GitHubLogo.png is a simple example, while GitHubLogo.png & GitHubLogo.png have a ton of settings.

[edit] GitHubLogo.png 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] GitHubLogo.png 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] See Also