Feature: Import

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.18.4

Import by Category.gif

Importing

The import tool brings content into the game which has been grouped into different categories which you will be able to choose specifics elements from in subsequent prompts.
In general, the import brings into the game handout journal entries which have the RAW 5e descriptions of the content (Skills, Psionic Powers, Spells, Equipment, Background, Feats, Magic Items, Invocations, Class, Race or Subclass/Subrace) all listed within the Player side facing text field for Description & Notes of that Handout.
In the GM Notes section, there is a segment of code which more or less says what that Description & Notes box does but in a way the script better understands for Drag & Drop functionality -- if it's usable / allowed.
NOTE: Once the material is imported, *modifying the sheet will likely destroy its usability* for Drag & Drop and you'll need to delete and re-import the files.


This is a guide to the means for importing content into Roll20 through either the BetteR20 script, or the Roll20 Enhancement Suite (R20es /VTTes).
There are a number of options for such provided within the tools, which depending upon your position in the game (GM or Player) and which tool you are using within the game that you're


Temp Import (for player CharactersGroup.png)
  • Appears in R20Journal.png Journal section
  • Doesn't have Adventures or Monsters
  • Disappears from the journal when you refresh (ie. it is temporary); however the items added to character sheets will remain.


Import by Category (for GMs Dm.png)
  • Imports from Selective Modules/Adventures from Roll20 modules.


Bind Drag n Drop

How to enable the green highlighting that denotes if the imported (Background/Class/Feat/Item/Object/Optional Feature/Spell/Psionic power/Race or Subclass) is click and drag-able
Did you note the lack of Adventure & Monster listed there? That's because they are special and do not require binding, see below.

Walkthrough (How to use it)

AS GM

  • Go to the My Settings feature of the Sidebar.
  • From the drop list choose one item from the category list.
Each entry may have different subsequent steps.


  • Locate the category (see below)
  • Choose a source and then choose to
  • A new window will be presented with the options for that
  • You may refine the list by search or just click any of the specific entries
  • Determine the grouping

    ​​​​​​When you do this the Sidebar will shift to the Journal Tab,
     
  • Decide if you want to Overwrite journal entries of the same type and name.


AS PLAYER

Unlike the AS GM, those elements which are imported are lost when the browser restarts and are not included in the game's actual Journal.  Also, players are unable (and not presented) importing Adventures, Tables, and Monsters as options.

  • Go to the Journal feature of the Sidebar.
  • Choose the Temporary Import feature button
  • From the drop-list choose one from the category list.


Each entry may have different subsequent steps.


 


FOR BOTH

