Latest revision as of 18:54, 17 June 2023

Page Updated:   2023-06-17

This is related to Editing(coding) Character Sheets, which require Pro info to be able to use. Main Page: Building Character Sheets

This article is a stub. You can help the Roll20 Community Wiki by expanding it.

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

These can be tested with the Sheet Sandbox

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

[edit] Creating a sheet.json File

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

[edit] instructions

• the instructions field is written with markdown
• Write everything on a single line, and use \n to create line-breaks
• to write bullet points, place an extra \n if previous row isn't a bullet point
• non-ASCII characters: use html character code to make them display correctly. E.g. é, not é
  • HTML Character Encoder
  • also works for UTF8 symbols: E.g. ♒ or ♒ = ♒
• Test result in Sheet Sandbox

Example:

"instructions": "Feuille de Personnage pour [Chroniques Oubliées Contemporain](http://www.black-book-editions.fr/produit.php?id=4349). Chroniques Oubliées Contemporain est le dérivé de Chroniques Oubliées Fantasy adapté pour jouer dans la période 1900-2100. Il permet de jouer des aventures du genre espionnage, commando militaire, enquêtes policières occultes, vampires contre garous, mutants, super-héros, épouvante, pulp, apocalypse zombie, cyberpunk, et plus.\n\n* Version 3.9.2 (27/04/2021)\n* [Lisez-moi](https://github.com/Roll20/roll20-character-sheets/blob/master/ChroniquesOublieesContemporain/README.md)",

[edit] Optional

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

• "useroptions" – Default Sheet Settings
• "printable": true - add if the sheet have been updated to be print-friendly. See Character Sheet Development/Print-Friendly for more
• "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
• "roll20userID" - identifies the Roll20 user by userID (found in the address bar when you view your profile). This allows the Roll20 system to give the "Sheet Author" badge to your profile. Separate multiple authors with commas.

[edit] translation

If your sheet uses translations, you can also use them in your sheet.json for Default Sheet Settings.

• Old D&D 5E by Roll20 - sheet.json

[edit] sheet.json Examples

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
}

[edit] Related Pages

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

[edit] See Also

• Publishing Sheets to GitHub - blogpost by GiGs