Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

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.

License

Notifications You must be signed in to change notification settings

johnnolan/encounter-stats

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MODULE NOW DEPRECATED DUE TO OTHER COMMITMENTS xxx

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

  • dnd5e
  • pf2e (ALPHA - See the issues on github tagged PF2e for upcoming work)

Supported Modules

Key points when using in conjunction with this module

  • MIDI-QOL
    • You must use targeting in order for this module to record your stats correctly
  • Ready Set Roll for D&D5e
    • Does not track targeted enemies so saves and damage across multiple targets is not currently supported
    • Attack rolls do not count towards dice sprees

Current features are

  • Encounter/Combat tracking (Click for more details)
  • Campaign tracking (Click for more details)
  • Save Journal reports to PDF (Install Export Journal to HTML)
  • Track your own custom campaign events via Macros
  • Enemies must be targetted in order for kills to be registered
    • Multiple targets will show roll damage and roll damage x targets
  • Optional Simple Calendar Integration for nicer Journal Entry names
  • Can track multiple active combats at one time
  • Optionally saves raw data output as JSON to the journal entry so you can export and manipulate the data as you want
  • Import/Export campaign stats as JSON from the Settings menu.
    • All campaign stats are saved against the Gamemaster. If you delete the Gamemaster user you will lose your data.
    • Use this functionality to make backups before major changes to version upgrades and the Gamemaster user.
  • Dice Roll Streak tracking. Tracks how many times in a row you roll the same value on a d20 to the campaign journal and optionally to chat.

Example

Watch an overview of Encounter Stats on YouTube

Watch an overview of Encounter Stats on YouTube

Encounter Tracking

  • Party Encounter Statistics - aids with encounter design
    • Damage for encounter
    • Average damage per Round
    • Lowest round of damage
    • Highest round of damage
  • Players attacks
  • Damage
  • HP
  • Round Damage
  • Top stats
  • Healing
  • Kills
  • Support Actions
  • Battlefield Actions
  • Times a user has been downed
  • Overview of Encounter including Scene details and enemies faced

Party Summary

Example

Campaign Stats

  • Party Encounter Statistics - aids with encounter design
    • Damage for encounter
    • Average damage per Round
    • Lowest round of damage
    • Highest round of damage
  • Natural 1s
  • Natural 20s
  • Kills
  • Heals
  • Dice Roll Streaks
  • Your own custom events!

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...

  • HDYWTDT (Select token before running to assign the event to that actor)
  • Swear Word at the table (Select token before running to assign the event to that actor)
  • Every time food at the table consumed
  • Every time the GM says "You can certainly try"

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.

About

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.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published