Latest revision as of 17:19, 25 October 2021

Attention: This page is community-maintained. For the official Roll20 version of this article, see the Help Center for assistance: Here .

Sidebar
q Text Chat
P Art Library
N Journal
i Compendium
u Jukebox
l Collections
y My Settings

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 Roll20 also offer unlockable licensed material via the Marketplace like Wizards of the Coast's Volo's Guide to Monsters and Monster Manual, or Kobold Press' Tome of Beasts^(Market).

[edit] External Compendium

Main Page: External Compendium

The Roll20 compendium can also be viewed when not inside a game.

[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	SRD
Monster Manual	Wizards of the Coast	MM1
Volo's Guide to Monsters	Wizards of the Coast	VG1
Tome of Beasts	Kobold Press	TOB
Baldur's Gate: Descent into Avernus	Wizards of the Coast	DIA

[edit] Compendium Sharing

Main Page: 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] Requested Feature: Custom Compendium

Main Page: Custom Compendium

You can't edit or create Custom Compendiums, but it's a popular suggestion.

[edit] See Also

The other tabs in the Sidebar:

@@ Line 1: / Line 1: @@
-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.
+{{revdate}}{{HCbox|{{hc|articles/360039178694-Compendium Here}} }}{{clear}}{{SidebarNav}}
+[[File:Compendium-tab.png|thumbnail|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 Roll20 also offer unlockable licensed material via the Marketplace like Wizards of the Coast's ''[[Volo's Guide to Monsters]]'' and ''[[Monster Manual]]'', or Kobold Press' ''{{market|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? [https://app.roll20.net/forum/post/4314710/help-us-create-more-compendium-options Read here to learn how  to become a volunteer!]
+=External Compendium=
+{{Main|External Compendium}}
-=The Compendium Tool=
+The Roll20 compendium can also be viewed when not inside a game.
-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.
-==Browsing a Compendium==
+=In-Game 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.
+[[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.
-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 headers and subheaders of the entry.
+==Adding a Compendium to your Game==
-==="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 [https://app.roll20.net/forum/category/277980 Character Sheets & Compendium forum].
-==Adding a Campaign to your Game==
-[[File:Compendium Tab.png|framed|right|The Compendium Tab with the D&D 5th Edition SRD Compendium Loaded]]
 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 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.
+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 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.
+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.
-==Drag and Drop Functionality==
+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.
-===Non-Monster Entries===
+===Entry List Data In-App===
-===Monster Entries===
+[[File:Viewing_Compendium_Attribute_Data_In-App_v2.gif|framed|right|Viewing attribute info of D&D 5E Monster entries within the Roll20 App]]
-===Character Sheet Integration===
+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.
-=Building A Compendium=
+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.
-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.
-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.
+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 />
-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.
+===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.
-==How to Become a Volunteer==
+'''5E Sources'''
-If you are interested in volunteering to help, please email team@roll20.net and provide the following information:
+{| style="width:25%; padding: 5px;" class="wikitable" align="center"
+|-
+! 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>
+|}
-<pre>Subject: New Compendium Volunteer
+==[[Compendium Sharing]]==
+{{main|Compendium Sharing}}
-   Do you have experience with basic html text editors?
+==Drag and Drop Functionality==
-   What game would you like to bring to the Compendium?
+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.
-   Does the game have an OGL? (Please share a link to the OGL)
+===Non-Monster Entries===
-   In 2 to 3 sentences, please describe your experience with these games.
+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]]''.
-   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.
+===Monster Entries===
-===The Character Sheet & Compendium Forum===
+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.
-=How to Build a Compendium=
-==Page Creation==
-==Editing a Page==
-==Compendium Structured Data (Attributes)==
-===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 simply adding this search template in the HTML editor for the desired index page and saving it down.
-<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.
+===Character Sheet Integration===
+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.
-'''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.
+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.
-::Example: <pre>{{SearchIndex|Category:Monsters|}}</pre> This will list every single entry that is under the "Monsters" category.
+=Requested Feature: Custom Compendium=
+{{main|Custom Compendium}}
-'''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 Monsters by their Type (aberration, goblinoid, ooze, etc) or Challenge Rating. Entries within a group will then be listed alphanumerically.
+You can't edit or create Custom Compendiums, but it's a popular suggestion.
-::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.
+=See Also=
+* [[Marketplace]]
+* [[Character Sheets]]
-'''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".
+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:Sidebar]]
+[[Category:Compendium]]

Roll20 Wiki

Navigation

Personal tools

Toolbox

Difference between revisions of "Compendium"

From Roll20 Wiki