Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleClick here to show Table of Contents
Table of Contents

Data Folder

The Fantasy Grounds data folder is specified in the FG Settings when installing FG.

...

  • cache = Campaign data for campaigns you join.

  • campaigns = Campaigns. Campaign data for campaigns you host.

  • characters = Character data for Manage Characters mode.

  • extensions = Extensions. Optional ruleset modifications. (themes, house rules, new features, etc.)

  • modules = Modules. Option ruleset data packages.

  • portraits = Portraits. Images for PC portraits.

  • rulesets = Rulesets. Game system definition packages.

  • tokens = Tokens. Images for map tokens.

  • utilities = Utilities distributed with Fantasy Grounds (if any)

Rulesets

Installation: To install a new ruleset, just place the ruleset directory or PAK file into the rulesets subfolder of the FG data folder.

...

Troubleshooting: If the ruleset is not appearing on the launcher screen for Creating a New Campaign or Manage Characters, then make sure that a base.xml file exists in the root of the ruleset directory or PAK file.

Extensions

Installation: To install a new extension, just place the extension directory or EXT file into the extensions subfolder of the FG data folder.

...

Troubleshooting: If the extension is not appearing on the launcher screen when Creating a New Campaign or Manage Characters, then make sure that a extension.xml file exists in the root of the extension directory or EXT file. Also, make sure that the ruleset that the extension is supposed to be modifying is also installed and selected on the launcher screen.

Modules

Installation: To install a new module, just place the module MOD file into the modules subfolder of the FG data folder.

...

We recommend that all images included in modules do not exceed 2048 pixels in either width and height for maps and handouts. For tokens, we recommend keeping tokens around 100x100 for Medium size tokens. Large quantities and extreme image sizes can cause lag, and in some rare cases, memory issues on the player clients.

Portraits

Installation: To install new portraits, just place the PPK file or the image files into the portraits subfolder of the FG data folder. Portraits can be placed in folders for additional organization.

...

Any standard image file format can be used. The default portraits are 63x63 pixels. While any image file size can be used, larger image files can increase player connection times and network lag, and the extra resolution will not be used.

Tokens

GM Token Installation: To install new GM-only tokens, just place the image files into the tokens/host subfolder of the FG data folder. Tokens can be placed in folders for additional organization.
Shared Token Installation: To install new shared tokens, just place the image files into the tokens/shared subfolder of the FG data folder. Tokens can be placed in folders for additional organization.

...

Any standard image file format can be used. Most people use tokens at 50x50 pixel size. While any image file size can be used, larger image files can increase player connection times and network lag. This is especially true for shared tokens, since the shared token library is synchronized with the player cache on every session connect.

Campaign

The campaign folder is where FG stores all the information specific to each campaign. Each campaign will have it's own folder within the campaigns subfolder of the FG data folder. Generally, there is very little need to access the campaign folder, except to add images/maps.

...