Roll20 Wiki

{{revdate}}{{BCS|page}}
== Overview ==
{{NavSheetDoc}}
This is the main article on how to '''create''' or '''edit Custom Character Sheet''' for Roll20. You need to be a [[Pro]]-user to access this feature.

It lists and describes many of the common elements of [[Character Sheet|character sheet]] and how they function. Most larger concepts have a separate page that goes into larger detail which is linked here, such as the pages for [[Button|Buttons]], [[Designing Character Sheet Layout]] or [[Sheetworkers]]. The page is maintained/updated mostly by Roll20 community members.

The '''guide assumes some basic familiarity with [[wikipedia:HTML|HTML]] & [[wikipedia:CSS|CSS]]''', so using other resources to learn the basics for those is advised. The [[Building_Character_Sheets#Guides|Guides]]-sections have some links to tutorials & resource on HTML, CSS, and JavaScript in general..

{{cleanup-msg|The page haven't completely been updated to account for [[CSE]], and assumes use of [[Legacy Sheet]], unless otherwise specified(but should be fine for most cases).|July 2021}} 
__TOC__

==[[Using Custom Character Sheets]]==
''Main Article:'' '''[[Using Custom Character Sheets]]'''

There are two methods of using Custom Character Sheets, The "[[Sheet Editor|The Sheet Editor]]", and the "[[Custom Sheet Sandbox|Sheet Sandbox]]".

The former is accessed and used in campaign where the character sheet option have been set to "Custom" in the [[Game_Settings_Page#Character_Sheet_Template|Game Settings]] page, and the latter is a tool used for character sheet development, where you upload (or literally cut and paste, the built-in editor is very basic) your code as files. Either one can only be accessed by the [[GM#Creator|Creator]] of the game.

The source code to all community-created Roll20 sheets can be found on {{repo|Roll20/roll20-character-sheets Github}}.

===Get Started===
What you need to get started with Sheet Editing/Creation
* '''Access to a {{pro}} account''' (to be able to test the sheet code in Roll20)
** '''Ideally, get Pro for yourself''', so you can use the [[Custom Sheet Sandbox|Sheet Sandbox]](much better for testing)
** Alternatively, have someone with Pro host a Test game for you. ''The host would need to manually update the game's sheet code through the [[Sheet Editor]], which is really cumbersome.''
* online [[#Guides|html/css reference guides and tutorials]]
* '''[[Sheet_Author_Tips#Code_with_a_Proper_Text_Editor|A good text editor]]''' e.g. [https://code.visualstudio.com/ VSCode], [https://notepad-plus-plus.org/ Notepad++]
* plenty of patience/free time
* plenty of coffee
* maybe a second monitor


If all you want to do is create a custom character sheet for use amongst your friends, you don't need to create a [[github]] account, learn how to submit code nor collaborate with others. 

Only sign up to github once you have spent the hard time inside the sandbox writing/debugging your HTML and CSS code so it displays perfectly inside a Roll20 game, then its a matter of [[github|submitting your sheet via github]] if you want to make it widely available.

==General==
Character sheets for Roll20 are created with [[wikipedia:HTML|HTML]] & [[wikipedia:CSS|CSS]],(and for more advanced features using [[Sheetworkers]], a limited amount of [[JavaScript]]). Roll20 uses a number of  changes to normal html/css, so they cannot properly be tested outside Roll20 in general web-dev environments such as Codepen or JSFiddle, and must be examined inside a game.

Plain HTML/CSS code taken from elsewhere do not work right away, as there exists a number of Roll20-specific feature and definitions that need to be used to make this work. There are also a good number of known [[#Restrictions|Restrictions]] that limits what features of HMTL/CSS/JavaScript can be used. Converting character sheets from sources such as pdfs is not possible either, and sheets must be manually created, either from scratch, or based on {{repo|Roll20/roll20-character-sheets existing Roll20 sheets}}.

In general, a Roll20 character sheet consists of an HTML-file, and a CSS-file. Some more advanced sheets also have a [[i18n|translation file]].

Check '''[[BCS/Updates]]''' for latest updates & changes to the sheet creation framework, and '''[[BCS/Bugs]]''' for known bugs and issues.

===Sheet Structure===
A general description of how the code for a character sheet is structured:

'''The HTML file/code:'''
* Contains no <code><body></code> or similar starting elements. (The html of a sheet is actually a part of a large <code><form></code>, which itself is inside an [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe iframe].)
* The HTML will automatically refer to the CSS code and classes, so no <code><include></code> or other standard steps to refer to css files or other sources can be used.
* Any [[#Storing User Data|user-edited data]] in sheets are usually stored in <code><input></code>-elements or similar, and these elements must always have a <code>name</code>-attribute that starts with <code>attr_</code> for them to be properly saved.
* ''([[LCS]] only)'' When referring to a CSS class from the CSS file, the <code>sheet-</code>-prefix in the class' name is not needed.
* Any JavaScript/Sheetworkers must be included in the html file in a separate <code><script type="text/worker"></code>-element at the end, sheets don't support JavaScript outside that element.
* [[Roll Templates]] are also defined inside the HTML file.
<br>

'''The [[#CSS|CSS]] file/code:'''
* In the CSS file, all class-names must have a <code>sheet-</code>-prefix in their name, or Roll20 won't recognize the classes. In the HTML file, this prefix is not needed.

'''(Optional) [[i18n|Translation]] file:'''
* The translation file is a <code>.json</code>-file, that includes the each i18n language, and pairs it with the corresponding content that should be displayed for the tag.

== Complete Example ==
''Main:'' '''[[Character Sheet Development/Complete Examples‎|Complete Examples‎]]'''

On '''[[Character Sheet Development/Complete Examples‎|Complete Examples]]''', there are a selected list of complete, working character sheets, which could be insightful to look at to get a general idea what goes into a sheet, and how some common things are implemented. These are fairly well structured & implemented sheets on the shorter side, making them more approachable than any randomly picked sheet from the repo's 1000+ sheets.

'''[[Character Sheet Development/Sheet Templates|Sheet Templates]]''' are intended as generic starting points for people learning to create their own character sheets, rather than using [https://github.com/Roll20/roll20-character-sheets existing sheets] with all the baggage they come with. Most of these templates are barebones. 

'''[[Character Sheet Development/Pattern Libraries|Pattern Libraries]]''' contains various snippets useful for creating/updating any sheet.

==Restrictions==
{{main|Character Sheet Development/Restrictions}}
{{:Character Sheet Development/Restrictions}}

==Common Mistakes==
''main page:'' '''[[Common Mistakes - Sheet Development]]'''

A list of common mistakes by old and new [[Sheet Author|sheet creators]].

'''1.''' '''Forgetting to start attribute names with <code>attr_</code>''' (e.g. <code><input type="number" name="attr_dexterity"></code> vs. <code><input type="number" name="dexterity"></code>). To [[Building_Character_Sheets#Storing_User_Data|store any information]] on a character sheet, this prefix is needed in the name. If it is left out, no data being saved in the field after the sheet is closed.

'''2.''' '''Thinking the [[Building_Character_Sheets#Preview_Panel| Preview Panel]] shows all the changes/is accurate.''' The preview panel does '''not''' show an accurate view of how the sheet will look/work in an actual game, '''and completely ignores sheetworkers'''. You need to login to the campaign and open a character sheet there to be sure of sheet visuals/functionality, or use the [[Custom Sheet Sandbox|Sheet Sandbox]].

'''3.''' '''Check/Uncheck "[[Legacy Sheet|Legacy Sanitization]]" when using custom code.''' Depending on if you have sheet code formatted for [[LCS|Legacy sheets]] or [[CSE]], you need to check the box found in the [[Sheet Editor]], or when using [[Sheet Sandbox]], update the [[Custom_Sheet_Sandbox#Sheet.json_Editor|sheet.json]]-section.

'''4.''' ([[Legacy Sheet]] only)'''Forgetting to add <code>sheet-</code> to the class names in your <code>.css</code> file.''' This is not need in the <code>.html</code> file, Roll20 automatically assumes all classes have that prefix there. (Doesn't apply to [[CSE]] sheets) See [[Building Character Sheets#CSS Styling|CSS Styling]]

'''5.''' '''Using an underscore in the name/class of [[Building_Character_Sheets#Repeating_Sections|repeating sections]].''' Each <code><fieldset></code> needs to have unique classname that starts with <code>repeating_</code>, and the rest of the name cannot have underscores or the section won't save any information.

'''6.''' '''CSS: Not understanding how [https://developer.mozilla.org/en-US/docs/Web/CSS/General_sibling_combinator General Sibling Selector] <code>~</code> works, and how it applies in making tabs/hideable areas on the sheet.''' The [[CSS_Wizardry#Show.2FHide_Areas|CSS Wizardry]] examples on show/hide areas & creating tabs relies on the correct positioning of elements, and if the html elements are thrown in a different order or withing other elements, the conditions aren't met for things to trigger.

'''7.''' '''Not using a [[Sheet_Author_Tips#Code_Validation|linter/code validator]] on your HTML/CSS/Sheetworker/Translation files.''' Often with HTML/CSS things can seemingly work fine for a long time even when you have mistakes, and cause trouble way later. Running your Sheetworker's code through a [https://closure-compiler.appspot.com/home JavaScript validator] is a critical step to finding why it might not work. Checking any <code>translation.json</code> or [[sheet.json]] files is also important.

'''8.''' '''Google Fonts''' Follow the Roll20 guide to the letter, and don't use urls generated by google, you need the remove the "2" from the url, among things. [[#Google_Fonts|Google Fonts on Roll20 Sheets]]

'''9.''' '''Do not submit a new sheet that uses <code><nowiki><table></nowiki></code> for layout.''' It's the most common reason for new sheets being rejected/delayed, [[Designing Character Sheet Layout|use better methods for layout]] instead. There are old sheets in the repo using them, but they were created before this rule against <code><nowiki><table></nowiki></code> was made.

::::::'''General coding mistakes''' <sub>''(not directly related to how Roll20 code works)''</sub>

'''[[Common_Mistakes_-_Sheet_Development#G-1|G-1.]]''' '''Not reading the Roll20 documentation.''' Roll20 sheet code isn't straight up just regular HTML/CSS/JavaScript, but has a number of differences. Much of the quirks & basics related to Character Sheet Creation is documented/linked on this page, and the docs are regularly getting updated. It's always a good idea to check pages again, even if you read them in the past. '''[[BCS/Updates]]''' & '''[[BCS/Bugs]]''' are good to keep updated on recent things. List of [[:Category:Character Sheet Creation|all pages related to "Character Sheet Creation"]]

'''[[Common_Mistakes_-_Sheet_Development#G-2|G-2.]]''' '''Not looking at existing sheets.''' Seeing how existing sheets have been made  and structured can help you avoid reinventing the wheel or making mistakes  as result of knowing HTML/CSS/JavaScript but having little familiarity with how character sheets are created. All sheets in the {{repo|Roll20/roll20-character-sheets Character sheet repository}} are under MIT license so are free(and encouraged) to be used as templates for creating your own sheet, instead of making everything from scratch.<br><br>

'''[[Common_Mistakes_-_Sheet_Development#G-1|G-3.]]''' '''Not asking for help when you get stuck.''' Roll20 has a small but active community who works with creating and improving character sheets, and are often eager to help out if you got stuck on some feature you've tried to figure out. {{forum|category/277980 Roll20 Character Sheet & Compendium Forums}}

==HTML==
{{main|Character Sheet Development/HTML}}
{{:Character Sheet Development/HTML}}

== CSS ==
''Main Article:'' '''[[CSS Wizardry]]'''

You can & should use custom CSS to style the way that your sheet looks to players. You can use nearly any CSS styling that you want, including background images, colors, font sizes, [[CSS_Wizardry#Tabs|tabs]], etc.

'''CSS Quirks in Roll20:'''

* On a Legacy sheet, all class-names in the CSS file must have a <code>sheet-</code>-prefix in their name, or Roll20 won't recognize the classes. In the HTML file, this prefix is not needed. This is no longer a requirement in CSE.
* All of your CSS styles will be restricted to the <code>.charsheet</code> parent class. So if you put a style called <code>input</code>, the system will automatically prefix that with <code>.charsheet input</code>. This shouldn't affect you in general, but it prevents you from changing any of the Roll20 application CSS outside of the character sheets.
* Note that by default, any HTML classes defined in your HTML layout which don't begin with <code>attr_</code>, <code>roll_</code> or <code>repeating_</code> will be prefixed with <code>sheet-</code> on Legacy sheets. So for example, if you want to style some of your input tags to be shorter than others and you define the HTML as <code><input class='shortfield'></code>, when processing your layout it will be changed to <code><input class='sheet-shortfield'></code>.
<br>
''See Also:'' [[Building_Character_Sheets#Sheet_Templates.2FExamples| Character Sheet templates]]

=== Tabs ===
''Main Article:'' '''[[CSS_Wizardry#Tabs|Tabs on character sheets]]'''

Many character sheets have multiple pages, which many organize into separate tabs on Roll20 character sheets. The CSS Wizardry page show two methods used by existing sheets.

Can be used for creating an "NPC" page, or to split up character sheet content on several pages it it gets too big.

=== Roll20 columns/rows ===
''Main Article:'' '''[[Designing_Character_Sheet_Layout#Roll20_columns.2Frows | Roll20 columns/rows]]'''

Roll20 provides a few basic classes you can use to organize things into a simple column-based layout. To use them, just create a div with a class of '3colrow', '2colrow', or 'row'. Then inside of that div, create a div for each column with a class of 'col'.

=== Google Fonts ===
Full guide: [[CSS_Wizardry#Google_Fonts|Sheet Styling: Google Fonts]]

You can use [https://fonts.google.com/ Google Fonts] on your sheets.
{{ex}}
<pre data-language="css" style="overflow:auto;white-space:pre-wrap;">
// imports the "Sigmar One"
@import url('https://fonts.googleapis.com/css?family=Sigmar+One&display=swap');

.charsheet span{
    // sets all spans to use "Sigmar One" font.
    font-family: 'Sigmar One', Arial;
   //  sets "Arial"(one of the default fonts) as a fallback font, if Sigmar-font doesn't work
}
</pre>

'''NOTE:''' Do '''NOT''' use any fonts that contain '''<code>eval</code>''' in the name (e.g. <code>MedievalSharp</code>). That string (even when in the middle of a font name) causes security issues with Roll20 and the CSS will get thrown out completely.

==[[JavaScript]]==
JavaScript can be utilized in two very limited ways for Roll20 Character sheets, through built in [[Sheet Worker Scripts|sheet workers]] that are defined inside a single <code><nowiki><script type="text/worker"></nowiki></code>-element, or indirectly through the use of [[API]] scripts(requires Pro subscription).

Roll20 sheetworkers & API can make use of the <code>Underscore.js</code>-library.

===Sheet Workers Scripts===
''Main Article:'' '''[[Sheet Worker Scripts]]'''

'''Sheet Worker Scripts''', (aka. '''Sheetworkers'''), are an advanced feature of the [[Character Sheets]] system which allows the sheet author to specify [[JavaScript]], which will execute during certain events, such as whenever the values on a sheet are modified. It is highly recommended to use these in place of [[Auto-Calc|Auto-Calculating Fields]] whenever you have values that infrequently change, such as when a Character levels up or adds a new spell or attack.

Broadly speaking, sheetworkers can only edit character sheet values, and not interact with DOM in any other way. It can listen in and react to attributes changing values or activate on an [[Button#Action_Button|Action Button]].

'''Example'''({{repo|Roll20/roll20-character-sheets/tree/master/Ambition_Avarice Ambition & Avarice}}):
<pre data-language="html" style="overflow:auto;white-space:pre-wrap;">
<script type="text/worker">
const int = score => parseInt(score, 10) || 0;

const stats = ["str", "dex", "con", "wis", "int", "cha"];
stats.forEach(stat => {
    on(`change:${stat}`, () => {
        getAttrs([stat], values => {
            const stat_base = int(values[stat]);
            //console.log(stat_base);
            let stat_mod = 0;
            if (stat_base >= 19) stat_mod = "+4";
            else if (stat_base >= 18) stat_mod = "+3";
            else if (stat_base >= 16) stat_mod = "+2";
            else if (stat_base >= 14) stat_mod = "+1";
            else if (stat_base >= 12) stat_mod = "+0";
            else if (stat_base >= 8) stat_mod = "-1";
            else if (stat_base >= 6) stat_mod = "-2";
            else stat_mod = "-3";
            
            setAttrs({
                [`${stat}_mod`]: stat_mod
            });
        });
    });
});
</script>
</pre>

The above sheetworker automatically checks & updates an Attribute's(Str, Dex, Con etc.) modifier, any time the Attributes changes values. This makes it easy for the player as they don't need to update both the attribute & it's modifier, just the attribute, and the sheetworker does the rest. So if the <code>str</code> attribute is changed to <code>6</code>, <code>str_mod</code> is set to be <code>-2</code>.

===[[API]]===
[[API|API scripts]] are something that are installed into campaign separately, which can do much more powerful and versatile things than the sheetworkers.

These are very advanced things, and to be able to use APIs with a sheet in a game, the Game Creator need to be a Pro subscriber to have access to them, so generally sheets shouldn't be designed to require API to work.

API Scripts can check to make sure that rules are followed, change properties on objects and tokens, and even provide custom chat commands. The scripts you write run across the entire game, and affect things the [[GM]] does as well as all the [[players]]. Advanced scripts can also run independently, performing automatic actions such as moving a token on a patrol route or nudging players when their turn is taking too long.

Examples of API use with character sheets:
* '''Creating complicated or conditional roll output that the normal macro system can't handle, or to roll dice that aren't normal/numerical ones.''' Example: To roll Fantasy Flight Games' dice for their Star Wars or Genesys game, you need to use an API, as they use a unique dice system.
* '''Editing stats based on rolls''' Normal macros can only read stats form character sheets, but APIs can edit them. Example: you can integrate API like [[Script:ChatSetAttr]] into buttons rolls to automatically heal characters when heath rolls are made, or to automatically subtract ammo/spellslots/arrows when they are used, or to apply the damage done on a roll directly to some other character
* '''Reading/Syncing/Editing attributes between character sheets''' Sheetworkers can only edit and read stats of the character they are tied to, while API can look & edit stats for any character, enabling connections that otherwise aren't possible. Example: A sheet for the party's ship could sync/read some attribute of the party members and save them on the ship in relevant places so for example ship manuvers made by the captain could be done from the ship sheet, as an API have read the captain's stats and copied them to the captain's section. Then the same have been done for the Gunner, which would make it possible to make all the ship-related rolls that rely on character stats from the ship sheet as it syncs the relevant things with the party members.

==Advanced Sheet Options==
The following '''Advanced Sheet Options & Guides''' are not required for a basic character sheet, but can be great for enhancing your sheet's capability and usability. These things use more than one type code (HTML/CSS/JavaScript) so are not goruped under the core and basic [[#HTML|HTML]], [[#CSS|CSS]] and [[#JavaScript|JavaScript]] sections previously mentioned on this page.

''See Also:'' '''[[Sheet Author Tips]]'''

===Sheet Layout===
''Main Article:'' '''[[Designing Character Sheet Layout]]'''

Many sheet authors recommend using your own CSS for styling and layout of the sheet, mostly either [[Designing_Character_Sheet_Layout#CSS_Grid|CSS Grid]] or [[Designing_Character_Sheet_Layout#CSS_Flexbox|Flexbox]]. Roll20 provides a few basic classes you can use to organize things into a simple column-based layout.

There are also ways to have a character sheet have several pages, two examples on how to implement can be seen in the [[CSS_Wizardry#Tabs|Tabs]]-section of the CSS Wizardry-article.

===Roll Templates===
''Main Article:'' '''[[Roll_Templates#Creating_a_Roll_Template|Roll Templates]]'''

Roll Templates allow you to fully customize how the rolls from your sheet appear in the chat window to all players. It's a great way to make the rolls in the chat better fit with the looks of the character sheet itself, as well as making the roll results be shown in more varied ways than just using <code>/roll</code> commands or the [[Roll_Templates#Default|default roll template]].

===Translating Character Sheets===
{{main|Character Sheet Translation}}

Character sheets can be adapted to have translation capabilities, which makes it possible for everyone help translate the sheet to other languages, with the help of [[CrowdIn]], if the sheet have the necessary translation tags. Character sheet authors have a number of controls over how the sheet is translated, and how the translation is displayed, even changing list order depending on language. 

To update Translations for Community- or offical sheets on CrowdIn, you only need to register and account and join the projects, but to help translate the main site, you need to [https://help.roll20.net/hc/en-us/requests/new?ticket_form_id=1500000457501 send it a ticket].

===Default Sheet Settings===
''Main Article:'' '''[[Default Sheet Settings| Default Sheet Settings]]'''

Selectable options can be specified in the <code>sheet.json</code> file provided with your Custom Character Sheet. These options provide default settings across all Characters when your Character Sheet is in use. These are only usable if the sheet is in the sheet dropdown menu, as there are currently no method of using sheet.json with a Custom Character Sheet in the Sheet Editor

These can then be applied on the [[Game_Settings_Page|Game Settings]]-page to apply for character sheets created after the Default Settings are changed(Only accessible to the Game's Creator), or update all existing sheets in a campaign on the <span style="font-family:Pictos;">y</span>[[My Settings]]-tab(available for any [[Gamemaster]] in the campaign).

===Compendium Integration===
''Main Article:'' '''[[Compendium Integration]]'''

The [https://app.roll20.net/compendium Roll20 Compendium] feature is a repository of information such as rules, spells, items, and monsters for select open-license gaming systems. By designating that your sheet is compatible with a Compendium, players will have direct access to that Compendium in the right sidebar during gameplay.

Other advanced options for Compendium Integration includes [[Compendium_Integration#Enabling_Drag-and-Drop_Functionality_for_Your_Sheet|drag-and-drop]] & [[Compendium_Integration#Compendium_Buttons|compendium buttons]].

===Charactermancer===
''Main Article:'' '''[[Charactermancer Development Documentation|Charactermancer Development]]'''

The Charactermancer is Roll20 system for guiding a user through a decision making process on the Virtual Tabletop. It has been implemented in the [[D&D 5E by Roll20]], [[Pathfinder Character Sheet|Official Roll20 Pathfinder 1E]], [[Burn Bryte]], and [[Call of Cthulhu]] character sheets, with plans for [[PF2E|Pathfinder Second Edition]] & [[Starfinder]].

'''Note:''' Community sheets should not include character creation or advancement [[Building_Character_Sheets#1._Code_of_Conduct.|due to potential copyright restrictions]]. 'By Roll20' sheets may include this content thanks to our partnerships with game creators. Sheets that are developed from the code of a 'By Roll20' sheet will need to ensure any character creation or advancement options code is removed. It's okay to have attributes that auto-calculate based on other attributes (including the current level). We'll let you know if your submitted sheet violates this rule.

However, the Charactermancer framework could also be used for other purposes, such as creating a character sheet importer framework.
* {{forum|Roll20/roll20-character-sheets/blob/fdae6c0b2d19dd84a753d1c051f27380de8efb03/Shadowrun5thEdition/Shadowrun5thEdition.html#L4401 Shadowrun 5E sheet}} uses Charamancer for character import
* {{forum|post/8100886/what-is-the-simplest-charactermancer-anybody-has-made-for-a-custom-sheet Simplest Charamancer use}} - thread discussing how simple implementations

===Other===
Additional advanced sheet features & ideas:

* [[Character Sheet Development/Print-Friendly|Make sheets Print-Friendly]] - if you want your roll20 sheet to be easy to print out for offline play
* [[Sheet_Author_Tips#Changelog_and_Update_Notification_inside_Sheet|Integrated Sheet Update Notification & Changelog]]
** so users easily notice & read sheet updates when looking at their  sheet in-game
* [[CSE#Mobile|Mobile-friendly]] - optimize sheet for use with the [[Mobile]] app
* [[CSE#Responsive_Design|Dark Mode]]
* [[Sheet Author Tips#Statblock Importer|Statblock Importer]]
* [[Sheet Author Tips#GM Screen|GM Screen]]

==Roll20 Character Sheets Repository==

The {{repo|Roll20/roll20-character-sheets Roll20 sheet repository}} is a collection of all the community-contributed character sheets that are available for use on Roll20.  Its intended purpose is to provide fans a way of creating system-specific support of games that Roll20 doesn't have an official character sheet for.

Source code of many official character sheets exists in the repository, but they are no longer updated. This is due to Roll20 having changed their workflow to keep their own sheets in a separate (private) repository. A number of older sheets (that don't show up in Roll20's sheet selection dropdown) also exist in the repository.

See [[Beginner's Guide to GitHub]] and/or [[Short Git Guide]] for how to use Git/GitHub for submitting your sheets to Roll20, or making updates for existing ones.

===Minimum Requirements===
{{hc|articles/360037773453-Minimum-Requirements-Best-Practices "Minimum Requirements"}}

To ensure a consistent quality of character sheets in the repository, all submissions '''must''' meet the minimum requirements below. Before submitting a pull request on GitHub, test your code in Roll20 using either the [[Sheet Editor]] or [[Sheet Sandbox]].

'''Ideally, don't submit sheets for games that already has a sheet.''' Preferably seek to improve the existing sheet.

:''"There will ideally be a single character sheet in the repository for any given game. And we allow a duplicate sheet if it is created and maintained by the Publisher [...] However, like any simple rule, there are some grey areas around what constitutes a "game"."'' {{source|https://app.roll20.net/forum/permalink/10375799/ Sept. 2021}} - Nic B., Roll20 Team

====1. Code of Conduct.====

* The [[Terms_of_Service_and_Privacy_Policy#Play_Nice_Clauses|Roll20's Code of Conduct]] applies to character sheets and they must adhere to it.

* '''Do not infringe on intellectual property'''. Community sheets should not include character creation or advancement due to potential copyright restrictions. 'By Roll20' sheets may include this content thanks to our partnerships with game creators. Publisher-created/backed sheets are obvious free to include whatever they want. Sheets that are developed from the code of a 'By Roll20' sheet will need to ensure any character creation or advancement options code is removed. It's okay to have attributes that auto-calculate based on other attributes (including the current level). We'll let you know if your submitted sheet violates this rule.

* There is one specific requirement for Character Sheets. All submissions of new pull requests for '''any character sheet containing an area for “gender” will need to make that a open text input (as opposed to a drop down menu containing a predefined list of options)'''. This guideline is reflective of our ongoing efforts to be inclusive in our approach to facilitating gaming -- we want the maximum amount of people to be able to game the way that provides them the most fun. In this case, taking the time to address this small programming change makes a huge difference to our community.

====2. Good Code====

* ''' Do NOT use <code><&#8288;table></code> for sheet layout'''.  As a general standard a <code><&#8288;table></code> element should only be used for tabular data. The <code><&#8288;table></code> shall not be used for [https://www.lifewire.com/dont-use-tables-for-layout-3468941 layouts]. See [[Designing Character Sheet Layout]] for better methods, or 
** This is the most common reason for new sheets being rejected/delayed by Roll20.  There are old sheets in the repo using them, but they where created before this rule against <code><nowiki><table></nowiki></code> was made.

* '''Minimum styling'''. All character sheets should have a small amount of CSS & HTML styling to make them aesthetically pleasing and usable. For example elements should not unintentionally overlap when a window is resized. The sheet should be familiar to players who are used to seeing the paper version of that sheet. It need not be identical to the paper version and should avoid violating any copyright, but it also shouldn't be laid out in such a crazy way that players will have a hard time understanding how to use it. '''Design for ease of use first and foremost.'''

* '''Proper HTML Syntax'''. Proper HTML syntax is encouraged to increase accessibility and make the code maintainable for community contributions. All new sheets are expected to use proper containers elements such as <code><&#8288;div></code> and <code><&#8288;span></code> elements. Your HTML file must '''not use''' <code><&#8288;head></code> or <code><&#8288;body></code> tag, or your character sheet may not load in the virtual tabletop.

* '''Save the files with Unix line endings ([https://en.wikipedia.org/wiki/Newline#Issues_with_different_newline_formats LF]).''' Required for all <code>.css</code>, <code>.html</code>/<code>.htm</code>, and <code>.json</code> files. A Google search can tell you how to set this up in your favorite text editor, so it's automatic.

* '''Every submission must include a valid [[sheet.json]]-file and a preview image.''' Directions for creating a proper <span style="font-family:monospace;">sheet.json</span> can be found on the {{repo|Roll20/roll20-character-sheets#creating-your-own GitHub README}}.

* '''[[Browser#|Chrome]] & [[Browser#Firefox|Firefox]] Compatible'''. The two official supported [[Browser|browsers]] of Roll20 are Chrome & Firefox. All character sheets need to be tested for functionality and styling in these two browsers.

====3. A Satisfactory Experience====

* '''Character Sheets must be standalone by default'''. All basic sheet functionality must be usable without external requirements such as images or fonts hosted outside Roll20, or  companion [[API Scripts]]. API companions are a welcome supplement for character sheets, but to ensure accessibility & functionality to community members at all of [[subscription]] levels the sheet must be usable by default without outside requirements.

* '''Functional [[Button|Roll Buttons]]'''. The best sheets not only keep track of character stats, they have the most common rolls for the game system embedded in them. This makes it much easier for new [[players]] to play the game by adding intuitive functionality. While you don't have to include every roll in the whole system, including frequently used rolls where appropriate can elevate your sheet to the next level. Games that do not have rolls such as ''Amber Diceless Roleplaying Game'' are not required to meet this standard. If you are designing a sheet for a system where this requirement does not apply, please address this in your pull request.

* '''[[#Storing_User_Data|Inputs & Textfields]] for data tracking'''. Character sheets for game systems which have attributes and stats should include <code><input></code> elements for users to keep track of their data. Whenever possible, use standard names for attributes, spelled out. For example, "intelligence", "strength", and "wisdom". This is important so that if a character is imported into a game with a different sheet, most of the values will be able to transition. If the attribute names are all different, then nothing can be imported. Your best bet is to look at existing sheets for that system and whenever possible use the same attribute names that are already in use. Similarly <code><textarea></code> tags should be included were applicable for users to add notes or descriptions. This requirement is highly variable based on the system and if this requirement is not applicable to the game system you are creating a sheet for please include a comment in your pull request.

* '''Rules must be readily available'''. Sheets can even be submitted for independent games and homebrew systems. Homebrew games will need to ensure they are not violating copyright for their respective game system. In both cases the rules need to be readily available online to the public (i.e. if you do a web search for the name of the game, you should be able to find free or paid versions of the rules in some form). Yet unreleased games that have public beta or quickstart rules available are fine.

===Beyond the Minimum===

The suggestions below are not required for new character sheets requesting to be added to the repository. Aspiring [[Sheet Author|sheet authors]] new to front-end development should focus on meeting the minimum requirements for their sheet's version one. When you are comfortable with the basics, the suggestions below can take the sheet one step further to shine as beacons of high-quality fun.

* '''[[CSS Wizardry]]'''. Our community of sheet authors is exceptionally clever and creative. They offer here examples of ways to leverage the character sheet system.

* '''[[Building_Character_Sheets/Roll_Templates|Customized Roll Templates]]'''. Roll templates can be customized to match the color scheme & style of your character sheet. Additionally, they can be utilized to help users achieve a roll output that matches the game system's specific mechanics.

* '''[[Sheetworkers|Sheet Workers are a powerful tool!]]'''. These scripts are an advanced feature of the Character Sheets system, which allows the sheet author to specify [[JavaScript]] to execute during certain events, such as whenever the values on an <code>input</code> are modified.

* '''[[Character Sheet Translation]]'''/internationalization (i18n), will allow you to design your character sheet in such a way that our [[CrowdIn|community of translators]] will be able to translate your sheet into their language, making that language available to anyone on Roll20. As of September 2016, we will no longer be accepting new character sheets that are simply alternate translations of already-existing character sheets. 

* '''[[Default Sheet Settings]]'''. Selectable options can be specified in the <code>sheet.json</code>-file provided with your Custom Character Sheet. These options provide default settings across all Characters when your Character Sheet is in use, making it easier for the [[GM]] to make adjustments on what base settings sheets have when created.

* '''[[Building_Character_Sheets#Compendium_Integration|Compendium Integration]]'''. By designating that your sheet is compatible with a Compendium, players will have direct access to that Compendium in the right sidebar during gameplay. {{Compendium}} are still a growing feature on Roll20, and integration is not yet available to most game systems.

* '''Include attribute names in Titles'''. Adding <code>title=@{attribute_name}</code> helps macro creators find the name of attributes easier. Titles are occasionally used for other purposes, so use your best judgment. See [[Sheet_Author_Tips#Using_REGEX|Using REGEX]] for an example.

* '''Link to a wiki page'''(or a Readme-file in the GitHub repo ) If you have created a wiki page for your sheet, you could link to it in the [[sheet.json]]'s <code>instructions</code>-section using Markdown.
**(E.g. <code>"instructions": "This is a basic character sheet for Stargate RPG by Wyvern Gaming. See [Stargate RPG](<nowiki>https://wiki.roll20.net/Stargate</nowiki>) for more info on how to use the sheet."</code>)

===Patreon and Tipeee Linking Rules for Community Sheet Contributors===
For [[Sheet Author|sheet authors]] that are contributing to the Roll20 community character sheet repository, they are approved to advertise via subscription/donation service sites: Patreon and Tipeee. Roll20 is not responsible for any payment transactions and cannot enforce any private arrangements.<br />

In order to qualify, a sheet author must first have their sheet contribution approved by the Roll20 staff and included into the community character Sheet repository.<br />

You will want to include your Patreon or Tipeee account information in the <code>[[sheet.json]]</code> file that should be included with your sheet submission on GitHub.<br />

The json file should have one of these fields added to it if you wish to advertise with Patreon or Tipeee:
:<code>patreon:</code> Place the URL for a Patreon campaign here, and it will appear under your sheet's description when selected. (e.g.<code>"<nowiki>https://www.patreon.com/</nowiki><name>"</code>)<br />

:<code>tipeee:</code> Place the URL for a Tipeee here, and it will appear under your sheet's description when selected. (e.g. <code>"<nowiki>https://www.tipeee.com/</nowiki><name>"</code>)<br />

For more information, see {{repo|Roll20/roll20-character-sheets#contributing github.com/Roll20/roll20-character-sheets#contributing}}<br />

'''Linking to Patreon/Tipeee on the Roll20 Forums'''

Linking to Patreon or Tipeee on the Roll20 Forums are only permitted for pre-approved community members who have contributing either Character Sheets or API Scripts. If you wish to solicit users directly for funding you may do so privately, but no such links are permitted in a public forum without any contributed material.<br />

==Best Practices==
{{:Character_Sheet_Development/Best_Practice}}

==Sheet Templates/Examples==
{{:Character Sheet Development/Sheet Templates}}

===Pattern Libraries===
{{:Character_Sheet_Development/Pattern_Libraries}}

==Related Pages==
* [[Character Sheet Development/Tutorial]]
* [[Sheet Author Tips]] - Misc. Sheet Author tips
* [[Custom Sheet Sandbox|Sheet Sandbox]] – the better editor to use when you code your character sheets
* [[Sheet Requests| List of Character Sheet Requests]] (that don't yet exist on Roll20)
* [[Character Sheet Index]] - List of Character Sheets on Roll20 (not always up to date)
* [[BCS/a11y|Accessibility (a11y)]]
* Git/GitHub
** [[Beginner's_Guide_to_GitHub| Beginner's Guide to GitHub(Roll20)]]
** [[Short Git Guide]] - A guide to using the command line version of Git to work on your computer, instead of GitHub Desktop
* [[Andreas Guide to Sheet Development]]
* '''[[:Category:Character Sheet Creation|List of all pages related to "Character Sheet Creation"]]'''
* '''[[Complete Guide to Macros & Rolls]]'''
** [[Dice Reference]] - how the Roll20 dice/math works
** [[Macros]]
** [[Reusing Rolls]]
** [[Chat Menus]]

==See Also==
* {{forum|category/277980 Roll20 Forums - Character Sheets & Compendiums}} - Best place for discussing Sheets with other Sheet Creators, and to get current info
* [https://discordapp.com/invite/sMsv5KD Unofficial Roll20 Discord] - The Discord server have two channels for discussing Character Sheet Creation, and many active Sheet Authors are present.
* {{repo Sheet}} - source-code of all Roll20 Community character sheets, as well as old code for some sheets made by Roll20 
* {{repo|Anduh/SublimeSettings SublimeSettings}} - Roll20-specific HTML Syntax highlight for [https://www.sublimetext.com/ Sublime Text]
* {{repo|Anduh/acsi ACSI}} - Automation for adding [[Character Sheet i18n|translation attributes/tags]] to a sheet
* {{hc|articles/360037773393-Building-Character-Sheets Building Char Sheets}} - Almost always outdated/lacking compared to any pages on sheet development on the wiki

===Guides===
General Web development Guides
* [https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML Introduction to HTML]
* [https://developer.mozilla.org/en-US/docs/Learn/CSS/First_steps Introduction to CSS]
** [https://flukeout.github.io/ CSS Diner] learn to use CSS Selectors
* [https://developer.mozilla.org/en-US/docs/Learn/JavaScript/First_steps Introduction to JavaScript]
** [https://www.executeprogram.com/ executeprogram.com] - Learn JavaScript
* [https://google.github.io/styleguide/htmlcssguide.html Google's HTML/CSS Style Guide]

===Forums Threads===
Insightful stuff
* [https://app.roll20.net/forum/post/10687954/any-science-behind-sheet-performance Any Science Behind Sheet Performance?] March 2022

[[Category:Docs]]
[[Category:Character Sheet Creation]]
[[Category:Character Sheet Development]]
[[Category:Character Sheet Documentation]]
[[Category:Pro]]
[[Category:Character Sheets]]
[[Category:Featured articles]]