Welcome to Roll Stats, a utility for breaking down and analyzing FoundryVTT (Virtual Tabletop) JSON databases (ldb) to provide an easily digestible format for game masters and players alike.
- Parses FoundryVTT ldb files to generate meaningful statistics.
- Displays data in an easy-to-read format for quick insights.
- Helps game masters understand trends in dice rolls, player activity, and more.
- Download the
roll-stats-AllInOne.zipfile from the repository and unzip it.
Make sure to shut down FoundryVTT before proceeding.
-
Enter the newly created folder and install the required dependencies (or run install.bat):
npm install
Note: Ensure you have Node.js and npm installed. You can download Node.js, which includes npm, from https://nodejs.org/. Follow the instructions for your operating system to complete the installation. The
levellibrary is required forldb-reader.jsto work properly, and thepackage.jsonfile includes this dependency, so runningnpm installwill handle it for you. -
Run the program:
roll-stats.exe
-
Target the
/messagesfolder in your FoundryVTT instance. Make sure FoundryVTT is completely shut down before proceeding. For example, it may be located at:C:\Users\yourusername\Desktop\FoundryVTT\Data\worlds\yourworldname\data\messages
- Ensure you have a
.ldbfile exported from FoundryVTT. - Provide the
.ldbfile as an input to Roll Stats. - View the detailed breakdown of statistics in the output.
After running Roll Stats, you will receive a report that includes:
- Total number of rolls made.
- Breakdown of rolls by player.
- Frequency of natural 1s and 20s.
- Average rolls and critical success rates.
This makes it easier for you to analyze gameplay behavior and ensure everyone has a fair and enjoyable experience.
Contributions are welcome! If you'd like to help improve Roll Stats, feel free to:
- Fork this repository.
- Create a new branch for your feature or bug fix.
- Submit a pull request with a detailed explanation of your changes.
This project is licensed under the MIT License. See the LICENSE file for details.
If you encounter any issues or have suggestions, please open an issue on the GitHub repo or reach out to me directly via GitHub.
Special thanks to the FoundryVTT community for inspiring this project and providing valuable feedback.
- Better instructions on how to merge characters.
- Newly merged characters should not be auto-selected, allowing users to merge more characters without additional clicks.
- Provide better information for the debug option and automatically redirect to the details tab instead of the results tab when debugging.
- The dialog box asking if you want to use
output.txtis deprecated and needs to be removed.