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 "Custom Sheet Sandbox"

From Roll20 Wiki

Jump to: navigation, search
m
m
 
Line 64: Line 64:
 
[[Category:Sheetworker]]
 
[[Category:Sheetworker]]
 
[[Category:Docs]]
 
[[Category:Docs]]
 +
[[Category:Pro]]

Latest revision as of 14:00, 5 February 2021

A Sheet Sandbox game showing the character sheet alongside with the Sandbox Tools menu

Main Article: Building Character Sheets

The Custom Sheet Sandbox is exactly that -- a trimmed-down "sandbox" for you to test in when creating custom sheets, and is an improvement of the existing Custom Sheet Editor for Sheet Authors.

Direct url to the sandbox: https://app.roll20.net/sheetsandbox (great to bookmark for sheet authors)

Please Note: You will need to store your custom sheet HTML, CSS, and translation.json-files to your hard drive in order to use this feature. Many character sheet developers use code editors like Notepad++, Visual Studio Code) or Sublime Text 3 to edit these files.

Contents

Character Sheet Creation
Getting Started


Reference


Tools


Git/GitHub GitHubLogo.png


Other

[edit] Limitations

Custom Sheet Sandbox games have the following limitations:

  • You are the only player who can access the sandbox. You can't invite others into your sandbox game.
  • There is only one page in the game, and there is no way to create additional pages.
  • There is no Video or Voice chat in the game.
  • You can only have 15 Custom Sheet Sandboxes at any given time.
  • This is a Pro subscriber feature only.
  • The sandbox cannot be made to remember the location of your file or working folder; that's a security limitation on your web browser, and not something Roll20 can change.

[edit] Benefits over Normal Sheet Editor

  • Faster test iteration
  • Enables testing Default Sheet Settings of your sheet.json before submitting to Roll20
  • If using a Text Editor on your computer to develop the sheet, it removed the constant need from the copy-pasting to update the Custom Sheet Editor

[edit] Use

As a Pro user, you will notice a new button called "Custom Sheet Sandbox" at the top of your Homepage when you log in. A similar button (shown below) appears in the My Games-section.

Custom-Sheet-Sandbox-create-new.png

Click the Create New Game button. You'll get a new sandbox game.

Cutom-Sheet-Sandbox-new-game.png

You can launch the game right away, or paste in your sheet.json-file if you already have it ready.

Custom-Sheet-Sandbox-json-editor.png

Once in the game, you'll see there's a floating box with buttons to upload HTML, CSS, and translation files.

Custom-Sheet-Sandbox-tools.png

Clicking any of these opens a dialog box to upload the relevant file from your hard drive. As soon as the file finishes uploading, all characters in the game will be updated to the new source file. You no longer need to reload the whole VTT to see changes.

If you have your game settings page open in a second browser window, you can upload a new sheet.json file in that window and, from inside the VTT, you can click "Reload Sheet Default Settings" to have that sheet.json file update, again without reloading.

[edit] API

The Custom Game Sandbox does include support for API scripts. Please note, however, that API scripts that interact with elements of the VTT that are disabled (such as other players, pages, etc.) won't work in these games. However, there is an API sandbox for the game, so you can test out sheet-affecting APIs before using or releasing your sheet.

[edit] Related Pages