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 "Compendium"

From Roll20 Wiki

Jump to: navigation, search
(Advanced Search)
 
(36 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[[File:Fireball Compendium Entry Small.png|framed|right|The Fireball Spell Entry from the 5th Edition SRD Compendium]]
+
<div style="background:#f0e2a1; border: 3px solid #dbc870; padding: 10px;">
Compendiums are "books" of indexed and categorized series of webpages devoted to a particular RPG rule system. It behaves and is designed similarly to a mini wiki. A Compendium can be browsed outside the VTT, but it also can be used within it for quick rule searches and populating fields on your character sheets like equipment and spells via drag and drop capability.
+
<big>'''''Attention:'''''
 +
''Roll20 is no longer maintaining this document on the community wiki. For the most up-to-date information please visit this page on our help center for assistance: [https://roll20.zendesk.com/hc/en-us/articles/360039178694-Compendium Here].''</big>
 +
</div>
 +
[[File:Compendium-tab.png|thumb|right|230px|The <span style="font-family:Pictos;">i</span> '''Compendium'''-tab, as viewed inside a game]]
 +
Compendiums are "books" of indexed and categorized series of webpages devoted to a particular RPG rule system. It behaves and is designed similarly to a mini wiki. A Compendium can be browsed outside the VTT, but it also can be used within it for quick rule searches and populating fields on your character sheets like equipment and spells via drag and drop capability. [[Compendium Sharing|These can be shared with other users inside a campaign]].
  
There are Compendiums that are freely available to use due to their OGL status (I.e. D&D 5th Edition SRD and Pathfinder SRD), but we also offer unlockable licensed material via our Marketplace like Wizards of the Coast's ''[[Volo's Guide to Monsters]]''.  
+
There are Compendiums that are freely available to use due to their OGL or CCPL status (I.e. D&D 5th Edition SRD, Pathfinder SRD, Dungeon World), but we also offer unlockable licensed material via our Marketplace like Wizards of the Coast's ''[[Volo's Guide to Monsters]]'' and ''[[Monster Manual]]'' or Kobold Press' ''[https://marketplace.roll20.net/browse/compendiumexpansion/3/tome-of-beasts Tome of Beasts]''.  
  
