Roll20 Wiki

Revision as of 20:24, 21 September 2021

Main Page: Building Character Sheets

The sheet.json is a file required for character sheets that are submitted to Roll20. If you're just using a custom sheet in your normal game, you don't need the sheet.json(in fact, you can't even use one).

Character Sheet Development
Getting Started

General

Reference

Tools & Tips

Git/GitHub

Other

These can be tested with the Sheet Sandbox

Default Sheet Settings are optional things saved on the sheet.json.

Creating a sheet.json File

See the instructions on github.com/Roll20/roll20-character-sheets#creating-your-own

Description

Write everything on a single line, and use \n to create line-breaks, and for non-ASCII characters, use html character code to make them display correctly.

(press "edit" to see the sourcecode for the below section)

"description": "Défini si les jets des nouvelles fiches sont public ou privés par défaut."

sourcecode

Example

sheet.json for roll20's kitchensink sheet example, contains all mandatory sections. kitchensink/sheet.json

{
  "html": "kitchensink.html",
  "css": "kitchensink.css",
  "authors": "Roll20 Team (@roll20app)",
  "roll20userid": "1",
  "preview": "kitchensink.png",
  "instructions": "**This is a test**\n\nYou can put Markdown-formatted instructions here for how to use your sheet. Please try to keep it moderately-short (500 characters or less is preferred).",
  "legacy": true
}

You can also use hyperlinks in the description-field.

Stargate-RPG/sheet.json Example:

"legacy": false, as the sheet have been updated to CSE
"useroptions" contains Default Sheet Settings that the GM can change for the game, affecting values & looks of newly created sheets.

{
  "html": "stargate.html",
  "css": "stargate.css",
  "authors": "Andreas J.",
  "roll20userid": "1223200",
  "preview": "stargate_preview.png",
  "instructions": "Official character sheet for the 'Stargate RPG' by Wyvern Gaming.\n\n* [Character Sheet Documentation](https://wiki.roll20.net/Stargate)",
  "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."
    }
  ],
  "legacy": false
}

Optional

Following things can be included to the file, but are not mandatory:

"useroptions" – Default Sheet Settings
"patreon", "tipeee" – sponsor links to sheet authors: Patreon and Tipeee Linking Rules for Community Sheet Contributors
"compendium" – defines which game system's i Compendium is associated with the sheet. See Compendium Integration for more

Related Pages

Sheet Sandbox Where you test the sheet.json
Default Sheet Settings optional feature

@@ Line 1: / Line 1: @@
-''Main Page:'' '''[[Building Character Sheets]]'''
+{{revdate}}''Main Page:'' '''[[Building Character Sheets]]'''
-{{NavSheetDoc}}
 {{stub}}
-The '''<code>sheet.json</code>''' is a file required for character sheets that are submitted to Roll20. If you're just [[Using_Custom_Character_Sheets|using a custom sheet]] in your normal game, you don't need the <code>sheet.json</code>(in fact, you can't even use one).
+The '''<code>sheet.json</code>''' is a file required for character sheets that are submitted to Roll20. If you're just [[Using_Custom_Character_Sheets|using a custom sheet]] in your normal game, you don't need the <code>sheet.json</code>(in fact, you can't even use one).{{NavSheetDoc}}
 These can be tested with the [[Sheet Sandbox]]

Roll20 Wiki

Navigation

Personal tools

Toolbox

Difference between revisions of "Sheet.json"

From Roll20 Wiki