FG Forge - Developer Guide
FG Forge Access
Link: Fantasy Grounds Forge
NOTE: If you are receiving an error page that lists TOO_MANY_REDIRECTS or similar, this is because your Fantasy Grounds account has not yet been validated. Check your spam folder for an email requesting FG account email verification or contact Customer Support for more assistance.
The FG Forge supports rulesets, modules, extensions, portrait packs, token packs, and image packs.
FG Forge now has automated solutions for building Map Packs, Token Packs and Portrait Packs!
Module
Purpose:
Holds text, images, and tokens for an adventure, rulebook, reference, etc. It is displayed in the library, story lists, as well as under individual sections such as items, images, NPCs, etc. Modules are normally marked with compatibility for a specific ruleset, or set of rulesets.
File format:
Zip file with the extension name changed to mod.
Instructions for building a module
Extension
Purpose:
Extensions are loaded after a ruleset and they override the base functionality and/or graphic layout of the base system. They can be used to provide a new skin, or theme. They can also add, remove, or modify functionality. They are loaded by the Gamemaster (GM) and players connected to the GM will see the player version of any extension.
File Format:
Zip file with the extension name changed to ext.
Instructions for building an extension
Ruleset
Purpose:
A ruleset provides the graphical design and functionality for a game system. These rulesets can inherit from other rulesets, such as the built-in CoreRPG ruleset, in order to provide a base level of functionality common among all other rulesets. A custom ruleset will often define what the character sheet looks like, what data fields are important for game elements, such as NPCs, items, spells, etc., and also custom automation to help speed up and improve gameplay.
File format:
Zip file with the extension name changed to pak.
Instructions for building a ruleset
Portrait Pack
Purpose:
A portrait pack holds images that show up in the Assets Window under the Portraits section. These images can be JPG or PNG format.
NOTE: As of Fantasy Grounds Unity v4.4.0, image formats can be JPG, PNG, and WEBP.
File Format:
Zip file with the extension name changed to ppk.
Instructions for building a portrait pack
Token Pack
Purpose:
A token pack holds images that show up in the Assets Window under the Tokens section. These images can be JPG or PNG format.
NOTE: As of Fantasy Grounds Unity v4.4.0, image formats can be JPG, PNG, WEBP, and WEBM.
Thumbnail images for the Pack must be in PNG format.
File Format:
Zip file with the extension name changed to tpk.
Instructions for building a token pack
Image Pack
Purpose:
An image pack holds images that show up in the Assets Window under the Images section. These images can be JPG or PNG format.
NOTE: As of Fantasy Grounds Unity v4.4.0, image formats can be JPG, PNG, WEBP, and WEBM.
File Format:
Zip file with the extension name changed to ipk.
Instructions (same as token and portrait packs, but with different extension name).
F.A.Q.
Q: If a Forge item appears to be abandoned or hasn’t been updated in a long time, can I take it over and update it myself? What if I try to contact the developer and they don’t respond?
A: The original developer owns the copyright on their own code. We can delist an item on the Forge that is faulty; if the developer is unresponsive and we receive user complaints about it throwing errors. If it is simply not getting enhanced with new features, then this would be insufficient to delist it.
If the original developer agrees, we can transfer ownership to a new developer. Otherwise, you can create your own version of it with original code you wrote that does the same thing. If they include a license that allows distribution of derivative versions, then you can branch off a new version.
Send an email to developer_relations@smiteworks.com and let us know when you last attempted to contact the original developer. In the email, include your name, username, and link to the Forge item.