EddieDover / fvtt-party-sheet

A module for FoundryVTT providing a system-agnostic JSON-templated party sheet.
MIT License
2 stars 3 forks source link
foundry foundry-vtt foundryvtt

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

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:

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.