/fvtt-party-sheet

A module for FoundryVTT providing a system-agnostic JSON-templated party sheet.

Primary LanguageJavaScriptMIT LicenseMIT

fvtt-party-sheet - A FoundryVTT Module

Latest Release Download Count Forge Installs Foundry Hub Endorsements Foundry Hub Comments

Links

Upcoming Changes Template Readme Template List
Link Link Link

About

This module provides a GM with a table of characters in order to quickly see their important stats, traits, abilites, etc. Originally 5e only, it is now system agnostic and you can create easy to make .json templates for your system. It supports native Foundry and The Forge. Complete instructions for creating templates and placing them in the right folder on Foundry and Forge are included in the TEMPLATE_README.md file.

If you create a template, please submit it via email or GitHub as a Pull Request, and we will include it in future updates with full credit.

See upcoming changes in the UPCOMING_CHANGELOG.md

Features

  • Adds a 'Party Sheet' similar to that provided by Fantasy Grounds. Just click the Party Sheet icon on the Tokens Controls sub-menu.

    • The Party Sheet can be configured via the options to either display only currently connected players, or all non-npc characters. When using the all-characters display, there is a separate dialog to allow hiding of any characters the DM doesn't need to worry about. See the TEMPLATE_README.md file for instructions on how to create a json file for your own system.

    • Clicking a character portrait will open their sheet.

    • The Party Sheet is no longer bound to simply the built-in dnd5e system. Additional systems can be supported by writing a JSON file following the guidelines in TEMPLATE_README.md and placing it in either:

      • Native Foundry: your <FOUNDRY_VTT/Data/partysheets/> folder.
      • The Forge: the folder named at the top level of your assets library (created by the module).

Systems & Templates

Template Examples

For a comprehensive list of the pre-made templates provided by this module and screenshots of each, please see TEMPLATE_LIST.md or examine the contents of the example_templates folder.

Making your own system template

Please see the TEMPLATE_README.md for information on how to create your own template.

Template Installation

If using native Foundry, place the templates you wish to use in the <FOUNDRY_VTT/Data/partysheets/> folder.

If using The Forge, this module will create a folder at the top level of your Assets Library named partysheets. Place your templates in this folder.

If using The Forge, install the module on your local Foundry installation to have access to the example_templates folder, and to upload any you would like to use to your Assets Library in the folder at the top level. Or, if you haven't installed Foundry and only used the license key on The Forge, use the GitHub link above. In this case, you will have to download the file to your computer, then upload it to The Forge. If you create a template, please submit it via email or GitHub, and we will include it in future updates with full credit.

API

Functionality for macros/etc is exposed behind game["fvtt-party-sheet"].api.XXXXX

Current Function List:

  • togglePartySheet - Toggles the party open or closed.

Support

Feel free to file a Bug Report / Feature Request under the Issues tab of Github.

Screenshots

Primary Icon:

Party Sheet Icon

Party Sheet Window:

Preview of Plugin Party Sheet - Only Connected Players

Contributions

To contribute a translation or template, either:

  1. Open a PR with the necessary new files and appropriate changes to the codebase
  2. Open an issue and attach the relevant files.

Unit Testing

This module uses a mix of jest and playwright. New tests, or enhancements to the testing pipeline, are always welcome.