Knowledgeable of a certain OGL ruleset? Are you familiar with HTML text editing? Interested in building your own Compendium for the Roll20 community? [[Compendium#How_to_Become_a_Volunteer|Read below to learn how to become a volunteer!]]
+
Knowledgeable of a certain OGL/CCPL ruleset? Are you familiar with HTML text editing? Interested in building your own Compendium for the Roll20 community? [[Building Compendiums|Go here to learn how to become a volunteer!]]
 +
 
 +
=External Compendium=
 +
[[File:Compendium_Entry.jpg|thumb|right|320px|A Monster Entry from the Monster Manual expansion of the [[5E|Dungeons & Dragons 5th Edition]] Compendium, viewed in the '''External Compendium''']]
 +
You can access the available Compendiums by going to the website's main navigation bar and selecting '''Tools''' -> '''Compendium'''. This brings you to the '''[https://roll20.net/compendium/ Compendium Page]''' where you can choose the Compendium you wish to browse.<br />
  
=The Compendium Tool=
 
You can access the available Compendiums by going to the website's main navigation bar and selecting '''Tools''' -> '''Compendium'''. This brings you to the '''[https://roll20.net/compendium/ Compendium Page]''' where you can choose the Compendium you wish to browse.
 
<div style="clear:both;"></div>
 
 
==Browsing a Compendium==
 
==Browsing a Compendium==
 
Once you've selected a Compendium to browse, you'll first have a search bar available followed with an index of categories. Depending on the game ruleset in question, the available categories may be different, but what you will likely see are ones such as: Rules, Races, Classes, Items, Equipment, Spells, and Monsters. Underneath these categories are subpages and in some instances those subpages may be broken down into even further subpages. For instance, in the D&D 5th Edition SRD Compendium, the Spells category has subpages for each Class and each one of these pages is a list of spells which have their own dedicated page.
 
Once you've selected a Compendium to browse, you'll first have a search bar available followed with an index of categories. Depending on the game ruleset in question, the available categories may be different, but what you will likely see are ones such as: Rules, Races, Classes, Items, Equipment, Spells, and Monsters. Underneath these categories are subpages and in some instances those subpages may be broken down into even further subpages. For instance, in the D&D 5th Edition SRD Compendium, the Spells category has subpages for each Class and each one of these pages is a list of spells which have their own dedicated page.
Line 17: Line 22:
 
While it is possible that a Compendium could be missing content, especially in the case of newly built Compendiums, it's important to note that an OGL version of a rule system may not cover the entirety of the published rule system it's based from. For instance, the D&D 5th Edition OGL SRD does NOT have entries on ''Displacer Beasts'' or ''Mind Flayers'', nor do they cover any other feats beyond ''Grappler''. That is because they were purposely not included in the SRD (System Reference Document) when the publisher designed it. If something is missing from a Compendium, you should first check to see if that entry is actually part of the OGL SRD. If something is missing, contact the volunteers of that Compendium via the [https://app.roll20.net/forum/category/277980 Character Sheets & Compendium forum].
 
While it is possible that a Compendium could be missing content, especially in the case of newly built Compendiums, it's important to note that an OGL version of a rule system may not cover the entirety of the published rule system it's based from. For instance, the D&D 5th Edition OGL SRD does NOT have entries on ''Displacer Beasts'' or ''Mind Flayers'', nor do they cover any other feats beyond ''Grappler''. That is because they were purposely not included in the SRD (System Reference Document) when the publisher designed it. If something is missing from a Compendium, you should first check to see if that entry is actually part of the OGL SRD. If something is missing, contact the volunteers of that Compendium via the [https://app.roll20.net/forum/category/277980 Character Sheets & Compendium forum].
  
==Advanced Search==
+
===Purchasing Compendium Expansions===
[[File:Compendium Advanced Search.png|center|framed|x125px|Advanced Search Feature in the D&D 5e OGL Compendium]]
+
Available on the Roll20 Marketplace are various Compendium Expansions. A purchase of one or more expansions grants access to entries that are not included in the original SRD ("[https://marketplace.roll20.net/browse/bundle/29/players-handbook Player's Handbook]," ''[https://marketplace.roll20.net/browse/bundle/2/volos-guide-to-monsters Volo's Guide to Monsters]'' and ''[https://marketplace.roll20.net/browse/compendiumexpansion/3/tome-of-beasts Tome of Beasts]'' are examples of purchasable Compendium Expansions).
[[File:Compendium Advanced Search Results.png|framed|right]]
+
When navigating the Compendium outside the VTT, underneath the very large '''SEARCH''' button is a link called '''Advanced Search'''. Clicking on this will roll out an Attribute search underneath the main Compendium Search Field. You can select any available Attribute in the Compendium from the drop down menu that's presented and then fill out the desired Attribute value in the field to the right of the drop down menu. Once hitting enter/return after entering a value to search for, this will add it to the Search Field. The Advanced Search will remain visible so you can add even more search parameters by Attributes and they will be tacked on into the Search Field.<br />
+
[[File:Additional Compendium Attribute Searches.png|framed|x100px|center]]
+
Once you placed the desired filters you want, click on the '''SEARCH''' button and you'll get the resulting entries that match all the parameters you added.<br />
+
  
Currently, the Advanced Search feature is not available within the Compendium Tab of the VTT; however, you can do category and attribute searches. So in the Compendium tab, you can search the above example, <code>Category:Monsters "Challenge Rating":2</code>, to get the same results within the VTT.
+
To access this content, all you need to do is purchase the expansion of your choice. Once bought, all content under that expansion becomes immediately available to you. It's important to note that access to these expansions' content shared in games is limited, and game owners must choose to [[Compendium Sharing|share their purchased compendium content on a per game basis]]. Even without sharing, a GM can create handout and character journal entries of Compendium content by dragging entries to the Tabletop to generate them. These journal entries can then be shared among players on an as-needed basis if they themselves do not have access to the expansion content.
<div style=clear:both;></div>
+
  
==Adding a Compendium to your Game==
+
==Compendium Search Filters==
[[File:Compendium Tab.png|framed|right|The Compendium Tab with the D&D 5th Edition SRD Compendium Loaded]]
+
[[File:Compendium_List_View.png|thumbnail|300px|right|A List Page that features Search Filters in action on the 5E Compendium]]
Where the versatility of Compendiums truly shines is when one is attached to a game so that it can be utilized within the VTT. GMs and players can look up rules on the fly during their game and the GM can take whole entries from the Compendium and drag them to the tabletop to create a handout with the information contained within. While editing a character journal, the GM and players can drag items, spells, and other abilities from the Compendium into their character sheet to auto-complete elements on it. Monster entries will even create and populate entire NPC journals automatically and come with a linked token (when available) when the GM drags its entry to the Tabletop.
+
List pages on the Compendium feature special Search Filters for certain compendium categories. These filters allow you to filter through the entries dynamically via Compendium attributes without having to use the Compendium's Search Bar. Examples of such can be seen on the [https://roll20.net/compendium/dnd5e/Spells%20List#content Spells List] and [https://roll20.net/compendium/dnd5e/Monsters%20List#content Monsters List] pages of the 5E SRD Compendium. The filtered list of entries are displayed underneath the search filters.<br />
  
Compendiums are tied to Character Sheets. A community sheet must be designed by its author to point to a particular Compendium first before VTT/Compendium functionality is available. For instance, choosing a D&D 5th Edition character sheet will automatically assign and enable the 5th Edition Compendium to be used in your game as well as Pathfinder sheets linking to the Pathfinder Compendium. You can choose a character sheet at game creation or by going to the Game Settings page at any time afterwards.
+
===Utilizing the Search Filters===
 +
[[File:List Search Filters.png|thumb|500px|left|Search Filters for Spells]]<br />
  
Once added, a new tab will be added on the Sidebar placed between the [[Journal]] tab and the [[Jukebox]] tab. This is the Compendium tab. Browsing and searching for entries within the Compendium Tab behave exactly as the webpage version. The only difference here is that the entries will pop up in their separate window when you select them from the tab.
+
The Monsters List of the 5E Compendium has search filters for monster Name, Alignment, Speed, Type, Size, Challenge Rating, and Language.<br />
  
==Drag and Drop Functionality==
+
The Spells List of the 5E Compendium has search filters for spell Name, Level, Class, School, Ritual, Concentration, Casting Time, Range, Spell Attack, Damage Type, and Save.<br />
When added to a game, a Compendium can speed up the process of content generation for a GM. Not only can you use the Compendium tab to look something up in the rulebook without opening a physical book or switching to another browser tab, but you can click and drag on a Compendium entry to pull it out of the Compendium tab for various automated purposes listed below.
+
===Non-Monster Entries===
+
Compendium entries that aren't designed as a complete NPC sheet (Rules, Races, Classes, Items, Spells, etc) will add a Handout to the [[Journal]] tab containing all the text and images from the provided Compendium entry after dragging and dropping the entry to the Tabletop. When in handout form, the GM can share this out to other players. This method is how you can grant players access to purchased Marketplace content like ''[[Volo's Guide to Monsters]]''.
+
  
===Monster Entries===
+
With the exception of the Name field and the monster Speed field (which are simple text fields), the rest of these hard-coded search filters are either drop down multi-select fields or Yes/No radio buttons. When selecting one of the multi-select fields, you will have every option that's available for that listed attribute. For example, the Spell List filter for spell School has the available selection options: Abjuration, Conjuration, Divination, Enchantment, Evocation, Illusion, Necromancy, Transmutation, or Evocation. You can choose multiple options from a select search filter. Hold down Ctrl(Windows)/⌘(Mac) while clicking on a search filter to choose multiple options from the select drop down list. You can also add more options afterwards, by clicking on the empty space to the right of the last filter item within the input field to bring up the selection drop down menu again.<br style="clear:both;" />
If you look up a Monster/Beast/NPC entry in your Compendium and then drag and drop it to the tabletop, so long as you are using a Character Sheet that has this enabled, a Character Journal will be automatically created and statted using the content from the Compendium entry to fill out the various attributes and abilities.
+
===Character Sheet Integration===
+
When filling out a character sheet, if enabled by the Sheet Author, a player can drag and drop Items, Equipment, Abilities, Spells, and other entry types, onto a specified fields on the sheet to automatically fill them out with the information provided by the Compendium entry. The range of interactivity depends on the Sheet's design.
+
  
=Building A Compendium=
+
====Creating Your Own Search Filters====
As of December 1st, 2016, Roll20 has opened the ability for community members to build their own Compendiums for available OGL systems outside of D&D 5th Edition SRD and the Pathfinder SRD. A volunteership program is now available for potential members to volunteer to become a Compendium Editor. These new Compendiums will have all of the features of the original two Compendiums, including Character Sheet integration and drag and drop functionality. Editors will be working to help push content to our users and are expected to respect the rules of the site and the game they are working on - any violation or vandalism of the Compendium will result in removal from the project team.
+
[[File:Compendium Custom Search Filter.png|framed|left|A user-created Custom Search Filter]]Each list page has a hard-coded set of search filters; however, you can create additional filters if you can't find what you need there. Below the preset filters is a blue button labeled '''+ New Filter'''. Clicking on this will create a new filter field that offers a drop down select to choose an attribute to search by and then a text field underneath that to enter what you're searching for. Every single attribute used in the Compendium is available from this filter drop down menu. For instance, say you wanted to find all monsters that wear scale mail. You would create a new filter for the AC attribute on the Monsters List page and then enter the keyword "scale" into the provided text field. The monster list would then be filtered down to all monsters that have the word "scale" listed under their AC attribute.<br />
  
Editors should have a firm grasp of the rule system they would like to prepare and ideally have some familiarity with HTML, wiki writing, and/or authoring Structured Data. Structured data is strongly required to begin a Compendium, however we will consider manual submissions if the data is not available.
+
You can delete a custom search filter at any time by clicking on the X icon to the right of the filter's text field. Also, custom filters do not persist after closing or refreshing the page.<br style="clear:both;" />
  
At present, Roll20 will be limiting one Editor per game system Compendium. After an initial Compendium project is completed, an Editor may be considered to help contribute towards other future Compendiums in collaborative projects.
+
====Hiding the Filters====
 +
Right below the Compendium search bar is a toggle button labeled '''Would you like to use search filters?'''. Clicking on the toggle icon will hide or reveal the search filter options (shaded blue when revealed, grey when hidden).<br />
  
==How to Become a Volunteer==
+
===The Filtered Results===
If you are interested in volunteering to help, please email team@roll20.net and provide the following information:
+
[[File:Compendium Filtered Search Results.png|thumbnail|400px|right|This is what the list filtering looks like on the Monster List of the 5E Compendium]]Below the Search Filters are the entries that get filtered and listed as tabled data. Each entry block begins with the entry's name that is also hyperlinked to its specific page within the Compendium. To save time, the tables display all of the attributes available from the search filter section ''and'' several more that would be helpful to have included here.<br />
  
<pre>Subject: New Compendium Volunteer
+
====Sorting the List====
 +
Entries displayed in the list are sorted in alphanumerical order, but you change which attribute to sort the list under. Under the text '''Sort results by:''' are blue buttons that list every attribute that is displayed in the list. Click on any of these buttons to sort via that attribute. You'll be able to tell which is currently selected when an up or down arrow appears beside the attribute's name within the button. The arrow's direction indicates whether the sort is ascending or descending in alphanumerical order. Clicking on the same button will toggle between an ascending or descending list order.<br />
  
  Do you have experience with basic html text editors?
+
====Entry Summaries====
  What game would you like to bring to the Compendium?
+
Initially hidden from view, each search result entry has a summary which displays the first couple sentences of the linked Compendium page which includes a secondary link to direct you to the entry's page to view the rest of its content. You can reveal an entry summary by clicking on the down arrow to the far right of the entry's name. Clicking on this arrow again will hide the summary section again.<br />
  Does the game have an OGL? (Please share a link to the OGL)
+
<div style=clear:both;></div>
  In 2 to 3 sentences, please describe your experience with these games.
+
  Are you familiar with Structured Data?
+
  Do you know how to obtain the Structured Data for the game you are considering?
+
  Please share your Roll20 account email.</pre>
+
  
Upon approval, editors will be connected to their Compendium teams & the Roll20 staff via email to help facilitate organization and discuss any roadblocks. All approved volunteers will receive a special account badge.
+
====Turning Compendium Pages====
==Building A Compendium via JSON Import==
+
[[File:Next Page Link.png|left]]
The ideal method of Compendium building is to break down your game system into a series of JSON files; one for each page of your Compendium book. Then, compile them as a zip file or assemble them into a dropbox link which is later imported into Roll20's Compendium library by the Roll20 team. This is far easier to do when your OGL system is already cataloged on an online database where you can pull and reuse the HTML formatting and existing structured data already provided.
+
Compendium expansions have had their pages given a order to follow the sequence found in the physical book. At the bottom of a page in an expansion, there will be '''<< Previous Page''' and '''Next Page >>''' links. These will bring you to the previous or following page in the order so you can read the compendium content in a similar fashion as a book. If you mouse over the Previous and Next links, the hover text will display the title of the page you will be navigating to.<br style="clear:both;" />
  
If your OGL system does not have an online database, you may need to go through the following [[Compendium#Building A Compendium Manually|Manual Process of Building a Compendium]] if it must be designed from scratch.
+
=In-Game Compendium=
 +
[[File:Compendium Tab2.png|framed|right|The [[Sidebar]]'s <span style="font-family:Pictos;">i</span> '''Compendium'''-tab, with the D&D 5th Edition SRD Compendium loaded.]]
 +
If a Compendium is enabled inside a game, it can be accessed through the [[Sidebar]]'s '''<span style="font-family:Pictos;">i</span> Compendium'''-tab.
 +
==Adding a Compendium to your Game==
 +
Where the versatility of Compendiums truly shines is when one is attached to a game so that it can be utilized within the VTT. GMs and players can look up rules on the fly during their game and the GM can take whole entries from the Compendium and drag them to the tabletop to create a handout with the information contained within. While editing a character journal, the GM and players can drag items, spells, and other abilities from the Compendium into their character sheet to auto-complete elements on it. Monster entries will even create and populate entire NPC journals automatically and come with a linked token (when available) when the GM drags its entry to the Tabletop.
  
===JSON File Basics===
+
Compendiums can be tied to a community Character Sheet. A community sheet must be designed by its author to point to a particular Compendium first before VTT/Compendium functionality is available. For instance, choosing a D&D 5th Edition character sheet will automatically assign and enable the 5th Edition Compendium to be used in your game as well as Pathfinder sheets linking to the Pathfinder Compendium. You can choose a character sheet at game creation or by going to the Game Settings page at any time afterwards.
A JSON file is a JavaScript filetype meant for data storage and exchange. You can create them in any text editor that you would commonly use to write HTML documents ([https://notepad-plus-plus.org/ Notepad++] or [https://www.sublimetext.com/ Sublime Text], for  example). The JSON's filename should match the "name" object's value within the JSON file itself.
+
  
====The Basic Structure of a Compendium Page JSON====
+
Once added, a new tab will be added on the [[Sidebar]], placed between the <span style="font-family:Pictos;">N</span> [[Journal]]-tab and the <span style="font-family:Pictos Custom;">u</span> [[Jukebox]]-tab. This is the Compendium tab. Browsing and searching for entries within the Compendium Tab behave exactly as the webpage version. The only difference here is that the entries will pop up in their separate window when you select them from the tab.
<pre>{
+
  "name": "Page Name",
+
  "content": "This is the content that would make up the bio & skills/abilities of an NPC or the body copy for a rule page",
+
  "data": {
+
    "Source": "The Game System or Book Source this page is from",
+
    "Category": "The Category the Compendium page would be filed under",
+
  }
+
}</pre>
+
  
The JSON file for a Compendium page REQUIRES the objects "name", "content", and "data". Also under the "data" object, the elements "Source" and "Category" is ALSO required in the JSON file; otherwise, the Compendium page will not be generated. Even if the page does not contain attributes, like a rule page, it still requires a ''data'' object with ''Source'' and ''Category'' elements with assigned values.
+
If you're not relying on a Character Sheet to load a desired Compendium, you'll want to go to the [[Game Settings Page]] and choose the Compendium you want to use.
 +
===Entry List Data In-App===
 +
[[File:Viewing_Compendium_Attribute_Data_In-App_v2.gif|framed|right|Viewing attribute info of D&D 5E Monster entries within the Roll20 App]]
 +
When browsing entries that have a List Page (like Spells or Monsters from the 5E SRD Compendium) on the external Compendium, you can pull down the same block of data that displays underneath the search filters within the VTT.
  
The three objects ''name'', ''content'', and ''data'' make up the entirety of the Compendium page.  
+
While looking through a listed category on the <span style="font-family:Pictos;">i</span> Compendium Tab, a down arrow icon will appear when you mouse-over over an entry. It will appear to the left of the entry name or token graphic (when available). Clicking on this icon will roll out that entry's info block. You can roll out as many entries in this fashion as you want on the <span style="font-family:Pictos;">i</span> Compendium Tab.
: '''name:''' The ''name'' object's value will be used for the name of the page. Capitalization matters here and what is enclosed in the quotation marks is what the page's eventual URL will be as well.
+
: '''content:''' The value of the ''content'' object is the meat of what's to be read on a Compendium page; HTML tags are allowed in the value.
+
: '''data:''' Elements listed under ''data'' is what will be listed in the Attributes section of the page (items that you would expect in a monster's statblock, for example).
+
  
The ''name'' and ''content'' objects are set in stone, but the attributes you add under data is flexible to what your OGL system needs (with the exception of the required ''Source'' and ''Category'' elements). BUT! You must be consistent with the naming conventions of your attribute Elements. If you use "AC" on one page, you shouldn't use "Armor Class" on another, and so on.
+
To hide the block of information again, mouse-over the entry and the arrow icon will point up instead of down. Clicking on this icon will hide the info block.<br />
  
====5th Edition OGL Example====
+
===Book Expansion Sources===
Here is the JSON example of a [https://roll20.net/compendium/dnd5e/Bugbear Bugbear] from the 5th Edition OGL Compendium
+
While viewing Compendium entries in-app, a publisher icon and a book title abbreviation will be listed on the entry's far right to signify where this info is sourced from. For instance, an entry from the ''Monster Manual'' expansion will have the Dungeons and Dragons ampersand logo as well as the abbreviation, '''MM1''', underneath it. Kobold Press' ''Tome of Beast'' expansion entries will have a kobold logo icon and the abbreviation, '''TOB''', underneath it.
<pre style="white-space: pre-wrap;">{
+
  "name":"Bugbear",
+
  "id":11963,
+
  "content":" Traits\n\n**Brute**: A melee weapon deals one extra die of its damage when the bugbear hits with it (included in the attack).\n\n**Surprise Attack**: If the bugbear surprises a creature and hits it with an attack during the first round of combat, the target takes an extra 7 (2d6) damage from the attack.\n\n Actions\n\n**Morningstar**: Melee Weapon Attack: +4 to hit, reach 5 ft., one target. Hit: 11 (2d8 + 2) piercing damage.\n\n**Javelin**: Melee or Ranged Weapon Attack: +4 to hit, reach 5 ft. or range 30/120 ft., one target. Hit: 9 (2d6 + 2) piercing damage in melee or 5 (1d6 + 2) piercing damage at range.\n\n  ","htmlcontent":"<h2>Traits</h2><strong>Brute</strong>: A melee weapon deals one extra die of its damage when the bugbear hits with it (included in the attack).<br><br><strong>Surprise Attack</strong>: If the bugbear surprises a creature and hits it with an attack during the first round of combat, the target takes an extra 7 (2d6) damage from the attack.<br><br><h2>Actions</h2><strong>Morningstar</strong>: Melee Weapon Attack: +4 to hit, reach 5 ft., one target. Hit: 11 (2d8 + 2) piercing damage.<br><br><strong>Javelin</strong>: Melee or Ranged Weapon Attack: +4 to hit, reach 5 ft. or range 30/120 ft., one target. Hit: 9 (2d6 + 2) piercing damage in melee or 5 (1d6 + 2) piercing damage at range.<br><br>",
+
  "data":{
+
    "AC":"16 (Hide Armor, Shield)",
+
    "HP":"27 (5d8+5)",
+
    "CHA":"9",
+
    "CON":"13",
+
    "DEX":"14",
+
    "INT":"8",
+
    "STR":"15",
+
    "WIS":"11",
+
    "Size":"Medium",
+
    "Type":"Humanoid (Goblinoid)",
+
    "Speed":"30 ft.",
+
    "Roll 0":"Morningstar\n1d20 + 4\n2d8+2",
+
    "Roll 1":"Melee\n1d20 + 4\n2d6+2",
+
    "Roll 2":"Ranged\n1d20 + 4\n1d6+2",
+
    "Senses":"Darkvision 60 Ft.",
+
    "Skills":"Stealth +6, Survival +2",
+
    "Source":"SRD 5.0",
+
    "Category":"Monsters",
+
    "Alignment":"Chaotic Evil",
+
    "Languages":"Common, Goblin",
+
    "Challenge Rating":"1",
+
    "Passive Perception":"10"
+
    }
+
}</pre>
+
  
==Building A Compendium Manually==
+
'''5E Sources'''
If you have no existing online database to create JSON files from, you'll need to build the Compendium directly in Roll20.
+
{| style="width:25%; padding: 5px;" class="wikitable" align="center"
===Page Creation===
+
|-
Once selected by the Roll20 team as a Compendium Editor, you will be given access to a blank Compendium book to start editing and fill with content. During the process of creating the staging area for the book, you'll want to assemble a list of Categories needed for your game system (Rules, Monsters, Items, Spells, etc). You will want to have the organization structure straightened out before work on the Compendium begins.
+
! Source Book Name !! Publisher !! Icon !!
 +
|-
 +
| ''5E SRD'' || Wizards of the Coast || [[File:DungeonsDragonsIcon.png]]<br /><span style="color:#333; ">SRD</span>
 +
|-
 +
| ''Monster Manual'' || Wizards of the Coast || [[File:DungeonsDragonsIcon.png]]<br /><span style="color:#38546f; ">MM1</span>
 +
|-
 +
| ''Volo's Guide to Monsters'' || Wizards of the Coast || [[File:DungeonsDragonsIcon.png]]<br /><span style="color:#6c1f31; ">VG1</span>
 +
|-
 +
| ''Tome of Beasts'' || Kobold Press || [[File:KoboldPressIcon.png]]<br /><span style="color:#33224f; ">TOB</span>
 +
|-
 +
| ''Baldur's Gate: Descent into Avernus'' || Wizards of the Coast || [[File:DungeonsDragonsIcon.png]]<br /><span style="color:#00008B; ">DIA</span>
 +
|}
  
Once you're given the URL for the new Compendium book by the Roll20 Team, you create new pages by tacking on the name of the new page at the end of the URL in the address bar and hitting Enter. (example: ''<nowiki>https://roll20.net/compendium/MyBook/</nowiki>''Test Page) For special characters like spaces, parenthesis, and apostrophes, once you hit Enter, the page name will be adjusted to use HTML Code for the needed ASCII characters automatically.
+
==[[Compendium Sharing]]==
 +
{{main|Compendium Sharing}}
  
Since the page does not yet exist, the Compendium will display a page that says:
+
==Drag and Drop Functionality==
<pre>Not Found: [page name]
+
When added to a game, a Compendium can speed up the process of content generation for a GM. Not only can you use the <span style="font-family:Pictos;">i</span> Compendium tab to look something up in the rulebook without opening a physical book or switching to another browser tab, but you can click and drag on a Compendium entry to pull it out of the <span style="font-family:Pictos;">i</span> Compendium tab for various automated purposes listed below.
 +
===Non-Monster Entries===
 +
Compendium entries that aren't designed as a complete NPC sheet (Rules, Races, Classes, Items, Spells, etc) will add a [[Journal#Handout|Handout]] to the <span style="font-family:Pictos;">N</span> [[Journal]] tab containing all the text and images from the provided Compendium entry after dragging and dropping the entry to the Tabletop. When in handout form, the GM can share this out to other players. This method is how you can grant players access to purchased Marketplace content like ''[[Volo's Guide to Monsters]]''.
  
We don't currently have a page that matches that name. Try again?
+
===Monster Entries===
 +
If you look up a Monster/Beast/NPC entry in your Compendium and then drag and drop it to the tabletop, so long as you are using a [[Character Sheet]] that has this enabled, a Character Journal will be automatically created and statted using the content from the Compendium entry to fill out the various attributes and abilities.
  
Or maybe you'd like to create this page?</pre>
+
===Character Sheet Integration===
Below this will be a drop down menu for the Category you wish to add the page to.
+
Some [[Character Sheets]], such as [[D&D 5E by Roll20]] or [[PF2E|Pathfinder Second Edition by Roll20]], have Compendium integration that enables you to drag-n-drop entries from the Compendium, or use the info in a Charactermancer.
If this is the very first page, you'll not have any available Category to choose from in the drop-down other than '''Miscellaneous''' to start with, so this is where you should start adding your own Categories.
+
 
+
Once you've set or added a Category to the page, click on the blue '''Create Page''' button to create it. This will drop you onto the newly created page to start editing it.
+
 
+
===Editing a Page===
+
Once created, a Compendium page will be split up into two distinct parts: A '''Text Editor''' and then an '''Attributes Table''' underneath.
+
====Text Editor====
+
The text editor can switch between a WYSIWYG and an HTML version by clicking on the <code></></code> button which is the last button on the right side of the text editor's toolbar. You may find that writing your Compendium entries in HTML may make Sheet integration easier as you won't get tripped over by unseen/unexpected formatting that can sometimes occur when working in the WYSIWYG version of the editor. The text editor is where you would include monster/class/race bios, feats, and abilities. Any data that can not be contained in a single input field should be placed here. Use heading tags (<nowiki><h1>, <h2>, <h3>, Etc.</nowiki>) in a consistent manner to split your content up for efficient integration. It is incredibly important that text formatting is also kept consistent throughout the entirety of the Compendium book.
+
=====Dynamic Linking=====
+
You do not need to manually create page links within the text copy of your Compendium pages. Page linking is done automatically after Roll20 initiates a Compendium build. This automated process scans through the text contents of every single entry of the Compendium to match strings up with any available page titles. When a match is found (the page name and string must be identical save for Capitalization), the string is automatically hyperlinked to the matched page.
+
 
+
=====Creating Category List Pages=====
+
Once the individual entries of a Category are created, creating index pages (I.e. ''Monsters by Name'', ''Equipment by Type'', ''Spells by School'', etc) are automatically generated by adding this search template in the Text Editor for the desired index page and saving it.
+
<pre>{{SearchIndex|***filter parameters***|}}</pre>
+
You can use multiple of the following filtering parameters all at once. Simple separate the filters apart with a space as you list them between the two vertical bars.
+
 
+
 
+
:'''Category:''' Assigning the Category attribute will list all entries under the specified Category. The entries will be listed by their entry names in Alphanumerical order.
+
::Example: <pre>{{SearchIndex|Category:Monsters|}}</pre> This will list every single entry that is under the "Monsters" category.
+
 
+
 
+
:'''GroupBy:''' This filter is typically used alongside the Category filter to help sort the resulting list. This will assemble the entries into groups. An example from the D&D 5th Edition SRD is listing [[https://roll20.net/compendium/dnd5e/Monsters%20by%20Type Monsters by their Type]] (aberration, goblinoid, ooze, etc) or [[https://roll20.net/compendium/dnd5e/Monsters%20by%20Challenge%20Rating Challenge Rating]]. Entries within a group will then be listed alphanumerically.
+
::Example: <pre>{{SearchIndex|Category:Monsters GroupBy:Type|}}</pre> This will list the various Monster Types available and then sort the Monster entries via their "Type" Attribute.
+
 
+
 
+
:'''Source:''' If there's a Compendium that is comprised of multiple books, a "Source" Attribute will likely be created to designate which book an entry page is being pulled from. This makes you able to create an index strictly listing content only from a designated source.
+
::Example: <pre>{{SearchIndex|Category:Monsters GroupBy:Type Source:Bestiary2|}}</pre> This will generate a list of entries under the "Monsters" category, grouped by their "Type" attribute, and will only use entries listed with the "Source" Attribute "Bestiary2".
+
 
+
====Attributes Table====
+
[[File:BattleAxe Attributes.png|framed|right|Attributes Assigned to a Battleaxe Compendium Weapon Entry]]
+
Below the Text Editor is the Attributes Table. This area is to input traditional statblock content that is consistent throughout your Categories: Armor Class, Languages, Weaknesses, Immunities, HP, XP, Passive Perception, etc., for Monsters. Weight, Item Type, Armor Class, Stealth rating for Items. Damage Type, Weight, Properties, Damage Die for Weapons. Commonly these Attributes are already broken down into a table within your rule book to carry it over into your Compendium entries.
+
 
+
=====Adding Attributes=====
+
When you're starting off with a new page, there will be no Attributes assigned to it. To start adding Attriburtes, click on the '''Edit Attributes''' link to the right of the Attributes heading. This will not only reveal hidden Attributes (if there are any), but also add a new link at the bottom of the Attributes Table labeled '''+ Add New Attribute'''.
+
 
+
A drop down menu labeled '''Choose an attribute...''' will appear on a new table row. If you have created Attributes previously on other entries, those Attributes will appear as options on this drop down menu. The first option on the menu is '''Create new attribute...''' and likely will be what you'll be using mostly until you have all of your desired Attributes created.
+
[[File:Creating Compendium Attributes.png|framed|Creating a New Attribute|center]]
+
Once selected, an empty field will appear to the right of the drop down menu and a smaller field directly below the drop down menu with the temporary text ,"New Attr Name", within it. As you might expect, the "New Attr Name" field is for the name of the Attribute you wish to create. The blank field on the right is the value the current entry has for this new Attribute. In the example image above, the attribute being created keeps track of an entry's "Element". I am assigning the Element for this entry the value of "Fire". An Attribute's value can be numerical or it could be a string.
+
 
+
Continue adding Attributes as you need in this fashion, either creating them from scratch or choosing from the drop down menu. When you are done, scroll up to the Attributes heading and where the '''Edit Attributes''' link used to be. While in Edit Mode, this link's label will change to '''Save Attributes'''. Clicking on this not only saves your changes, but it also logs any newly created Attributes so they can be brought up again on a new page.
+
 
+
=====Editing or Deleting Attributes=====
+
You can't delete Attributes until they're saved down first. Once saved, you can click on the '''Edit Attributes''' link again to return to Edit Mode. Any previously added/created Attributes will have a pen and trash can icon appear on the right side of the Attribute row when you hover your mouse over any one of them. Clicking on the pen icon will open the Attribute up once more so it can be edited, while the trash can icon will delete the Attribute. Remember to click on '''Save Attributes''' to exit out of Edit Mode and save your changes.
+
 
+
<div style="clear:both;"></div>
+
 
+
===Designing for Sheet/Compendium Integration===
+
In order to design a Compendium with character sheet integration in mind, it is recommended that a Compendium editor reaches out to the sheet Author(s) currently maintaining Sheets for their given game system. In order for a Compendium to integrate with a Character Sheet, the Compendium should be using matching Attributes used by the Sheet. Vice versa, the Sheet must be scripted to take advantage of the ''compendium-drop'' Event so that it can correctly parse and format the Compendium's content into attack rolls, items, spell slots, feats, etc once a Drag and Drop event occurs onto a sheet field or Tabletop. [https://app.roll20.net/forum/category/277980 The Character Sheet & Compendium forum] was designed intentionally so that Sheet and Compendium authors would have an easier time collaborating with one another.
+
  
====Compendium Compatibility====
+
When filling out a character sheet, if enabled by the Sheet Author, a player can drag and drop Items, Equipment, Abilities, Spells, and other entry types directly to the character sheet to automatically fill them out with the information provided by the Compendium entry. The range of interactivity depends on the Sheet's design.
To get started, we recommend reading up on the [[Building Character Sheets #Compendium Integration|Compendium Integration section]] on the Building Character Sheets wiki page on how to enable Drag-and-Drop Functionality on your sheet.
+
  
====Automated Journal Generation and Statted Token Creation====
 
If you use the [https://github.com/Roll20/roll20-character-sheets/blob/master/5th%20Edition%20OGL%20by%20Roll20/5th%20Edition%20OGL%20by%20Roll20.html 5th Edition OGL by Roll20.html] sheet on GitHub as an example; examining lines 7 and 5738 demonstrates how token generation and creating Journals (rather than a Handout) with their NPC version auto-toggled occurs after a Compendium Drag and Drop to the Tabletop.
 
  
 +
=See Also=
 +
The other tabs in the [[Sidebar]]:
 +
* <span style="font-family:Pictos;">q</span> [[Text Chat]]
 +
* <span style="font-family:Pictos;">P</span> [[Art Library]]
 +
* <span style="font-family:Pictos;">N</span> [[Journal]]
 +
* <span style="font-family:Pictos;">y</span> [[Compendium]]
 +
** [[Compendium Sharing]]
 +
* <span style="font-family:Pictos Custom;">u</span> [[Jukebox]]
 +
* <span style="font-family:Pictos;">l</span> [[Collections]]
 +
* <span style="font-family:Pictos;">y</span> [[My Settings]]
 +
<br>
 +
<br>
 
[[Category:Docs]]
 
[[Category:Docs]]

Latest revision as of 17:30, 15 May 2020

Attention: Roll20 is no longer maintaining this document on the community wiki. For the most up-to-date information please visit this page on our help center for assistance: Here.

The i Compendium-tab, as viewed inside a game

Compendiums are "books" of indexed and categorized series of webpages devoted to a particular RPG rule system. It behaves and is designed similarly to a mini wiki. A Compendium can be browsed outside the VTT, but it also can be used within it for quick rule searches and populating fields on your character sheets like equipment and spells via drag and drop capability. These can be shared with other users inside a campaign.

There are Compendiums that are freely available to use due to their OGL or CCPL status (I.e. D&D 5th Edition SRD, Pathfinder SRD, Dungeon World), but we also offer unlockable licensed material via our Marketplace like Wizards of the Coast's Volo's Guide to Monsters and Monster Manual or Kobold Press' Tome of Beasts.

Knowledgeable of a certain OGL/CCPL ruleset? Are you familiar with HTML text editing? Interested in building your own Compendium for the Roll20 community? Go here to learn how to become a volunteer!

Contents

[edit] External Compendium

A Monster Entry from the Monster Manual expansion of the Dungeons & Dragons 5th Edition Compendium, viewed in the External Compendium

You can access the available Compendiums by going to the website's main navigation bar and selecting Tools -> Compendium. This brings you to the Compendium Page where you can choose the Compendium you wish to browse.

[edit] Browsing a Compendium

Once you've selected a Compendium to browse, you'll first have a search bar available followed with an index of categories. Depending on the game ruleset in question, the available categories may be different, but what you will likely see are ones such as: Rules, Races, Classes, Items, Equipment, Spells, and Monsters. Underneath these categories are subpages and in some instances those subpages may be broken down into even further subpages. For instance, in the D&D 5th Edition SRD Compendium, the Spells category has subpages for each Class and each one of these pages is a list of spells which have their own dedicated page.

No matter which page of a Compendium you're on, there is a search bar directly above that allows you to look up for more entries at any time. The search looks for keywords used in the page title and header tags of an entry.

[edit] "Why isn't there an entry for (Spell, Rule, Monster, Etc.) in here?"

While it is possible that a Compendium could be missing content, especially in the case of newly built Compendiums, it's important to note that an OGL version of a rule system may not cover the entirety of the published rule system it's based from. For instance, the D&D 5th Edition OGL SRD does NOT have entries on Displacer Beasts or Mind Flayers, nor do they cover any other feats beyond Grappler. That is because they were purposely not included in the SRD (System Reference Document) when the publisher designed it. If something is missing from a Compendium, you should first check to see if that entry is actually part of the OGL SRD. If something is missing, contact the volunteers of that Compendium via the Character Sheets & Compendium forum.

[edit] Purchasing Compendium Expansions

Available on the Roll20 Marketplace are various Compendium Expansions. A purchase of one or more expansions grants access to entries that are not included in the original SRD ("Player's Handbook," Volo's Guide to Monsters and Tome of Beasts are examples of purchasable Compendium Expansions).

To access this content, all you need to do is purchase the expansion of your choice. Once bought, all content under that expansion becomes immediately available to you. It's important to note that access to these expansions' content shared in games is limited, and game owners must choose to share their purchased compendium content on a per game basis. Even without sharing, a GM can create handout and character journal entries of Compendium content by dragging entries to the Tabletop to generate them. These journal entries can then be shared among players on an as-needed basis if they themselves do not have access to the expansion content.

[edit] Compendium Search Filters

A List Page that features Search Filters in action on the 5E Compendium

List pages on the Compendium feature special Search Filters for certain compendium categories. These filters allow you to filter through the entries dynamically via Compendium attributes without having to use the Compendium's Search Bar. Examples of such can be seen on the Spells List and Monsters List pages of the 5E SRD Compendium. The filtered list of entries are displayed underneath the search filters.

[edit] Utilizing the Search Filters

Search Filters for Spells

The Monsters List of the 5E Compendium has search filters for monster Name, Alignment, Speed, Type, Size, Challenge Rating, and Language.

The Spells List of the 5E Compendium has search filters for spell Name, Level, Class, School, Ritual, Concentration, Casting Time, Range, Spell Attack, Damage Type, and Save.

With the exception of the Name field and the monster Speed field (which are simple text fields), the rest of these hard-coded search filters are either drop down multi-select fields or Yes/No radio buttons. When selecting one of the multi-select fields, you will have every option that's available for that listed attribute. For example, the Spell List filter for spell School has the available selection options: Abjuration, Conjuration, Divination, Enchantment, Evocation, Illusion, Necromancy, Transmutation, or Evocation. You can choose multiple options from a select search filter. Hold down Ctrl(Windows)/⌘(Mac) while clicking on a search filter to choose multiple options from the select drop down list. You can also add more options afterwards, by clicking on the empty space to the right of the last filter item within the input field to bring up the selection drop down menu again.

[edit] Creating Your Own Search Filters

A user-created Custom Search Filter
Each list page has a hard-coded set of search filters; however, you can create additional filters if you can't find what you need there. Below the preset filters is a blue button labeled + New Filter. Clicking on this will create a new filter field that offers a drop down select to choose an attribute to search by and then a text field underneath that to enter what you're searching for. Every single attribute used in the Compendium is available from this filter drop down menu. For instance, say you wanted to find all monsters that wear scale mail. You would create a new filter for the AC attribute on the Monsters List page and then enter the keyword "scale" into the provided text field. The monster list would then be filtered down to all monsters that have the word "scale" listed under their AC attribute.

You can delete a custom search filter at any time by clicking on the X icon to the right of the filter's text field. Also, custom filters do not persist after closing or refreshing the page.

[edit] Hiding the Filters

Right below the Compendium search bar is a toggle button labeled Would you like to use search filters?. Clicking on the toggle icon will hide or reveal the search filter options (shaded blue when revealed, grey when hidden).

[edit] The Filtered Results

This is what the list filtering looks like on the Monster List of the 5E Compendium
Below the Search Filters are the entries that get filtered and listed as tabled data. Each entry block begins with the entry's name that is also hyperlinked to its specific page within the Compendium. To save time, the tables display all of the attributes available from the search filter section and several more that would be helpful to have included here.

[edit] Sorting the List

Entries displayed in the list are sorted in alphanumerical order, but you change which attribute to sort the list under. Under the text Sort results by: are blue buttons that list every attribute that is displayed in the list. Click on any of these buttons to sort via that attribute. You'll be able to tell which is currently selected when an up or down arrow appears beside the attribute's name within the button. The arrow's direction indicates whether the sort is ascending or descending in alphanumerical order. Clicking on the same button will toggle between an ascending or descending list order.

[edit] Entry Summaries

Initially hidden from view, each search result entry has a summary which displays the first couple sentences of the linked Compendium page which includes a secondary link to direct you to the entry's page to view the rest of its content. You can reveal an entry summary by clicking on the down arrow to the far right of the entry's name. Clicking on this arrow again will hide the summary section again.

[edit] Turning Compendium Pages

Next Page Link.png

Compendium expansions have had their pages given a order to follow the sequence found in the physical book. At the bottom of a page in an expansion, there will be << Previous Page and Next Page >> links. These will bring you to the previous or following page in the order so you can read the compendium content in a similar fashion as a book. If you mouse over the Previous and Next links, the hover text will display the title of the page you will be navigating to.

[edit] In-Game Compendium

The Sidebar's i Compendium-tab, with the D&D 5th Edition SRD Compendium loaded.

If a Compendium is enabled inside a game, it can be accessed through the Sidebar's i Compendium-tab.

[edit] Adding a Compendium to your Game

Where the versatility of Compendiums truly shines is when one is attached to a game so that it can be utilized within the VTT. GMs and players can look up rules on the fly during their game and the GM can take whole entries from the Compendium and drag them to the tabletop to create a handout with the information contained within. While editing a character journal, the GM and players can drag items, spells, and other abilities from the Compendium into their character sheet to auto-complete elements on it. Monster entries will even create and populate entire NPC journals automatically and come with a linked token (when available) when the GM drags its entry to the Tabletop.

Compendiums can be tied to a community Character Sheet. A community sheet must be designed by its author to point to a particular Compendium first before VTT/Compendium functionality is available. For instance, choosing a D&D 5th Edition character sheet will automatically assign and enable the 5th Edition Compendium to be used in your game as well as Pathfinder sheets linking to the Pathfinder Compendium. You can choose a character sheet at game creation or by going to the Game Settings page at any time afterwards.

Once added, a new tab will be added on the Sidebar, placed between the N Journal-tab and the u Jukebox-tab. This is the Compendium tab. Browsing and searching for entries within the Compendium Tab behave exactly as the webpage version. The only difference here is that the entries will pop up in their separate window when you select them from the tab.

If you're not relying on a Character Sheet to load a desired Compendium, you'll want to go to the Game Settings Page and choose the Compendium you want to use.

[edit] Entry List Data In-App

Viewing attribute info of D&D 5E Monster entries within the Roll20 App

When browsing entries that have a List Page (like Spells or Monsters from the 5E SRD Compendium) on the external Compendium, you can pull down the same block of data that displays underneath the search filters within the VTT.

While looking through a listed category on the i Compendium Tab, a down arrow icon will appear when you mouse-over over an entry. It will appear to the left of the entry name or token graphic (when available). Clicking on this icon will roll out that entry's info block. You can roll out as many entries in this fashion as you want on the i Compendium Tab.

To hide the block of information again, mouse-over the entry and the arrow icon will point up instead of down. Clicking on this icon will hide the info block.

[edit] Book Expansion Sources

While viewing Compendium entries in-app, a publisher icon and a book title abbreviation will be listed on the entry's far right to signify where this info is sourced from. For instance, an entry from the Monster Manual expansion will have the Dungeons and Dragons ampersand logo as well as the abbreviation, MM1, underneath it. Kobold Press' Tome of Beast expansion entries will have a kobold logo icon and the abbreviation, TOB, underneath it.

5E Sources

Source Book Name Publisher Icon
5E SRD Wizards of the Coast DungeonsDragonsIcon.png
SRD
Monster Manual Wizards of the Coast DungeonsDragonsIcon.png
MM1
Volo's Guide to Monsters Wizards of the Coast DungeonsDragonsIcon.png
VG1
Tome of Beasts Kobold Press KoboldPressIcon.png
TOB
Baldur's Gate: Descent into Avernus Wizards of the Coast DungeonsDragonsIcon.png
DIA

[edit] Compendium Sharing

Main article: Compendium Sharing


[edit] Drag and Drop Functionality

When added to a game, a Compendium can speed up the process of content generation for a GM. Not only can you use the i Compendium tab to look something up in the rulebook without opening a physical book or switching to another browser tab, but you can click and drag on a Compendium entry to pull it out of the i Compendium tab for various automated purposes listed below.

[edit] Non-Monster Entries

Compendium entries that aren't designed as a complete NPC sheet (Rules, Races, Classes, Items, Spells, etc) will add a Handout to the N Journal tab containing all the text and images from the provided Compendium entry after dragging and dropping the entry to the Tabletop. When in handout form, the GM can share this out to other players. This method is how you can grant players access to purchased Marketplace content like Volo's Guide to Monsters.

[edit] Monster Entries

If you look up a Monster/Beast/NPC entry in your Compendium and then drag and drop it to the tabletop, so long as you are using a Character Sheet that has this enabled, a Character Journal will be automatically created and statted using the content from the Compendium entry to fill out the various attributes and abilities.

[edit] Character Sheet Integration

Some Character Sheets, such as D&D 5E by Roll20 or Pathfinder Second Edition by Roll20, have Compendium integration that enables you to drag-n-drop entries from the Compendium, or use the info in a Charactermancer.

When filling out a character sheet, if enabled by the Sheet Author, a player can drag and drop Items, Equipment, Abilities, Spells, and other entry types directly to the character sheet to automatically fill them out with the information provided by the Compendium entry. The range of interactivity depends on the Sheet's design.


[edit] See Also

The other tabs in the Sidebar: