numberq
/
foundry
1
0
Fork 0
Code Releases 1 Activity
All user data for FoundryVTT. Includes worlds, systems, modules, and any asset in the "foundryuserdata" directory. Does NOT include the FoundryVTT installation itself.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
22 Commits
1 Branch
1.7 GiB
Tree: 3231847b45
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3231847b45'
${ noResults }
foundry/Data/modules/combat-utility-belt/README.md

206 lines
17 KiB
Raw Normal View History

Initial commit
1 year ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. <div id="death-save-social" style="height:36px; background:rgba(255, 255, 255, 0.7); display: flex;text-align:center; padding-top:2px">
  2. <span style="flex:1;">
  3. <a href="https://discord.gg/wwH7DQc" title="Discord"><img height="32" src="https://cdn.jsdelivr.net/npm/simple-icons@v4/icons/discord.svg"/></a></span>
  4. <span style="flex:1">
  5. <a href="https://twitter.com/death_save_dev" title="Twitter"><img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@v4/icons/twitter.svg" /></a></span>
  6. <span style="flex:1">
  7. <a href="https://twitch.tv/teamDEATHSAVE" title="Twitch"><img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@v4/icons/twitch.svg" /></a></span>
  8. <span style="flex:1">
  9. <a href="https://www.youtube.com/channel/UCxhr66d1sjfXU4SQ5MEqPvg" title="YouTube"><img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@v4/icons/youtube.svg" /></a></span>
  10. </div><br/>
  11. 

  12. ![https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fversion%3Fstyle%3Dflat%26url%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fdeath-save%2Fcombat-utility-belt%2Fmaster%2Fmodule.json](https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fversion%3Fstyle%3Dflat%26url%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fdeath-save%2Fcombat-utility-belt%2Fmaster%2Fmodule.json)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
  13. [![All Contributors](https://img.shields.io/badge/all_contributors-30-orange.svg?style=flat-square)](#contributors-)
  14. <!-- ALL-CONTRIBUTORS-BADGE:END -->
  15. 

  16. ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/death-save/combat-utility-belt) 
  17. [![GitHub downloads (latest)](https://img.shields.io/badge/dynamic/json?label=Downloads@latest&query=assets[?(@.name.includes('zip'))].download_count&url=https://api.github.com/repos/death-save/combat-utility-belt/releases/latest&color=green)](https://github.com/death-save/combat-utility-belt/releases/latest)
  18. [![Forge Installs](https://img.shields.io/badge/dynamic/json?label=Forge%20Install%20Base&query=package.installs&suffix=%&url=https://forge-vtt.com/api/bazaar/package/combat-utility-belt&colorB=brightgreen)](https://forge-vtt.com/)
  19. 

  20. 

  21. # Combat Utility Belt

  22. *made with ❤ by [DEATH SAVE DEVELOPMENT](https://deathsave.dev)*
  23. 

  24. 

  25. ---
  26. **[📚Wiki/How-To](https://github.com/death-save/combat-utility-belt/wiki)**    
  27. **[🐛Issues/Bugs](https://github.com/death-save/combat-utility-belt/issues)**    
  28. **[💬Contact](#death-save-social)**    
  29. **[📜Changelog](https://github.com/death-save/combat-utility-belt/blob/master/CHANGELOG.md)**    
  30. **[📦Installation](#installation)**    
  31. **[🛠 Gadgets](#gadgets)**    
  32. **[👏Thanks/Attribution](#thanksattribution)**
  33. 

  34. ---
  35. > Every ~~hero~~ GM needs gadgets to keep their game safe from dastardly players up to no good! And where better to store those gadget than on your very own Combat Utility Belt!    

  36. This handy-dandy combat aid comes packed with a bunch of gadgets to ensure you get a TPK every time...
  37. ## Features (Gadgets)

  38. ### Core

  39. * CUBputer
  40. * Enhanced Conditions
  41. * Triggler
  42. ### Additional

  43. * Hide Names
  44. * Award XP
  45. * Pan/Select
  46. * Reroll Initiative
  47. * Temporary Combatants
  48. * Miscellaneous Actor/Token
  49. ### D&D5e specific

  50. * Concentrator
  51. * Mighty Summoner
  52. 

  53. 

  54. # Installation

  55. ~~Simply wrap the belt around your waist and affix the clasp.~~
  56. 

  57. 1. Navigate to the Foundry Setup screen and click on the Modules tab
  58. 2. Click Install Module and look for Combat Utility Belt
  59. 3. Once the Combat Utility Belt is installed, open your desired world and ~~wreak havoc on your players~~ navigate to the **Settings > Manage Modules** and enable the module then **Settings > Module Settings** and enable the gadget settings you want!
  60. 

  61. 

  62. # Gadgets

  63. <details>
  64.   <summary>Click to show</summary>
  65.   
  66. ## Award XP

  67. Provides an option to distribute XP to player-characters at the end of combat
  68. 

  69. ## Concentrator

  70. *(D&D5e only)*
  71. 

  72. ![concentrator](https://github.com/death-save/media/blob/master/combat-utility-belt/concentrator.gif)
  73. 

  74. A DM is responsible for all sorts of things, but keeping track those pesky spell casters and their concentration is one more thing that you shouldn't have to worry about!
  75. 

  76. With this gadget, you can make sure that those *irritating* spellcasters are always checked whenever the concentrating status is applied. Now they'll be careful about getting hit by that goblin sneaking around!
  77. 

  78. ## CUBputer

  79. Although it's not technically a gadget, think of the CUBputer as the control room for your ~~evil~~ operation. Provides critical configuration options for CUB's gadgets.
  80. 

  81. ## Enhanced Conditions

  82. 

  83. ![enhanced-conditions](https://github.com/death-save/media/blob/master/combat-utility-belt/enhanced-conditions.gif)
  84. 

  85. It's not enough to *show* your players when their poisoned, you want to really drive it  home by linking the condition so they can wallow in misery as they fail their ability checks.
  86. 

  87. This gadget creates a dynamo-powered link between status effect icons and reference entries (Journal, Item, or compendium) with further info on that status effect.
  88. 

  89. ### Condition Lab

  90. 

  91. The ideal place to concoct your ~~nefarious~~ heroic combination of status icons and condition names, as well as link Conditions to Active Effects.
  92. 

  93. *I like the Deadly STD one!*
  94. 

  95. ## Hide Names

  96. 

  97. ![hide-npc-names](https://github.com/death-save/media/blob/master/combat-utility-belt/hide-npc-names.gif)
  98. 

  99. Maybe you forgot that your NPC's name reveals a dark secret about their past, or maybe you forgot to give them a name.
  100. 

  101. Fret no more, for this gadget replaces NPC names with a replacement of your choice. Personally, I'm a fan of Melvin.
  102. 

  103. 

  104. ## Mighty Summoner

  105. *(D&D5e only) Druid Circle of the Shepherd class feature support*    
  106. Rolls additional dice for summoned creatures
  107. 

  108. ## Miscellaneous Actor/Token Enhancements

  109. 

  110. ### Quick Edit Token Resource from Combat Tracker

  111. Easily edit your tracked token resource directly from the Combat Tracker
  112. 

  113. ### Roll Hostile HP

  114. Roll token HP when dropping on the scene
  115. 

  116. ### Token Effect Icon Size

  117. Select from a range of options to set the size of status effect icons on tokens
  118. 

  119. ## Pan/Select

  120. Pans the camera to and/or selects active combatants during combat
  121. 

  122. ## Reroll Initiative

  123. 

  124. ![reroll-initiative](https://github.com/death-save/media/blob/master/combat-utility-belt/reroll-initiative.gif)
  125. 

  126. The BBEG rolled a 2 for initiative? Not anymore! This gadget rerolls initiative for all combatants each round.
  127. 

  128. Glorious chaos!
  129. 

  130. ## Temporary Combatants

  131. Track lair actions, environmental effects and more as Temporary Combatants that last only as long as the current combat encounter!
  132. 

  133. ## Triggler

  134. Trigger the addition or removal of Conditions, and/or the execution of Macros based on changes to actor/token properties such as HP
  135. </details>
  136. 

  137. ---
  138. 

  139. # Thanks/Attribution

  140. Firstly thank you to all my [patrons](https://patreon.com/deathsave), you make module development extra special!
  141. 

  142. Secondly I want to shout out the awesome contributors for this module (see: [contributors](#contributors-)). Whether it's code, translations, or bugs/suggestions, without your help Combat Utility Belt would not be as awesome as it is! 
  143. 

  144. I would also like to acknowledge that many of the functions found in the Combat Utility Belt are inspired by [Roll20 API scripts](https://github.com/RobinKuiper/Roll20APIScripts) written by @RobinKuiper (namely the Combat Tracker, Death Tracker and StatusInfo ones).
  145. 

  146. Concentration icon made by [Freepik](https://www.flaticon.com/authors/freepik) from [Flat Icon](www.flaticon.com)
  147. 

  148. ## Donations/Sponsorship

  149. Any support you can provide is greatly appreciated! Check out the `Sponsor this project` section in the right-hand sidebar.
  150. 

  151. ## Contributors ✨

  152. 

  153. Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
  154. 

  155. <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
  156. <!-- prettier-ignore-start -->
  157. <!-- markdownlint-disable -->
  158. <table>
  159.   <tr>
  160.     <td align="center"><a href="https://github.com/Reaver01"><img src="https://avatars3.githubusercontent.com/u/1864450?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Reaver01</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=Reaver01" title="Code">💻</a></td>
  161.     <td align="center"><a href="https://swendrowski.us"><img src="https://avatars1.githubusercontent.com/u/15639841?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cody Swendrowski</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=cswendrowski" title="Code">💻</a></td>
  162.     <td align="center"><a href="https://github.com/JacobMcAuley"><img src="https://avatars2.githubusercontent.com/u/12160735?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jacob McAuley</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=JacobMcAuley" title="Code">💻</a></td>
  163.     <td align="center"><a href="https://github.com/Moerill"><img src="https://avatars1.githubusercontent.com/u/26152015?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Moerill</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=Moerill" title="Code">💻</a></td>
  164.     <td align="center"><a href="https://github.com/BrotherSharper"><img src="https://avatars3.githubusercontent.com/u/41280723?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Brother Sharp</b></sub></a><br /><a href="#translation-BrotherSharper" title="Translation">🌍</a></td>
  165.     <td align="center"><a href="https://github.com/drdwing"><img src="https://avatars1.githubusercontent.com/u/66671688?v=4?s=100" width="100px;" alt=""/><br /><sub><b>drdwing</b></sub></a><br /><a href="#translation-drdwing" title="Translation">🌍</a></td>
  166.     <td align="center"><a href="https://github.com/rinnocenti"><img src="https://avatars3.githubusercontent.com/u/3178127?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Renato Innocenti</b></sub></a><br /><a href="#translation-rinnocenti" title="Translation">🌍</a></td>
  167.   </tr>
  168.   <tr>
  169.     <td align="center"><a href="https://github.com/HonzoNebro"><img src="https://avatars2.githubusercontent.com/u/5500663?v=4?s=100" width="100px;" alt=""/><br /><sub><b>HonzoNebro</b></sub></a><br /><a href="#translation-HonzoNebro" title="Translation">🌍</a></td>
  170.     <td align="center"><a href="https://github.com/apoapostolov"><img src="https://avatars0.githubusercontent.com/u/4083812?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Apostol Apostolov</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/issues?q=author%3Aapoapostolov" title="Bug reports">🐛</a></td>
  171.     <td align="center"><a href="https://github.com/Zamrod"><img src="https://avatars1.githubusercontent.com/u/12570777?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Zamrod</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/issues?q=author%3AZamrod" title="Bug reports">🐛</a></td>
  172.     <td align="center"><a href="https://github.com/Rawrly85"><img src="https://avatars3.githubusercontent.com/u/53245027?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rawrly85</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/issues?q=author%3ARawrly85" title="Bug reports">🐛</a></td>
  173.     <td align="center"><a href="http://stu.scot"><img src="https://avatars1.githubusercontent.com/u/6506599?v=4?s=100" width="100px;" alt=""/><br /><sub><b>STU</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=grandseiken" title="Code">💻</a></td>
  174.     <td align="center"><a href="https://github.com/MikauSchekzen"><img src="https://avatars0.githubusercontent.com/u/2879734?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tijmen Bok</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=MikauSchekzen" title="Code">💻</a></td>
  175.     <td align="center"><a href="https://github.com/shaun-newsome"><img src="https://avatars0.githubusercontent.com/u/7287194?v=4?s=100" width="100px;" alt=""/><br /><sub><b>shaun-newsome</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=shaun-newsome" title="Code">💻</a></td>
  176.   </tr>
  177.   <tr>
  178.     <td align="center"><a href="https://github.com/tposney"><img src="https://avatars2.githubusercontent.com/u/4486143?v=4?s=100" width="100px;" alt=""/><br /><sub><b>tposney</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=tposney" title="Code">💻</a></td>
  179.     <td align="center"><a href="https://github.com/tpendragon"><img src="https://avatars1.githubusercontent.com/u/2806645?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Trey Pendragon</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=tpendragon" title="Code">💻</a></td>
  180.     <td align="center"><a href="https://github.com/hmqgg"><img src="https://avatars1.githubusercontent.com/u/36689909?v=4?s=100" width="100px;" alt=""/><br /><sub><b>hmqgg</b></sub></a><br /><a href="#translation-hmqgg" title="Translation">🌍</a></td>
  181.     <td align="center"><a href="https://github.com/SalieriC"><img src="https://avatars1.githubusercontent.com/u/1230041?v=4?s=100" width="100px;" alt=""/><br /><sub><b>SalieriC</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/issues?q=author%3ASalieriC" title="Bug reports">🐛</a></td>
  182.     <td align="center"><a href="http://sleys.net/blog"><img src="https://avatars2.githubusercontent.com/u/105347?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bob Sleys</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/issues?q=author%3Absleys" title="Bug reports">🐛</a></td>
  183.     <td align="center"><a href="https://github.com/trdischat"><img src="https://avatars1.githubusercontent.com/u/52774325?v=4?s=100" width="100px;" alt=""/><br /><sub><b>trdischat</b></sub></a><br /><a href="#ideas-trdischat" title="Ideas, Planning, & Feedback">🤔</a></td>
  184.     <td align="center"><a href="https://github.com/kandashi"><img src="https://avatars2.githubusercontent.com/u/1347785?v=4?s=100" width="100px;" alt=""/><br /><sub><b>kandashi</b></sub></a><br /><a href="#ideas-kandashi" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/death-save/combat-utility-belt/issues?q=author%3Akandashi" title="Bug reports">🐛</a> <a href="#question-kandashi" title="Answering Questions">💬</a></td>
  185.   </tr>
  186.   <tr>
  187.     <td align="center"><a href="https://github.com/DanOrc"><img src="https://avatars1.githubusercontent.com/u/9914380?v=4?s=100" width="100px;" alt=""/><br /><sub><b>DanOrc</b></sub></a><br /><a href="#ideas-DanOrc" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/death-save/combat-utility-belt/issues?q=author%3ADanOrc" title="Bug reports">🐛</a> <a href="#question-DanOrc" title="Answering Questions">💬</a></td>
  188.     <td align="center"><a href="https://github.com/acd-jake"><img src="https://avatars1.githubusercontent.com/u/67855941?v=4?s=100" width="100px;" alt=""/><br /><sub><b>acd-jake</b></sub></a><br /><a href="#translation-acd-jake" title="Translation">🌍</a></td>
  189.     <td align="center"><a href="https://github.com/FuyuEnnju"><img src="https://avatars.githubusercontent.com/u/55729032?v=4?s=100" width="100px;" alt=""/><br /><sub><b>长耳</b></sub></a><br /><a href="#translation-FuyuEnnju" title="Translation">🌍</a></td>
  190.     <td align="center"><a href="https://github.com/Wibble199"><img src="https://avatars.githubusercontent.com/u/3984322?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Will Bennion</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=Wibble199" title="Code">💻</a></td>
  191.     <td align="center"><a href="https://github.com/flamewave000"><img src="https://avatars.githubusercontent.com/u/3588046?v=4?s=100" width="100px;" alt=""/><br /><sub><b>flamewave000</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=flamewave000" title="Code">💻</a></td>
  192.     <td align="center"><a href="https://github.com/WallaceMcGregor"><img src="https://avatars.githubusercontent.com/u/17795541?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WallaceMcGregor</b></sub></a><br /><a href="#translation-WallaceMcGregor" title="Translation">🌍</a></td>
  193.     <td align="center"><a href="https://github.com/Hertzila"><img src="https://avatars.githubusercontent.com/u/7857080?v=4?s=100" width="100px;" alt=""/><br /><sub><b>hertzila</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=hertzila" title="Code">💻</a></td>
  194.   </tr>
  195.   <tr>
  196.     <td align="center"><a href="https://github.com/Autmor"><img src="https://avatars.githubusercontent.com/u/66399049?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Autmor</b></sub></a><br /><a href="https://github.com/death-save/combat-utility-belt/commits?author=Autmor" title="Code">💻</a></td>
  197.     <td align="center"><a href="https://github.com/MichalGolaszewski"><img src="https://avatars.githubusercontent.com/u/46850235?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michał Gołaszewski</b></sub></a><br /><a href="#translation-MichalGolaszewski" title="Translation">🌍</a></td>
  198.   </tr>
  199. </table>
  200. 

  201. <!-- markdownlint-restore -->
  202. <!-- prettier-ignore-end -->
  203. 

  204. <!-- ALL-CONTRIBUTORS-LIST:END -->
  205. 

  206. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!