Difference between revisions of "FeaturePlutonium: Importing"

From 5etools Community Wiki
Jump to: navigation, search
m (Importing into an Actor)
m (Importing)
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Category:Import]]
 
[[Category:Import]]
 
=Importing=
 
=Importing=
: Plutonium allows you to rapidly bring your D&D 5e's content into your games, such as items, classes and creatures. As always if you do not legally possess the content, you should not use it.  
+
: Plutonium allows you to rapidly bring your D&D 5e's content into your games, such as items, classes and creatures. As always if you do not legally possess the content, you <u>should not</u> use it. Obey your local laws. 
: Both [[Homebrew: Overview|'''Homebrew''']] and [[Template:SourceRAW|'''5e Core content''']] is supported.
+
: Both [[Homebrew: Overview|'''Homebrew''']] and [[Template:SourceRAW|'''5e Core content''']] are supported for importing
 +
 
 +
<br>
 +
: For those familiar with BetteR20 for Roll20 this slightly breaks from likely expectations.
 +
:* '''Actors''' are charactersheets; and so all content that you'd have on the charactersheet is available and optimized for use for a character/use, so while it may seem to be more akin to [[Feature: Import Players|Temporary Importing]] from BetteR20; its a much more than such, as it includes class features specific for the levels; often setting up actions; skills etc on the sheet. IT IS NOT CHARACTERMANCER; but for those that know the rules its better than such.
 +
