Latest revision as of 13:02, 26 May 2022

Main Article: Building Character Sheets

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

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 computer in order to use this feature, as you're uploading files, not copy-pasting code.

Many Sheet Authors use text editors aimed at coding, like Visual Studio Code, Sublime Text 3 or Notepad++, to edit these files.

Recommended Plugin: Roll20 Autouploader -- browser plugin that can autoupload & update your sheet code in the sheet sandbox, so you don't have to do it manually each time. Can also do same for API scripts.

[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.
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.
- However, browsers(at least Firefox) will remember what folder you uploaded from during this session, so after having uploaded the first time, the menu will open up in the same folder subsequent times, making it quicker to update the sheet in the sandbox than using the Sheet Editor
This is a
Pro
^{^info} subscriber feature only.
See Character Sheet Development/Bugs & Quirks for known issues/bugs

[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 code to update the 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.

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

[edit] Game Default Settings

Customize new pages and tokens to use the settings that best fit your game.

This is a reduced version of what is found on normal games on Game_Settings#Default_Sheet_Settings.

[edit] In-Game Compendium

You can manually select which i Compendium the sheet will use(if any), or let it be defined by the sheet.json.

[edit] Sheet.json Editor

the Sheet.json editor

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

If using Legacy Sheet code, add this to the Sheet.json editor(if you don't have a full Sheet.json):

{
	"legacy": true
}

If using Character Sheet Enhancement(CSE) code, add this to the Sheet.json editor(if you don't have a full Sheet.json):

{
	"legacy": false
}

How the sheet.json for Stargate RPG shows up.

Scroll down to the page and press Save Changes to save the sheet.json, and the page will be updated to show how the Default Settings for it looks like.

The upload menu for sheet code. Found in-game as a floating popup.

[edit] Upload Sheet Code

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

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 the full page.

[edit] API

The Custom Sheet 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 having other players, multiple 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] Video Guide

Roll20 tutorial custom character sheet (Sept 2021)

[edit] Related Pages

app.roll20.net/sheetsandbox (Must be logged in with a
Pro
^{^info} account)
New Pro Feature: Custom Sheet Sandbox^(Blog) - Roll20 Blog Feb 2020
- Custom Sheet Sandbox Release - Thread^(Forum)
Building Character Sheets
- Sheet Editor - How to use custom code in your normal games. It's the less practical alternative to using Sheet Sandbox for sheet development
- Sheet Author Tips
- Andreas Guide to Sheet Development

@@ Line 1: / Line 1: @@
-[[File:Sheet-sandbox-game-oct-2020.png|right|550px|thumbnail|A Sheet Sandbox game showing the character sheet alongside with the Sandbox Tools menu]]''Main Article:'' '''[[Building Character Sheets]]'''
+{{revdate}}{{Pro only|page}}
+''Main Article:'' '''[[Building Character Sheets]]'''
-The '''Custom Sheet Sandbox''' is exactly that-- a trimmed-down "sandbox" for you to test in when [[Building Character Sheets|creating custom sheets]], and is an improvement of the [[Building Character Sheets#The_Sheet_Editor|Custom Sheet Editor]].
+[[File:Sheet-sandbox-game-oct-2020.png|right|550px|thumbnail|A Sheet Sandbox game showing the character sheet alongside with the Sandbox Tools menu]]The '''Custom Sheet Sandbox''' is exactly that -- a trimmed-down "sandbox" for you to test in when [[Building Character Sheets|creating custom sheets]], and is an improvement of the existing [[Sheet Editor|Custom Sheet Editor]] for [[Sheet Author Tips|Sheet Authors]].
-'''Please Note:''' You will need to store your custom sheet <code>HTML</code>, <code>CSS</code>, and <code>translation.json</code>-files to your hard drive in order to use this feature. Many character sheet developers use code editors like [https://notepad-plus-plus.org/ Notepad++], [https://code.visualstudio.com/ Visual Studio Code]) or [https://www.sublimetext.com/ Sublime Text 3] to edit these files.
+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 <code>HTML</code>, <code>CSS</code>, and <code>translation.json</code>-files to your computer in order to use this feature, as you're uploading files, not copy-pasting code.
+Many [[Sheet Authors]] use [[Sheet_Author_Tips#Code_with_a_Proper_Text_Editor|text editors]] aimed at coding, like [https://code.visualstudio.com/ Visual Studio Code], [https://www.sublimetext.com/ Sublime Text 3] or [https://notepad-plus-plus.org/ Notepad++], to edit these files.
+'''Recommended Plugin: [[Roll20 Autouploader]]''' -- [[Browser#Plugins|browser plugin]] that can autoupload & update your sheet code in the sheet sandbox, so you don't have to do it manually each time. Can also do same for API scripts.
+__TOC__
+<br clear=all>
+{{NavSheetDoc}}
 ==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.
+* 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.
+** However, browsers(at least [[Firefox]]) will remember what folder you uploaded from during this session, so after having uploaded the first time, the menu will open up in the same folder subsequent times, making it quicker to update the sheet in the sandbox than using the [[Sheet Editor]]
+* This is a {{Pro}} subscriber feature only.
+* See [[Character Sheet Development/Bugs & Quirks]] for known issues/bugs
-==Benefits over Custom Sheet Editor==
+==Benefits over Normal [[Sheet Editor]]==
-* Faster to update game
+* Faster test iteration
-* Enables testing [[Default Sheet Settings]] in your <code>sheet.json</code> before submitting to Roll20
+* 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 [[Building Character Sheets#The_Sheet_Editor|Custom Sheet Editor]]
+* If using a [[Sheet_Author_Tips#Code_with_a_Proper_Text_Editor|Text Editor]] on your computer to develop the sheet, it removed the constant need from the copy-pasting code to update the [[Sheet Editor]]
 ==Use==
-As a Pro user you will notice a new button called "Custom Sheet Sandbox" at the top of the home page once logged in. Additionally you will see a similar button (shown below) in the "My Games" section.
+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.
-[[File:Custom-Sheet-Sandbox-create-new.png]]
+[[File:Custom-Sheet-Sandbox-create-new.png|Custom-Sheet-Sandbox-create-new.png]]
-Click the Create New Game button. You'll get a new sandbox game.
+Click the '''Create New Game''' button. You'll get a new sandbox game.
 [[File:Cutom-Sheet-Sandbox-new-game.png]]
-You can launch the game right away, or paste in your <code>sheet.json</code>-file if you already have it ready.
+===Game Default Settings===
+Customize new pages and tokens to use the settings that best fit your game.
-[[File:Custom-Sheet-Sandbox-json-editor.png]]
+This is a reduced version of what is found on normal games on [[Game_Settings#Default_Sheet_Settings]].
-Once in the game, you'll see there's a floating box with buttons to upload HTML, CSS, and translation files.
+===In-Game Compendium===
+You can manually select which {{Compendium}} the sheet will use(if any), or let it be defined by the <code>sheet.json</code>.
-[[File:Custom-Sheet-Sandbox-tools.png]]
+===Sheet.json Editor===
+[[File:Custom-Sheet-Sandbox-json-editor.png|thumbnail|right|400px|the Sheet.json editor]]
+You can launch the game right away, or paste in your [[sheet.json]]-file if you already have one for your your sheet.
-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 using [[Legacy Sheet]] code, add this to the Sheet.json editor(if you don't have a full Sheet.json):
+<pre style="overflow:auto;white-space:pre-wrap;" data-language="javascript">
+{
+	"legacy": true
+}
+</pre>
-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.
+If using [[Character Sheet Enhancement|Character Sheet Enhancement(CSE)]] code, add this to the Sheet.json editor(if you don't have a full Sheet.json):
+<pre style="overflow:auto;white-space:pre-wrap;" data-language="javascript">
+{
+	"legacy": false
+}
+</pre>
+<br clear=all>
+[[File:Sheet-sandbox-json-render.png|thumbnail|left|400px|How the sheet.json for [[Stargate RPG]] shows up.]]
+<br><br><br>
+Scroll down to the page and press '''Save Changes''' to save the <code>sheet.json</code>, and the page will be updated to show how the Default Settings for it looks like.
-==API==
+<br clear=all>[[File:Custom-Sheet-Sandbox-tools.png|thumbnail|right|300px|The upload menu for sheet code. Found in-game as a floating popup.]]
-The Custom Game Sandbox does include support for [[API|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.
+==Upload Sheet Code==
+Once in the game, you'll see there's a floating box with buttons to upload HTML, CSS, and [[i18n|translation]] files.
+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 <code>sheet.json</code>-file update, again without reloading the full page.
+<br clear=all>
+==API==
+The Custom Sheet Sandbox does include support for [[API|API scripts]]. Please note, however, that API scripts that interact with elements of the VTT that are disabled (such as having other players, multiple 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.
+<br>
+==Video Guide==
+{{#evp:youtube|UxDQ5oa-Ocs|Roll20 tutorial custom character sheet (Sept 2021)|center|700}}
 =Related Pages=
-* [[Sheet_Editor|Custom Sheet Editor]] the other alternative to using Sheet Sandbox for sheet development
+* '''[https://app.roll20.net/sheetsandbox app.roll20.net/sheetsandbox]''' (Must be logged in with a {{Pro}} account)
-* Sheet Sandbox:
+* {{blog|190896818595/new-pro-feature-custom-sheet-sandbox New Pro Feature: Custom Sheet Sandbox}} - Roll20 Blog Feb 2020
-** [https://app.roll20.net/sheetsandbox Sheet Sandbox page] (Must be logged in with a Pro account)
+** {{fpl|8138452/ Custom Sheet Sandbox Release - Thread}}
-** [https://app.roll20.net/forum/post/8138452/custom-sheet-sandbox-bug-thread/?pageforid=8517939#post-8517939 Custom Sheet Sandbox Bug Thread]
-** [https://blog.roll20.net/post/190896818595/new-pro-feature-custom-sheet-sandbox New Pro Feature: Custom Sheet Sandbox] - Roll20 Blog
 * [[Building Character Sheets]]
+** '''[[Sheet Editor]]''' - How to use custom code in your normal games. It's the less practical alternative to using Sheet Sandbox for sheet development
 ** [[Sheet Author Tips]]
 ** [[Andreas Guide to Sheet Development]]
@@ Line 60: / Line 99: @@
 [[Category:Sheetworker]]
 [[Category:Docs]]
+[[Category:Pro]]
+[[Category:New features in 2020]]

Roll20 Wiki

Navigation

Personal tools

Toolbox

Difference between revisions of "Custom Sheet Sandbox"

From Roll20 Wiki