Foundry Virtual Tabletop uses the concept of items, for objects that have their own statistics and information and can then be associated with or used by actors. This page provides an overview on Items, the Items Directory, and their functionality.
The Items Directory
Items in Foundry can be viewed, created, and managed in the Items Directory sidebar. Like the Scenes, Actors, and Journal Entries directories, this directory can contain folders to organize your world's items. Only a Gamemaster or Assistant-level user can change or move folders, but any players with at least Limited permissions on an item can see the item and the folder(s) containing it in the Items Directory.
Like folders in other directories, the "quill" icon on an item folder will create a new item in that folder, and the "plus folder" icon will create a new subfolder.
Item Context Menu Options
- View Item Artwork
- Views the item's artwork in new window.
- Clear Folder
- Removes the item from all folders, placing it at the top level of the Items directory.
- Deletes the item, after accepting a confirmation prompt.
- Creates a copy of the item in the directory.
- Configure Permission
- Configure the permission levels of the item, allowing players of your choice to view or modify the item in the directory.
- Export Data
- Exports the item's data as a JSON file on your computer.
- Import Data
- Imports data into the item from a JSON file on your computer.
Gamemasters, Assistants, and other players with permissions to view items can do so by double-clicking on an item in the Items Directory. This opens the item sheet, whose features depend on the sheet itself or the system being used.
When an Item is added to an Actor, it becomes an "Embedded Entity" which is called an Owned Item. These Owned Items appear in the Actor sheet and, depending on the system, can be used by the actor. Dragging an item from the directory onto an actor's sheet will create a copy of the item as an "Owned Item". This owned item is separate from the original item - changes in the original item will not affect the owned item, and vice versa. Additionally, this owned item is not accessed from the Items Directory - it can only be viewed through the actor's sheet.
When a new World is first created, the Items Directory will initially be empty. Though items can be created fairly quickly from scratch, it may be desirable to import items from pre-configured sources.
Importing from Compendium
An item can be imported from a compendium by either dragging the item from the compendium into the Items Directory, or by right-clicking the item in the compendium and selecting "Import".
Importing from JSON
If the system and modules your world uses provide no compendiums, you can still import items directly from a JSON file. This JSON file is created by right-clicking an item in the Directory and selecting "Import Data" to import the JSON data into that item. This will overwrite the item.
To interact with Item entities programmatically, you will primarily use the following API concepts: