johnnolan / encounter-stats

Aims to give you a break down on stats from encounters to be able to look back and plan future enounters. Also to give the players a nice lookback at events that occured in a story format.
https://foundryvtt.com/packages/fvtt-encounter-stats
MIT License
12 stars 10 forks source link
foundry

Latest Release Download Count GitHub package.json version Forge Installs

GitHub Workflow Status license

Translation status

ko-fi

Encounter Statistics

Capture your Players attacks, damage, healing, dice rolls, custom events and more. Store the results into a Journal for individual encounters and the entire campaign.

Supported Systems

Supported Modules

Key points when using in conjunction with this module

Current features are

Example

Watch an overview of Encounter Stats on YouTube

Watch an overview of Encounter Stats on YouTube

Encounter Tracking

Party Summary

Example

Campaign Stats

Party Summary Campaign

Example Campaign

Example Dice Roll Streak Journal Entry

Simple Calendar Integration

If Simple Calendar module is enabled, the title of the Journal Entries will use the current day returned from it instead of the curent real world time.

Track your own custom Campaign Events

You can create your own events in the campaign journal to remember certain points in time. These can be created by Macros run by the GM/Player or other module developers can add them from their modules.

Example macros are included in the Compendium Macros section called Encounter Statistics. These include...

How to call the Hook

You can call the hook using the following example code.

Hooks.callAll(`encounter-stats.customEvent`, {
    EventName: "Expletive", // Unique name that all events triggered will be grouped by
    actorId: token.actor.id, // Optional actorId to assign the event to an individual Player
    FlavorText: formDataObject.expletive, // Whatever custom text you want to display
});

In the campaign report, the results look like so

Example Custom Campaign Report

Contributing

The contributing guidelines can be found in the CONTRIBUTING.md file.

Our Code of Conduct can also be found in the CODE_OF_CONDUCT.md file.

Translations

This project is setup to use Weblate to make it easier to create translations by the community.

If you are amazing and want to contribute then you can visit this projects Weblate page at https://weblate.foundryvtt-hub.com/engage/encounter-stats/ and add translations yourself to be shared with the community.

License

Encounter Statistics is released under the MIT License.

Contact

For issues, please raise a bug in Github and use the Report a Bug option in the settings to get debug information to help me reproduce the issue easily on my computer. I will try and fix things depending on fatherhood responsibilities https://github.com/johnnolan/encounter-stats/issues

You can also find me on the Foundry VTT Discord https://discord.gg/foundryvtt. My Discord Tag is JB#2780.