/foundryvtt-downtime-dnd5e

A module for Foundry VTT that allows users to keep track of downtime activities, quest progress and... Well, pretty much anything you can track with a loading bar and a %.

Primary LanguageJavaScriptMIT LicenseMIT

Downtime Dnd5e

Latest Release Download Count

Forge Installs

Foundry Core Compatible Version

Latest Version

Foundry Hub Endorsements

GitHub all releases

Translation status

If you want to buy me a coffee alt-text

So this is another downtime project because Crash's Tracking & Training (formerly known as Crash's Downtime Tracking) is no Longer Being Maintained and Ethck's 5e Downtime Tracking is not been updated for a while.

This project was created as a continuation of the crash project Crash's Tracking & Training (formerly known as Crash's Downtime Tracking) but with the code rewritten to follow "standard" development rules like use the module id as prefix for the css rule, the standard folder structure ecc.

I will try on god time will to "merge" these two modules.

Does your group do a lot of downtime activities? Got a lot of factions? Need a simple quest log or timer? Do you have a hard time keeping track of... well... anything? Then this is the mod for you!

Downtime 5e is a module for the dnd5e system in Foundry VTT that adds a tab to all actor sheets (character and NPC) that lets you add and keep track of just about anything you can keep track of with a number and a progress bar. Finally working on that History proficiency? It's in here. Learning how to use thieves tools? In here. Need to keep track of how much of the town's water supply you've accidentally (I hope) poisoned? Quest progress! Countdown timers! Faction reputation! If you can measure it with a percentage, you can track it with this module.

NOTE: This module is under maintenance, I have no plans to update or add features. However, I will try to fix any bugs as possible. Any contribution is welcome.

Installation

It's always easiest to install modules from the in game add-on browser.

To install this module manually:

  1. Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
  2. Click "Install Module"
  3. In the "Manifest URL" field, paste the following url: https://raw.githubusercontent.com/p4535992/foundryvtt-downtime-dnd5e/master/src/module.json
  4. Click 'Install' and wait for installation to complete
  5. Don't forget to enable the module in game using the "Manage Module" button

Ethck's 5e Downtime Tracking is not touched for over 10 months mod focuses more on the implementation of "skill challenge" type downtime activities like the ones you find in xanathar's guide to everything. it lets you construct activities that are made up of multiple rolls, maybe for different skills/abilities/etc that you have to choose between, creating a sort of branching structure with varying dc's for each one. it gives you different outputs depending on how many successes/failures you get and how the activity is configured

Crash's Tracking & Training (formerly known as Crash's Downtime Tracking) is no Longer Being Maintained mod is more of a general progress tracking tool. it's a little bit more flexible/less specifically scoped and the activities you can create are nowhere near as complex as his, but it's more useful for tracking things that take multiple days/weeks to complete and things that are less "one and done".

Downtime Dnd5e This project was created as a continuation of the crash project Crash's Tracking & Training (formerly known as Crash's Downtime Tracking) but with the code rewritten to follow "standard" development rules like use the module id as prefix for the css rule, the standard folder structure ecc.

How To Use

Check out the wiki for instructions, screenshots, sample macros, compatibility info, API documentation, and more!

Got Questions? Find a Bug?

Create an issue right here on GitHub. If it's a critical/breaking bug, I'll try to fix it when I can. Feature requests likely won't be worked on unless I can find a use case for them with my groups that use this.

Api

game.modules.get('downtime-dnd5e').api.updateActivityProgress(actorName, itemName, newProgress) => Promise<Void>

game.modules.get('downtime-dnd5e').api.getActivitiesForActor(actorName) => List of Activities Objects

game.modules.get('downtime-dnd5e').api.getActivity(actorName, itemName) => Activity Object

Build

Install all packages

npm install

dev

dev will let you develop you own code with hot reloading on the browser

npm run dev

npm build scripts

build

build will build and set up a symlink between dist and your dataPath.

npm run build

build-watch

build-watch will build and watch for changes, rebuilding automatically.

npm run build-watch

prettier-format

prettier-format launch the prettier plugin based on the configuration here

npm run-script prettier-format

Issues

Any issues, bugs, or feature requests are always welcome to be reported directly to the Issue Tracker, or using the Bug Reporter Module.

License

This package is under an MIT license and the Foundry Virtual Tabletop Limited License Agreement for module development.

Attributions and Special Thanks