Skip to content

Commit 068bbc4

Browse files
committed
Clarify names of few APIs & improves the menu descriptions on several APIs
1 parent 8ea5e0b commit 068bbc4

File tree

20 files changed

+29
-29
lines changed

20 files changed

+29
-29
lines changed

CharSheetUtils/script.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"script": "index.js",
44
"version": "1.0",
55
"previousversions": [],
6-
"description": "",
6+
"description": "This script provides a collection of utility functions for reading and writing attributes from a character sheet, including support for attributes in repeating sections and calculated attributes. This script does nothing on its own. It is a helper library meant to be used by other scripts.\nFull documentation for the functions provided by this script are given in the jsdoc annotations in the source code.\n\n* [Readme](https://github.com/Roll20/roll20-api-scripts/blob/master/CharSheetUtils/README.md)\n* [sourcecode](https://github.com/Roll20/roll20-api-scripts/blob/master/CharSheetUtils/src/index.js)",
77
"authors": "Stephen Lindberg",
88
"roll20userid": 46544,
99
"useroptions": [],

DL Darkness/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "dldark",
2+
"name": "DL Darkness",
33
"script": "dldark.js",
44
"version": "0.2",
5-
"description": "Creates a gridded circle based on a specific token on the Dynamic Lighting layer to be used as magical darkness\r**To use:**\r- Create a dummy character whose token has the desired size and image of the darkness generated (e.g. 20ft radius black circle)\r- Add an Ability macro to call the new !dldark script and set as a token action\r\r **Syntax**\r**!dldark <buffer> <makeGrid> <sendToMapLayer>**\r- **'buffer'** < # > //Optional. Default = 0\r //reduce the radius of the darkness by this many pixels.\r allows the source of the darkness to be seen at the outer border of the darkness.\r- **'makeGrid'** < true/false > //Optional. Default = true\r draw a grid inside of the darkness circle.\r the grid will be aligned with the map grid based on page settings\r- **'SendToMapLayer'** < true/false > //Optional. Default = true\r send the source token to the map layer after creating the DL path?\r if true, will send to map layer and perform a z-order 'ToFront'\r if false, will keep on token layer and perform a z-order 'ToBack'\r\r**Example Syntax**\r`!dldark`\r`!dldark 15 true`\r`!dldark ?{buffer radius?|15} true false`",
5+
"description": "Creates a gridded circle based on a specific token on the Dynamic Lighting layer to be used as magical darkness.\r**To use:**\r- Create a dummy character whose token has the desired size and image of the darkness generated (e.g. 20ft radius black circle)\r- Add an Ability macro to call the new `!dldark` script and set as a token action\r\r **Syntax**\r`!dldark buffer makeGrid sendToMapLayer `\r- `buffer` < # > //Optional. Default = 0\r //reduce the radius of the darkness by this many pixels.\r allows the source of the darkness to be seen at the outer border of the darkness.\r- `makeGrid` < `true`/`false` > //Optional. Default = true\r draw a grid inside of the darkness circle.\r the grid will be aligned with the map grid based on page settings\r- `SendToMapLayer` < `true`/`false` > //Optional. Default = true\r send the source token to the map layer after creating the DL path?\r if true, will send to map layer and perform a z-order `ToFront`\r if false, will keep on token layer and perform a z-order `ToBack`\r\r**Example Syntax**\r`!dldark`\r`!dldark 15 true`\r`!dldark ?{buffer radius?|15} true false`",
66
"authors": "David M.",
77
"roll20userid": 3987469,
88
"patreon": [],

Deal-Init/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"name": "DealInit",
2+
"name": "Savage Worlds - DealInit",
33
"script":"Deal-Init.js",
44
"version": "1.5",
55
"previousversions": [ "1.4","1.3","1.2" ],
6-
"description": "Handles Savage Worlds card-based Inititive by dealing cards to Turn Order, automatically handling Jokers and Initiative Edges and sorting Turn Order by suit. To see options, type: !deal-init --help",
6+
"description": "Handles Savage Worlds card-based Inititive by dealing cards to Turn Order, automatically handling Jokers and Initiative Edges and sorting Turn Order by suit. To see options, type: `!deal-init --help`",
77
"authors": "Pat Elwer",
88
"roll20userid": "8948",
99
"useroptions": [],

