Revision as of 08:35, 22 April 2021 (view source) Andreas J. (Talk | contribs) m ← Older edit		Revision as of 20:25, 21 September 2021 (view source) Andreas J. (Talk | contribs) m Newer edit →
Line 1:		Line 1:
−	{{pro only}}	+	{{revdate}}{{pro only}}
−	{{NavSheetDoc}}	+
−	The '''Sheet Editor''' or '''Custom Sheet Editor''' is a {{Pro}} feature, which enables you to use custom code for the character sheet template that is used in your campaign.	+	The '''Sheet Editor''' or '''Custom Sheet Editor''' is a {{Pro}} feature, which enables you to use custom code for the character sheet template that is used in your campaign.{{NavSheetDoc}}
	It can be accessed for a game from the [[Game Settings]]-page, if you change the [[Game_Settings_Page#Character_Sheet_Template|Character Sheet Template]] to '''"Custom"'''.		It can be accessed for a game from the [[Game Settings]]-page, if you change the [[Game_Settings_Page#Character_Sheet_Template|Character Sheet Template]] to '''"Custom"'''.

---

Revision as of 20:25, 21 September 2021

Page Updated:   2021-09-21

This is about a Roll20 feature exclusive to Pro-subscribers (and often to players in a Game created by a Pro-subscriber). If you'd like to use this feature, consider upgrading your account.

The Sheet Editor or Custom Sheet Editor is a ^info feature, which enables you to use custom code for the character sheet template that is used in your campaign.

It can be accessed for a game from the Game Settings-page, if you change the Character Sheet Template to "Custom".

If you intent to test, develop or otherwise work on the character sheet, using Custom Sheet Sandbox for the development is a smart choice, as it's quicker to update. The Sandboxes drawback is that you can't invite other people to it.

Contents 1 Access Sheet Editor 2 Editor Tabs 2.1 HTML Layout 2.2 CSS Styling 2.3 Translation 2.4 Preview 3 Related Pages

Access Sheet Editor

To edit a custom character sheet for an existing game:

1. Go to a Campaign's/Game's Details Page/Main page.
2. Click the Settings-button, and select Games Settings.

3. On the Game settings page, you select "Custom" from the Character Sheet Template menu.

4. If you want to use char sheet code that made prior March 2021, check the box for Legacy Sanitization. If you leave it unchecked, you can use code compatible with the Character Sheet Enhancement Update.

Editor Tabs

The editor (shown above) has four tabs: HTML Layout, CSS Styling, Translation, and Preview.


You copy your HTML and CSS code to their respective pages, and if the sheet have translation files, you copy the content of the appropriate language version. If a translation file ins't provided and the sheet used them, it will show red text and the name of the language tag for each section.

HTML Layout

Here you save the full content of the .html-file for a character sheet. This is the absolute essential part for the sheet to save anything.

CSS Styling

Here you save the full content of the .css-file for a character sheet. If left out, all the styling and visual adjustments is gone, and most sheet would stop working to some degree almost every sheet,except in the rare cases of extremely simplistic character sheets.

Translation

If the sheet contains sheet translation code(i18n attributes) and have an associated translation.json file, it's content would be copied here.

If a sheet need them and they are left out, all/most text on the sheet will appear to indicate missing language tags. If only some words appear , it means the translation.json is missing sections for those attributes.

Preview

Warning: The preview panel does not have all the behavior of an actual roll20 instance. Sheetworkers, repeating sections, and any features that rely on accessing any sheet attribute values will not work correctly in the Preview.

The preview panel updates in real-time whenever you change the HTML, CSS or "Translation" of your sheet, to show you an approximation of what sheet would look like in-game. It's useful for quickly checking superficial change while you're editing, but to be sure of the actual end-result, you need to enter the game and open the sheet itself.

The Preview panel applies all the same security precautions and filtering as the main Roll20 application. Be sure to right-click and Inspect Element if you are seeing strange behavior (e.g. your styles aren't being applied correctly) -- it may be that there is a security filter that is changing the name of a class or something similar.

If you make any changes in the character sheet editor while in the game, you must save your changes and refresh the active Roll20 game. In addition, if the character sheet contains <rolltemplate>, the code for it will be seen unprocessed in the preview window. It's recommended that roll templates are placed at the end of the sheet's code, so they don't obscure the sheet's visuals when using the preview panel.

Related Pages

• Roll20 Sheet Repository - source code of all the community sheets
• Custom Sheet Sandbox The better method for editing/testing custom character sheet code
• Building/Editing Character Sheets - Documentation starting point
  • Common Sheet Mistakes
  • Sheet Author Tips - some more in-depth tips
  • Andreas Guide to Sheet Development