-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #52 from crash1115/dev
v0.6.0
- Loading branch information
Showing
47 changed files
with
2,762 additions
and
1,361 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,23 @@ | ||
|    | ||
|
|
||
| # Crash's Tracking & Training (5e) | ||
| Does your group do a lot of downtime activities? Do you have a hard time keeping track of it all? Then this is the mod for you! | ||
|
|
||
| Tracking & Training 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 downtime activities. 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? If you can measure it with a percentage, you can track it in here. | ||
|
|
||
| [](https://gyazo.com/7f072b341c266eed397c772b0328c542) | ||
|
|
||
| ## Example Uses | ||
| Check out some examples for how to use the module [here](/examples.md). | ||
|
|
||
| ## Multiple Progression Systems | ||
| There are three core ways to track activities in this module, and one extra fancy bonus way: | ||
|
|
||
| **Simple Progression** is exactly what it says on the tin. Every attempt to progress the activity adds one to the progress score. Just set the completion threshold based on the number of attempts you'd like the activity to take. This is handy for things with static requirements like scribing spells, or anything you just need a simple way to track. Hence the name, Simple Mode. | ||
|
|
||
| [](https://gyazo.com/5f7d0c52b2e1632dceebe94f5de842d4) | ||
|
|
||
| **Ability(/Skill/Tool) Check Progression** is the fun stuff. When you set up an activity that uses this mode, you also select an associated ability, skill, or tool to go along with it. Every attempt to progress the activity prompts the player for an ability/skill/tool check. Currently, this uses the core 5e roll system and prompts for advantage/disadvantage, and modifiers. The check is rolled, and the total gets added to the progress score. | ||
|
|
||
| [](https://gyazo.com/83287fa524afe4fc618d0c9014b66bff) | ||
|
|
||
| **Check With DC Progression (v0.4.0+)** is a hybrid of the first two modes. This progression mode prompts the player to make a skill, ability, or tool check against a set DC. If the roll is successful, the progression score increases by one. If the roll fails, no progress is gained. Currently, this uses the core 5e roll system and prompts for advantage/disadvantage, and modifiers. | ||
|
|
||
| [](https://gyazo.com/75ff889b77d7a3e1aced719503cf3eeb) | ||
|
|
||
| **Macro Progression (v0.5.0+)** is the fancy stuff. Throw in the name of a macro you'd like to run when you click on an activity, then reference this module's API to do all sorts of neat stuff. | ||
|
|
||
| ## Customizable | ||
| Several settings allow you to get the functionality you want out of the module. Current settings allow you to: | ||
| - Enable and disable the tab on actor sheets. | ||
| - Customize the name of the Downtime tab. Wanna call it "Training" because you only use it for skill proficiencies? You got it. Need to call it "Oh No, Not Again" because your players are just *like that*? You can do that, too. I've totally been there. | ||
| - Set defaults for each type of downtime activity progression. If you want really slow progression, you can make it happen. If you want to really reward your players for taking the time to train stuff by letting them do it quickly, you can do that, too. Go wild. Find whatever works for you. | ||
| - Choose which types of actors display activity completion notifications. | ||
| - Choose whether or not to show the activities tab to players, or only the GM. | ||
|
|
||
| ## Speedy Progress Updates | ||
| You know what sucks? Accidentally rolling with disadvantage when you didn't mean to. If something gets messed up, or if you need to adjust a progress value quickly, we got you covered. You can edit progress values right from the activity's entry! The input accepts relative and absolute values, so entering "-15" will subtract 15 from the progress total, and entering "57" will set it to 57. | ||
|
|
||
| [](https://gyazo.com/338f2a9c664e7f0361fb8721ba85ad72) | ||
|
|
||
| ## Activity Completion Notifications (v0.2.0+) | ||
| Want the whole world to know your ranger finally finished that Animal Handling proficiency that they should have taken at level 1? You can do it. Want to broadcast the completion of each stage of the BBEG's plans? You can do that too. Set the module to display chat cards for PC's, NPC's, both, or neither if that's your jam. | ||
| [] | ||
|
|
||
| [](https://gyazo.com/134ff41df1018f6057b46f799fd22843) | ||
|
|
||
| ## Audit Log (v0.3.0+) | ||
| Sometimes we forget things. Sometimes we mess up. Version 0.3.0 of the module adds a handy change log so you can keep track of what's been done. GM's have the ability to dismiss items from the log so it doesn't get cluttered up with stuff you did last year. | ||
|
|
||
| [](https://gyazo.com/5fa7f966fd12c3ad321bb2bf4359be55) | ||
|
|
||
| ## Localization (v0.3.0+) | ||
| This module includes support for localization. Currently supported languages are: | ||
| - English | ||
| - Korean | ||
|    | ||
|
|
||
| If you'd like to contribute, please get in touch with me or create a pull request (use the `dev` branch) with your translations. For existing translations, new keys may get added as the module is updated so keep checking back to make sure you're up to date. | ||
| 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! | ||
|
|
||
| ## Compatibility | ||
| ### Supported Modules | ||
| - Should work with most alternate sheet modules | ||
| Tracking & Training 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. | ||
|
|
||
| ### Unsupported Modules | ||
| - Obsidian (no plans to support at this time) | ||
| - MARS 5e (I'm currently looking into what it'll take to support this, but haven't yet had the time) | ||
| ## How To Use | ||
| Check out the [wiki](https://github.com/crash1115/5e-training/wiki) for instructions, screenshots, sample macros, compatibility info, API documentation, and more! | ||
|
|
||
| ## Got Questions? Find a Bug? | ||
| Contact me on Discord (CRASH1115#2944) to chat, or create an issue right here on GitHub. | ||
|
|
||
| ## Attributions and Special Thanks | ||
| - Thanks to platypus_pi for help with English localization | ||
| - Thanks to KLO#1490 for Korean localization | ||
| - Thanks to hmqgg#5775 for Chinese localization | ||
| - Thanks to platypus_pi for help with English translations | ||
| - Thanks to KLO#1490 for Korean translations | ||
| - Thanks to hmqgg#5775 for Chinese translations | ||
| - Thanks to MS-PBS for Spanish translations | ||
|
|
||
| ## License | ||
| - This work is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode). | ||
| - This work is licensed under the [Foundry Virtual Tabletop EULA - Limited License Agreement for Module Development](https://foundryvtt.com/article/license/). | ||
|
|
||
|
|
||
| # API Info | ||
| This is sort of a work in progress, but here's what's available. | ||
|
|
||
| ### CrashTNT.updateActivityProgress(actorName, itemName, newProgress) | ||
| Ex: `CrashTNT.updateActivity("Nazir", "Smithing Proficiency", 75)` | ||
|
|
||
| Params | ||
| - `actorName` is a string that matches the name of the actor that owns the Activity you'd like to change. It's case sensitive. | ||
| - `itemName` is a string that matches the name of the Activity you'd like to updatee. It's case sensitive. | ||
| - `newProgress` is an integer. This is the value you'd like to set the activity's progress to. | ||
|
|
||
| Returns | ||
| - Nothing. This method will update the selected Activity, replacing the value of the `progress` property with the value provided. | ||
|
|
||
| --- | ||
|
|
||
| ### CrashTNT.getActivitiesForActor(actorName) | ||
| Ex: `CrashTNT.getActivitiesForActor("Mary Sue")` | ||
|
|
||
| Params | ||
| - `actorName` is a string that matches the name of the actor you'd like to get activities for. It's case sensitive. | ||
|
|
||
| Returns | ||
| - An array of Activity objects | ||
|
|
||
| --- | ||
|
|
||
| ### CrashTNT.getActivity(actorName, itemName) | ||
| Ex: `CrashTNT.getActivity("Val Fletcher", "Craft Magic Armor")` | ||
|
|
||
| Params | ||
| - `actorName` is a string that matches the name of the actor that owns the activity you're trying to get. It's case sensitive. | ||
| - `itemName` is a string that matches the name of the activity you're trying to get. It's case sensitive. | ||
|
|
||
| Returns | ||
| - An single Activity object |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.