Mass-Combat/script.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "Mass Combat",
2+
"name": "D&D 5E - Mass Combat",
33
"script": "MassCombat.js",
44
"version": "1.0",
55
"previousversions": ["0.9"],

PaladinAura/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Depreciated version (not optimized enough to work properly): [Roll20 Forum](http
88

99
## Notes
1010

11-
The API is only compatible with the Roll20 D&D 5E OGL Sheet.
11+
The API is only compatible with the [D&D 5E by Roll20](wiki.roll20.net/D%26D_5E_by_Roll20) Sheet.
1212

1313
The API only runs on the player-ribbon page.
1414

PaladinAura/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"name": "PaladinAura 5E",
2+
"name": "D&D 5E - PaladinAura",
33
"script": "PaladinAura.js",
44
"version": "1.1",
55
"previousversions": [],
6-
"description": "A Roll20 API that auto-applies Paladin Auras and shows which characters are affected by the aura through the use of token-markers.\nDepreciated version: https://github.com/LaytonGB/PaladinAura",
6+
"description": "A Roll20 API that auto-applies Paladin Auras and shows which characters are affected by the aura through the use of token-markers. Only Compatible with the **D&D 5E by Roll20** character sheet.\n\n* Forum Thread\n* [Readme & further instructions](https://github.com/Roll20/roll20-api-scripts/tree/master/PaladinAura)",
77
"authors": "Layton Burchell. Special thanks to: Gustav Merelius.",
88
"roll20userid": "1519557",
99
"patreon": "",

PowerCards Macro Helper/script.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"script": "PCMHelper.js",
44
"version": "1.0.10",
55
"previousversions": ["1.0.9","1.0.8","1.0.5"],
6-
"description": "Automatically creates character attributes and macros to allow for system-generated PowerCards based on compendium/custom entered NPC Actions and Player Attacks.",
6+
"description": "Companion Script to **PowerCards**. Automatically creates character attributes and macros to allow for system-generated PowerCards based on compendium/custom entered NPC Actions and Player Attacks.\n\n * [PowerCard Macro Helper Documentation](https://wiki.roll20.net/Script:PowerCards_Macro_Helper)\n* [PowerCards & Macro Helper forum thread](https://app.roll20.net/forum/post/7136858/script-powercards-3-thread-6)",
77
"authors": "Kurt Jaegers",
88
"patreon": "https://www.patreon.com/KurtJaegers",
99
"roll20userid": "2365448"

PowerCards/script.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"script": "PowerCards.js",
44
"version": "3.8.15",
55
"previousversions": ["3.8.14","3.8.13","3.8.11","3.8.8","3.8.0","3.7.9","3.7.6","3.7.2","3.7.1"],
6-
"description": "PowerCards allows you to define highly customizable templated output for PC and NPC actions, spells, abilities, statistics, or almost any other purpose you can come up with. Their original purpose was to present ability and attack information (powers) in a format similar to the power blocks from the official D&D 4E products, but the format works well for any system. PowerCards are output to the chat window with full HTML/CSS formatting. A handful of options use information from the 5E OGL sheet, but these options are not critical to the functioning of the core features of the script.",
6+
"description": "**PowerCards** allows you to define highly customizable templated output for PC and NPC actions, spells, abilities, statistics, or almost any other purpose you can come up with. See also the **PowerCards Macro Helper** API, which is a companion script to PowerCards.\n\n * [PowerCard Documentation](https://wiki.roll20.net/Script:PowerCards)\n* [PowerCards forum thread](https://app.roll20.net/forum/post/7136858/script-powercards-3-thread-6) \n\nThe API's original purpose was to present ability and attack information (powers) in a format similar to the power blocks from the official D&D 4E products, but the format works well for any system. PowerCards are output to the chat window with full HTML/CSS formatting. A handful of options use information from the **D&D 5E by Roll20** sheet, but these options are not critical to the functioning of the core features of the script.",
77
"authors": "Sky, Kurt Jaegers",
88
"patreon": "https://www.patreon.com/KurtJaegers",
99
"roll20userid": "2365448"

Raise Count/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"name": "Raise Count",
2+
"name": "Savage Worlds - Raise Count",
33
"script": "Raise Count.js",
44
"version": "2.6",
55
"previousversions": ["2.5", "2.4", "2.3","2.2","2.1","2.0","1.0"],
6-
"description": "Counts raises for the Savage Worlds system. Use `!rc roll target` to make a roll.",
6+
"description": "Counts raises for the Savage Worlds system. Use `!rc roll target` to make a roll. See [Readme](https://github.com/Roll20/roll20-api-scripts/tree/master/Raise%20Count) for more details.",
77
"authors": "Brian Shields",
88
"roll20userid": "235259",
99
"patreon": "https://www.patreon.com/bshields",

Rest-and-Recovery/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "Rest-and-Recovery",
2+
"name": "D&D 5E - Rest and Recovery",
33
"script": "Rest-And-Recovery.js",
44
"version": "0.0.3",
5-
"description": "# Rest and Recovery\rA Roll20 API script to handle recovery on the resource attributes on the D&D 5th Edition by Roll20 sheet.\rTo use this script, resources must include a code in their name, separated from the name by a plus sign. You can include standard dice expressions as well. '1d6' is used in all examples, but you can do 2d6+3, 3d20, etc. Here are examples of the commands given and the codes that are affected.\r\r## !r-short\r*Used for Short Rest*\r\r**+SR** This resource will return to its maximumm value\r\r**+SR1d6** This resource will add 1d6 to the resource up to its maximum value\r\r\r## !r-long\r*Used for Long Rest*\r\r**+LR** This resource will return to its maximumm value\r\r**+LR1d6** This resource will add 1d6 to the resource up to its maximum value\r\r\r## !r-charges\r*used for restoring charges that are user-controlled, such as 'at dawn' or 'under a full moon'.\r\r**+1d6**\r\r\r## !r-ammo\rno code is used here. The script looks for common ammo types: Crossbow bolts, Arrows, Bullets, etc. It rolls 1d2 for each piece of ammo expended. If the result is a '2', the ammo is recovered. The max and current values are adjusted to reflect the new total.\r\r## !r-help\rThis will display the basic help syntax in chat.\r\r## !r-list\rThis will list every resource that can be recovered without using a code. The script will recognize by name almost every recoverable class resource from an official sourcebook with the exception of ties such as Ravnica or Acquisitions, Inc.\r\r\r### Short Rest Class Resources\rSpell Slots, Warlock Spell Slots, Spell Points, Channel Divinity, Wild Shapes, Second Wind, Action Surge, Superiority Dice, Ki, Ki Points, Visions of the Past, Enthralling Performance, Words of Terror, Unbreakable Majesty, Spirit Totem, Indomitable, Arcane Shot, Detect Portal, Ethereal Step, Magic-Users Nemesis, Favored by the Gods, Wind Soul, Blade Song, Arcane Abeyance, Illusory Step, Shapechanger\r\r### Long Rest Class Resources\rRages, Lay on Hands, Sorcery Points, Flash of Genius, Divine Intervention, Eyes of the Grave, Warding Flare, Wrath of the Storm, Cleansing Touch, War Priest Attack, Sentinel at Deaths Door, Embodiment of the Law, Universal Speech, Mantle of Majesty, Infectious Inspiration, Shadow Lore, Balm of the Summer Court, Natural Recovery, Fungal Infestation, Hidden Paths, Walker in Dreams, Faithful Summons, Fighting Spirit, Warding Maneuver, Strength before Death, Unwavering Mark, Wholeness of Body, Glorious Defense, Undying Sentinel, Invincible Conqueror, Holy Nimbus, Living Legend, Emissary of Redemption, Elder Champion, Avenging Angel, Dread Lord, Hunters Sense, Unerring Eye, Spell Thief, Strength of the Grave, Tides of Chaos, Unearthly Recovery, Mystic Arcanum-6th, Mystic Arcanum-7th, Mystic Arcanum-8th, Mystic Arcanum-9th, Eldritch Master, Chronal Shift, Momentary Stasis, Benign Transposition, Instinctive Charm, Power Surge, Violent Attraction, Event Horizon\r\r### Ammo Types\rCrossbow bolts, Arrows, Bullets, Sling Bullets, Needles, Darts\r\r\r**Bardic Inspiration** needs a +SR or +LR code, since the recovery rate changes at fifth level", "authors": "Keith Curtis",
5+
"description": "# Rest and Recovery\rA Roll20 API script to handle recovery on the resource attributes on the **D&D 5E by Roll20** sheet.([Rest and Recovery - Forum Thread](https://app.roll20.net/forum/post/8652406/slug%7D#post-8654262))\rTo use this script, resources must include a code in their name, separated from the name by a plus sign. You can include standard dice expressions as well. '1d6' is used in all examples, but you can do 2d6+3, 3d20, etc. Here are examples of the commands given and the codes that are affected.\r\r## !r-short\r*Used for Short Rest*\r\r**+SR** This resource will return to its maximumm value\r\r**+SR1d6** This resource will add 1d6 to the resource up to its maximum value\r\r\r## !r-long\r*Used for Long Rest*\r\r**+LR** This resource will return to its maximumm value\r\r**+LR1d6** This resource will add 1d6 to the resource up to its maximum value\r\r\r## !r-charges\r*used for restoring charges that are user-controlled, such as 'at dawn' or 'under a full moon'.\r\r**+1d6**\r\r\r## !r-ammo\rno code is used here. The script looks for common ammo types: Crossbow bolts, Arrows, Bullets, etc. It rolls 1d2 for each piece of ammo expended. If the result is a '2', the ammo is recovered. The max and current values are adjusted to reflect the new total.\r\r## !r-help\rThis will display the basic help syntax in chat.\r\r## !r-list\rThis will list every resource that can be recovered without using a code. The script will recognize by name almost every recoverable class resource from an official sourcebook with the exception of ties such as Ravnica or Acquisitions, Inc.\r\r\r### Short Rest Class Resources\rSpell Slots, Warlock Spell Slots, Spell Points, Channel Divinity, Wild Shapes, Second Wind, Action Surge, Superiority Dice, Ki, Ki Points, Visions of the Past, Enthralling Performance, Words of Terror, Unbreakable Majesty, Spirit Totem, Indomitable, Arcane Shot, Detect Portal, Ethereal Step, Magic-Users Nemesis, Favored by the Gods, Wind Soul, Blade Song, Arcane Abeyance, Illusory Step, Shapechanger\r\r### Long Rest Class Resources\rRages, Lay on Hands, Sorcery Points, Flash of Genius, Divine Intervention, Eyes of the Grave, Warding Flare, Wrath of the Storm, Cleansing Touch, War Priest Attack, Sentinel at Deaths Door, Embodiment of the Law, Universal Speech, Mantle of Majesty, Infectious Inspiration, Shadow Lore, Balm of the Summer Court, Natural Recovery, Fungal Infestation, Hidden Paths, Walker in Dreams, Faithful Summons, Fighting Spirit, Warding Maneuver, Strength before Death, Unwavering Mark, Wholeness of Body, Glorious Defense, Undying Sentinel, Invincible Conqueror, Holy Nimbus, Living Legend, Emissary of Redemption, Elder Champion, Avenging Angel, Dread Lord, Hunters Sense, Unerring Eye, Spell Thief, Strength of the Grave, Tides of Chaos, Unearthly Recovery, Mystic Arcanum-6th, Mystic Arcanum-7th, Mystic Arcanum-8th, Mystic Arcanum-9th, Eldritch Master, Chronal Shift, Momentary Stasis, Benign Transposition, Instinctive Charm, Power Surge, Violent Attraction, Event Horizon\r\r### Ammo Types\rCrossbow bolts, Arrows, Bullets, Sling Bullets, Needles, Darts\r\r\r**Bardic Inspiration** needs a +SR or +LR code, since the recovery rate changes at fifth level", "authors": "Keith Curtis",
66
"roll20userid": "162065",
77
"dependencies": [],
88
"modifies": {

SR-RollExtender/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"name": "SR-RollExtender",
2+
"name": "Shadowrun 5E - RollExtender",
33
"script": "SR-RollExtender.js",
44
"version": "0.2",
55
"previousversions": ["0.1"],
6-
"description": "Designed to be used with the Shadowrun: 5th Edition (Advanced) character sheet.\r\r Autoamticaly detect Glitches and roll Extended Tests.\r\r Glitch Detection is not yet configurable and will send a private message to the GM whenever a Glitch is rolled.\r\r To roll an Extended Test type: !RollEx xx\r xx being the number of dice to start with\r\rOptional parameters are:\r dy with y being the minimum number of dice before you want to stop\r sz with z being the number of successes after which you want to stop\r\r Example:\r !RollEx 16 d5 s24 \r will roll an extended test starting with 16 dice and dropping one after every roll until you either have a minimum of 24 successes, less than 5 dice remaining or roll a critical glitch\r\r\r type !RollEx ingame to see the help menu",
6+
"description": "Designed to be used with the **Shadowrun: 5th Edition (Advanced)**-character sheet.\r\r Automatically detect Glitches and roll Extended Tests.\r\r Glitch Detection is not yet configurable and will send a private message to the GM whenever a Glitch is rolled.\r\r To roll an Extended Test type: `!RollEx xx`\r `xx` being the number of dice to start with\r\rOptional parameters are:\r `dy` with `y` being the minimum number of dice before you want to stop\r `sz` with `z` being the number of successes after which you want to stop\r\r Example:\r `!RollEx 16 d5 s24` \r will roll an extended test starting with 16 dice and dropping one after every roll until you either have a minimum of 24 successes, less than 5 dice remaining or roll a critical glitch\r\r\r type `!RollEx` ingame to see the help menu",
77
"authors": "Jens 'xyro'",
88
"roll20userid": "857511",
99
"useroptions": [],

ShortRest/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"name": "ShortRest",
2+
"name": "D&D 5E - ShortRest",
33
"script": "ShortRest.js",
44
"version": "0.1.1",
55
"previousversions": [],
6-
"description": "Allows Hit Dice, Class Resource and Spellslot tracking for Short Rests on the 5e OGL Character Sheet.\r\rThe script can be used in 2 ways, either by clicking on Hit Dice on the 5e OGL Sheet or by selecting a token and running the `!shortrest-nohd` command (if you want to do a short rest without expending any Hit Dice.) The script will then check if you have any Hit Die to spend, if you aren't already full health it will update the character's health with the rolled amount. Further to this it will check whether the class has any resources or spell slots that resets on a short rest and reset those.\r\r## Classes supported\r\r*If there is any I missed please let me know.*\r\r### Resources\r\r+ Cleric - Channel Divinity; Visions of the Past\r+ Druid - Wild Shape; Spirit Totem\r+ Fighter - Action Surge; Second Wind; Superiority Dice; Arcane Shot\r+ Monk - Ki\r+ Bard - Bardic Inspiration from level 5, Enthralling Performance; Words of Terror; Unbreakable Majesty\r+ Ranger - Detect Portal; Etherreal Step; Magic User's Nemesis\r+ Sorceror - Favored by the Gods; Wind Soul\r+ Wizard - Blade Song; Arcane Abeyance; Illusory Self\r\r### Spell Slots\r\r+ Warlock",
6+
"description": "Allows Hit Dice, Class Resource and Spellslot tracking for Short Rests on the **D&D 5E by Roll20** Character Sheet.\r\rThe script can be used in 2 ways, either by clicking on Hit Dice on the D&D 5E by Roll20 Sheet or by selecting a token and running the `!shortrest-nohd` command (if you want to do a short rest without expending any Hit Dice.) The script will then check if you have any Hit Die to spend, if you aren't already full health it will update the character's health with the rolled amount. Further to this it will check whether the class has any resources or spell slots that resets on a short rest and reset those.\r\r## Classes supported\r\r*If there is any I missed please let me know.*\r\r### Resources\r\r+ Cleric - Channel Divinity; Visions of the Past\r+ Druid - Wild Shape; Spirit Totem\r+ Fighter - Action Surge; Second Wind; Superiority Dice; Arcane Shot\r+ Monk - Ki\r+ Bard - Bardic Inspiration from level 5, Enthralling Performance; Words of Terror; Unbreakable Majesty\r+ Ranger - Detect Portal; Etherreal Step; Magic User's Nemesis\r+ Sorceror - Favored by the Gods; Wind Soul\r+ Wizard - Blade Song; Arcane Abeyance; Illusory Self\r\r### Spell Slots\r\r+ Warlock",
77
"authors": "Werner D.; Original Author Unkown",
88
"roll20userid": "1062502",
99
"useroptions": [],

0 commit comments

Comments
 (0)