:* '''Worlds''' are a full campaign; its comparative to a game in Roll20. So importing into a world, is very much like BetteR20's [[Feature: Import by Category|'''Import by Category''']]; in that content (Actors (PCs/NPCs/Monsters... and at times items) are moved into the Actors tab; Items moved into the '''World Importing''' is similar to BetteR20's [[Feature: Module Importer/Exporter|'''Module Importer/Exporter''']]; it is how full adventures are imported.
 +
::: Journal entries, Like compendia are best for reference. The world importer will bring them in for use; and most will have content that will mostly work when click and dragged to the actor; but not as well as from the Actor Importing.
 +
 
 +
 
 +
<br>
 
: There are four main ways to import content into Foundry (click expand to see more about each type) and one method that really isn't part of Plutonium's function.
 
: There are four main ways to import content into Foundry (click expand to see more about each type) and one method that really isn't part of Plutonium's function.
 
+
----
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div style="line-height:1.6;text-indent:3em;">Importing into a World</div>
 
<div style="line-height:1.6;text-indent:3em;">Importing into a World</div>
Line 105: Line 114:
  
 
==Importing a world into Foundry==
 
==Importing a world into Foundry==
 +
: '''World Importing''' is similar to BetteR20's [[Feature: Module Importer/Exporter|'''Module Importer/Exporter''']]; it is how full adventures are imported.
 
: ''World importing (currently) will take to you to a separate repo where you can download them as zips. To use these worlds, you will have to copy and extract them into your world directory.''
 
: ''World importing (currently) will take to you to a separate repo where you can download them as zips. To use these worlds, you will have to copy and extract them into your world directory.''
 
[[File:ImportWorld.png|frameless|right]]
 
[[File:ImportWorld.png|frameless|right]]
: You get to that location (currently) but clicking upon Worlds in the Import Wizard.
+
: You will be taken to that location (currently) but clicking upon Worlds in the Import Wizard.
 
: You will then need to choose if you want the World (full game/campaign); or Compendium.
 
: You will then need to choose if you want the World (full game/campaign); or Compendium.
  

Revision as of 22:31, 29 June 2020

framless
v1.3.0

Importing

Plutonium allows you to rapidly bring your D&D 5e's content into your games, such as items, classes and creatures. As always if you do not legally possess the content, you should not use it. Obey your local laws.
Both Homebrew and 5e Core content are supported for importing


For those familiar with BetteR20 for Roll20 this slightly breaks from likely expectations.
  • Actors are charactersheets; and so all content that you'd have on the charactersheet is available and optimized for use for a character/use, so while it may seem to be more akin to Temporary Importing from BetteR20; its a much more than such, as it includes class features specific for the levels; often setting up actions; skills etc on the sheet. IT IS NOT CHARACTERMANCER; but for those that know the rules its better than such.
  • Worlds are a full campaign; its comparative to a game in Roll20. So importing into a world, is very much like BetteR20's Import by Category; in that content (Actors (PCs/NPCs/Monsters... and at times items) are moved into the Actors tab; Items moved into the World Importing is similar to BetteR20's Module Importer/Exporter; it is how full adventures are imported.
Journal entries, Like compendia are best for reference. The world importer will bring them in for use; and most will have content that will mostly work when click and dragged to the actor; but not as well as from the Actor Importing.



There are four main ways to import content into Foundry (click expand to see more about each type) and one method that really isn't part of Plutonium's function.

Importing into a World

Importing into a World

PlutoniumButtons.PNG
  • From the Tabletop you'll want to make sure you are in one of the following:
Actors
Items
Journal Entries
Tables
This will bring up the Import Wizard

PlutoniumImportWizard.PNG
1) Choose Importer - Pick the type of content you want to import. (In this case )
2) Choose Source - Select the source of the content you want to import. They are coded by these symbols:
D&D Raw Icon.png - WoTC content; Core Rules; Supplements; Unearthed Arcana; Official AL (Extra Life) content; or from Offical WoTC Stream
ActorIcon.png - These are the custom solutions; a specific direct link URL; or local compatible JSON file.
BrewMugIcon.png - Homebrew content maintained at the Homebrew Repository
There can be a lot of content there, so there is a copy of the Filter system to help find a source. You can use Rivet to bypass some of this
3) Configure and Import - If you chose the "ActorIcon.png Custom URL" option as a source, here's where you would link the file you want to import from.
Keep Window Open - Can be toggled to choose if the Wizard stays open once you open the importer proper;
Folder Path: - Determines the folder in which the content will end up in. By default it will create a folder, but you can change its name, add deeper folderization, or choose an existing folder.



Once everything is set up correctly, you are ready to open the Importer. To find the content you want, either use the search bar, or change the filters at the top. These filters work like the ones in the main site, so for more information check the Filters page

Importing into an Actor

Importing into an Actor

ActorHeader.png

This is the preferred method for data that you would want in a player sheet, such as classes, spells or items.

Keep in mind any player with "Owner" sheet permission can access this importer
The first step is to go into the Actors there will be a ScienceIcon.png Import button atop the actor sheet.
Click upon such and this will bring you to the Import Wizard:


Import Wizard


1) Choose Importer: Pick the type of content you want to import.
2) Choose Source: Select the source of the content you want to import. They are coded by these symbols:
D&D Raw Icon.png - WoTC content; Core Rules; Supplements; Unearthed Arcana; Official AL (Extra Life) content; or from Offical WoTC Stream
ActorIcon.png - These are the custom solutions; a specific direct link URL; or local compatible JSON file.
BrewMugIcon.png - Homebrew content maintained at the Homebrew Repository
3) Configure and Import: If you chose the "Custom URL" option as a source, here's where you would enter the direct link to the file which you want to import. You can also choose if the Wizard stays open once you open the importer proper.
You may then either click (IconFastForward.png) next the topic you wish to import then click upon Open Importer to bring up a window listing all the options for importing; use the filter to help you refine what you need.
Then click upon the entry you wish to use and click Import
If the entry has options
(Example: An imported Class will prompt for which level(s), which skills, sometimes will prompt for class feature choices)


Importing into a Scene

Importing into a Scene

Importing an Art Asset is possible from the Art Browser.
PlutoniumArtBrowser.png
Open the Art Browser by clicking the (PlutoniumArt palette.png) icon.
The Art Browser will open and you can then choose between modes of operation; from the top right icon


Plutonium Scene Icon.png - Scene
Scenes are analogous to Maps/Pages in Roll20; its an entire new scene/location; another floor; a different world or the like. Scenes when pulled will generate a completely new scene for the world.
TileIcon.png - Tile
Tiles are essentially everything that isn't a Token; they are Maps; Map Assets; etc.
ActorIcon.png - Actor/Token
Actors are images/icons; tokens


  • Filter the results down to your choice.
  • Choose which mode you wish to work within.
  • Click and Drag the Graphic to the Tabletop
you MUST have done the backend modifications for this work, check your installation if you get an error
Importing with Rivet

Importing with Rivet

Rivet is an extension for use on Chrome (and chromium-based browser) or Firefox; it use it you'll need to install Rivet.
Rivet requires you to have Foundry Open in the same browser on a different tab than 5etool's session.
When Rivet is active you'll see the Transfer via Rivet icon (Rivet PaperAirplane.png); which when clicked will transfer the active content into Foundry's Journal; or in a specific Actor (if setup in the Config Editor
FoundryRivet.gif
Importing a world into Foundry
In FoundryVTT a WORLD means a game/adventure/campaign

Importing a world into Foundry

World Importing is similar to BetteR20's Module Importer/Exporter; it is how full adventures are imported.
World importing (currently) will take to you to a separate repo where you can download them as zips. To use these worlds, you will have to copy and extract them into your world directory.
ImportWorld.png
You will be taken to that location (currently) but clicking upon Worlds in the Import Wizard.
You will then need to choose if you want the World (full game/campaign); or Compendium.



Import to Compendium

The data in a world is loaded for every player as soon as the game is loaded. This can be troublesome for people with slow internet connections if there's much data involved, Compendiums are the solution for this. They are collections of data that you can pull from whenever you want, easing the load for everyone involved. To import data into a Compendium, make sure there is an unlocked one available. It must accept the type of content you want to import, if this is not the case an error will tell you.



Feature Support


Known Issues/Limitations

Importing Lots of conent

Firefox appears to have a memory leak. If you choose to import a large amount of content at one time you should consider triggering the garbage collector, every few minutes.
SEPARATELY: Importing LARGE amounts of content (over 500+ entities (Actors/Journal sheets etc) at a time can create problems for the Forge. Try to import only in small batches as KaKaRaTo's system has limits on memory/processor usage.


Importing Scenes...

(ie how do I import Full Maps with all the tokens, lighting, and walls defined)
You're likely attempting to do that via import -> adventure; and that doesn't do that. (just like with BetteR20 - as stated above).
So this doesn't exist, yet.
You'll want to either import a world (which has all that) or the add-on module for a compendium which will have some of that.


Which is better Compendium or World

In general, Compendiums are a good solutions. Compendiums don't load their contents until they're brought into the game.
In comparison, importing into the World directly does load into for the players so you may wish to check with them about site/campaign/world performance, but it does allows folderization of the data so its organization is easier.
If there are issues move non-essential content into a compendium for your use.


So, Organization and higher memory requirements (World) or lower memory requirements and less order (Compendium)


into World Module
Compendium
Actor Rivet
Memory Use N/A
Organization
Access In Game Extra Steps N/A
Example Example Example


FAQ

Nothing's here (Do you have any suggestions?)
Best Practices

Importing Lots of conent

Firefox appears to have a memory leak. If you choose to import a large amount of content at one time you should consider triggering the garbage collector, every few minutes.
Homebrew

🚧 Still being documented.



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.