Most things are imported into the Journal, as handouts. Handouts that when dragged (only works when Bind Drag n' Drop is enabled.) to a character sheet will be added to the sheet.

You cannot move/replace or edit the journal entry handout - doing so will break the code that allows this work.

Categories

The material for import are divided into functional categories. The listings are done in a divided manner. With 3rd party / appearing at the bottom of the list behind the Homebrew: prefix.
If you made a homebrew (see how to make homebrew section) with the name Ultimate Homebrewing Compendium then once its been submitted and registered, it would appear in the list as Homebrew: Ultimate Homebrewing Compendium. If you are looking to add content not listed, you'll need to provide the custom link for such.

Adventure

Currently, the adventure importing loads the text of the adventure booklet, not the map, nor monsters and their locations on the maps or any NPCs
These are not Drag and Drop. You can modify these without loss of function.


Background

These are character creation backgrounds, there are more which you can import the 5eTools Website Homebrew Repository.
Background Feature is brought over via Drag and Drop, the Suggested Characteristics -- Personality Trait, Ideals, Bonds, & Flaws are not - those will need to be manually chosen and either cut and paste on the character sheet from the Background's player facing Description & Notes or manually typed. 


Classes

This is the core (base) class such as "Fighter" or "Warlock", Subclasses are handled separately.
(NOTE: added content DOES NOT build out Charactermancer's options, BetteR20 does not work with charactermancer)

Feats

Feats are 
When Drag-n-Dropped this doesn't automatically update the Attributes or prompt for choices when the Feat offers two choices.


Items

This includes Adventuring Gear, Ammunition, Weapons, Firearms, Armor, Magical Items, Spellcasting Foci, Shield, Instruments, Tools, Vehicles, Machines, Mounts, Gaming Set, Artisan Tools, Poisons, etc.


Monsters

Monsters bring over the character sheets (NPC) for the monsters in Roll20's 5e / OGL Character Sheet format.
Importing Monsters through this tool can include configuration of token settings/token action macros and some settings related to the default character sheet behavior, you modify these in the Configuration Editor
NOTE:' modifying these settings AFTER importing doesn't change what has already been imported.
Shaped Character Sheet should be able to automatically migrate such information when opened for the first time, 


Objects

 These are mostly siege weaponry


Psionics

 The UA listing of Psionic Powers and Talents.


Races

Regretfully to make the Drag and Drop feature work, each subrace is a separate Handout.
(NOTE: added content DOES NOT build out Charactermancer's options, BetteR20 does not work with charactermancer)

Spells

These are the spells. You add these by clicking and dragging them upon the character sheet.
NOTE: the more spells a character sheet has, the larger and more cumbersome it is to work with, its a best practice to include the spells you are using, and remove ''that ones' you do not, and even perhaps not listing the ones that more 'effect' than combative/contested. 
example:
Fireball requires saves and rolling damage, and so is an obvious and worthwhile choice,'Skywrite is a ritual that doesn't require significant interaction mechanically to manage - so it would not be.)  


NOTE ALSO: There is no category for 'handouts' separately, nor one for Maps (Roll20 designation as Pages).

Maps - the graphics are handled through External Art Tools, and Handouts are through Adventures, Items, Classes, Spells/Powers - those categories define what and how handouts are imported.


Subclasses

(NOTE: added content DOES NOT build out Charactermancer's options, BetteR20 does not work with charactermancer)

Group Journal Entries

The Group Handouts By... feature determines the structure of the Journal entries, both handouts AND mon

Rarity Alphabetical Source By Properties


Make Visible Overwrite - When Checked the files should overwrite the files with a copy with the same name, markup/MediaWiki links to the journals will be broken.

Custom Link

This is for those that want to import their own content and assume you've already confirm you have a file that is valid for use with 5eTools. (See Homebrew)
You will need to ensure the site's location meets the general needs for the BetteR20/R20es - ie that the file can be directly linked.
You then place that URL in the field and proceed with the import as normal.

(If the file does not work, see the guidance within the directly linked guide, and the homebrew guidance, and 5e.Tools Homebrew manager.



Feature Support

(this is a community-curated set of best practices / FAQ on the feature's support and solutions/workarounds.)


Known Issues/Limitations

Looks like its perfect... (Did we miss anything?)


FAQ

Does this work with Shaped Sheet?
The tool imports in a format compatible for 5e OGL (also called the 5e Character Sheet by Roll20) character sheet. The source for that data is a variety of community developed JSON housed in the Homebrew resource library. The library uses a specific guidance, a schema, for the data which you can learn more about there. (Feel free to contribute) The Import hangs while attempting to import. What do I do?


Hit the X or cancel and then close the import window. Attempt to import it again.

While not necessary, its advisable to delete the folders for content that failed ('Journal Cleaner and Delete Folder + Contents) If it fails. Restart the browser and attempt it again.


How do I search the results;
Each entry imported gets keywords associated with the content imported;
Level: <number>
class: <name>
school: <school name>
etc; you can enter the keywords and specifics into the search bar on the journal and filter the imported content down to what you want to reference/use.


How do I import my own content?
That is the realm of homebrew. You have to use the website tools to build your own homebrew; convert it; OR make it yourself
Best Practices

Import only what need as you need it.
Importing expands the local game database, and if you import a lot you'll create an increased liklihood for lag/slow performance.
To reduce spam, we recommend installing modules that hide or otherwise categorize Compendiums (such as Compendium Folders) so you don't have both SRD and Plutonium compendiums.




Related Features



Did that answer your question(s)?

If not please check the under Support; Troubleshooting or the Known Issues page for further guidance, or go to the Discord community and leave a comment in the issues channel.

If you enjoy the project, please follow this link to see how you can contribute and help make it even better.