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 6: Line 6:
 
Direct url to the sandbox: '''https://app.roll20.net/sheetsandbox''' ''(great to bookmark 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 <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.
+
'''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.
 
<br>
 
<br>
 
<br>
 
<br>
Line 15: Line 17:
 
Custom Sheet Sandbox games have the following 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 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.
 
* There is no Video or Voice chat in the game.
 
* You can only have 15 Custom Sheet Sandboxes at any given time.
 
* 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.
 
* 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.
  
==Benefits over Normal Sheet Editor==
+
==Benefits over Normal [[Sheet Editor]]==
  
 
* Faster test iteration
 
* Faster test iteration
 
* Enables testing [[Default Sheet Settings]] of your <code>sheet.json</code> before submitting to Roll20
 
* Enables testing [[Default Sheet Settings]] of your <code>sheet.json</code> 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==
 
==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.
 
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.
Line 37: Line 40:
 
[[File:Cutom-Sheet-Sandbox-new-game.png]]
 
[[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.
+
You can launch the game right away, or paste in your <code>sheet.json</code>-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):
 +
<pre style="overflow:auto;white-space:pre-wrap;" data-language="javascript">
 +
{
 +
"legacy": true
 +
}
 +
</pre>
 +
 
 +
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>
 +
 
  
[[File:Custom-Sheet-Sandbox-json-editor.png]]
+
[[File:Custom-Sheet-Sandbox-json-editor.png|thumbnail|500px|the Sheet.json editor]]
  
 
Once in the game, you'll see there's a floating box with buttons to upload HTML, CSS, and translation files.
 
Once in the game, you'll see there's a floating box with buttons to upload HTML, CSS, and translation files.
Line 47: Line 65:
 
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.
 
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.
+
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.
  
 
==API==
 
==API==
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.
+
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 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.
  
 
=Related Pages=
 
=Related Pages=
 
* [[Sheet_Editor|Custom Sheet Editor]] is the less practical alternative to using Sheet Sandbox for sheet development
 
* [[Sheet_Editor|Custom Sheet Editor]] is the less practical alternative to using Sheet Sandbox for sheet development
 
* Sheet Sandbox:
 
* Sheet Sandbox:
** [https://app.roll20.net/sheetsandbox Sheet Sandbox page] (Must be logged in with a Pro account)
+
** '''[https://app.roll20.net/sheetsandbox app.roll20.net/sheetsandbox]''' (Must be logged in with a {{Pro}} account)
 
** [https://app.roll20.net/forum/post/8138452/custom-sheet-sandbox-bug-thread/?pageforid=8517939#post-8517939 Custom Sheet Sandbox Bug 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
+
** {{blog|190896818595/new-pro-feature-custom-sheet-sandbox New Pro Feature: Custom Sheet Sandbox}} - Roll20 Blog
 
* [[Building Character Sheets]]
 
* [[Building Character Sheets]]
 
** [[Sheet Author Tips]]
 
** [[Sheet Author Tips]]

Revision as of 16:04, 24 April 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 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.


Character Sheet Creation
Getting Started


Reference


Tools & Tips


Git/GitHub GitHubLogo.png


Other

Contents

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.

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

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 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
}


the Sheet.json editor

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

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

Related Pages