Home
Games
Marketplace
Compendium Character Vault Roll20 for iPad and Android
Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "OGL 5e DnD: How to setup Ammunition and Resource tracker"

From Roll20 Wiki

Jump to: navigation, search
(→‎Advanced Ammunition Depletion)
(Clarified that adding the script requires that you have a pro account and be the game creator. Formatted steps to be in numbered list format. Split article into sections. Made a few grammar corrections. Streamlined introductory paragraphs.)
Line 1: Line 1:
−
[[Category:Tips]]
+
The Ammunition and Resource tracker allows you to automatically decrement a counter whenever you trigger an attack in the application. This works for ammunition such as crossbow bolts, and other abilities and attacks that limited, such as a Cleric's Channel Divinity. This article shows you how to set up resources in the Roll20 OGL sheet.
  
−
This might seem pretty basic but some people might not be aware of the capabilities you have with roll20 OGL character sheet. I've been helping many people to setup this and I believe it worth posting something about it. Most of the people get lost where to go, where to click, where are the options you need to change, so I will try to cover with a full example how to do this.
+
To add the Ammunition and Resource tracker to games you have created, you need a pro account.
−
Think of resources like something you can automatically decrement a counter whenever you trigger an attack in the application. I will cover how to setup resources in roll20 OGL sheet to make your game go smoother and faster avoiding repetitive actions.
+
  
−
Ammunitions is probably the most common use case for resources setup in your character sheet. The setup is not complicated. In a nutshell you need a pro account, a sandbox with some scripts for the game you are enabling the feature, and some character sheet level configuration.
+
==Adding Ammunition and Resource Tracking to Your Game==
 +
To set up ammunition tracking in a game you created:
  
−
First when you open roll20 click on the game title you want to setup ammunition tracker.
+
# When you open Roll20, click on the game title you want to setup ammunition tracker.<br />[[File:OGL Ammo Instructions 1.jpeg|400px|thumbnail|center]]
 +
# On the game page, open the '''Settings''' menu and select '''API Scripts'''.<br />[[File:OGL_Ammo_Instructions_2.jpeg|400px|thumbnail|center]]
 +
# In the API Scripts page, go to the '''Script Library''' tab and locate the dropdown that allows you to search.
 +
# Search for '''Companion'''. Select '''5th Edition OGL by Roll20 Companion'''.<br />[[File:OGL_Ammo_Instructions_3.jpeg|400px|thumbnail|center]]
 +
# Click the '''Add Script''' button at the bottom:<br />[[File:OGL_Ammo_Instructions_4.jpeg|400px|thumbnail|center]]
  
−
[[File:OGL Ammo Instructions 1.jpeg|400px|thumbnail|center]]
+
This script also has other features, such as keeping track of your spell slot usage if you're using default spell slots rules. These features are not detailed in this article.
  
−
On the game page click in Settings menu select API Scripts.
+
==Configuring Ammunition Tracking on a Character Sheet==
−
 
+
To add ammunition tracking to a character sheet:
−
[[File:OGL_Ammo_Instructions_2.jpeg|400px|thumbnail|center]]
+
# Launch the game and open the character sheet you want to configure.
−
 
+
# On the sections menu select the engine icon. Then locate the right column named '''General Options''', and change '''Ammo Tracking''' value to '''On'''.<br />[[File:OGL_Ammo_Instructions_5.jpeg|600px|thumbnail|center]]
−
In the API Scripts page the first tab is Script Library, you can see a dropdown that allows you to search, search for Companion. Select “5th Edition OGL by roll20 Companion”.
+
# Return to the '''CORE''' section.
−
 
+
# To define what you want to keep track of, go to the equipment section and mouse over the equipment line.
−
[[File:OGL_Ammo_Instructions_3.jpeg|400px|thumbnail|center]]
+
# Click the “I” icon that will appear, select the option '''Use as a Resource'''. This will make it also be controlled by the resource section, so that whenever you change the quantity there it also changes in your inventory.<br />[[File:OGL_Ammo_Instructions_6.jpeg|600px|thumbnail|center]]
−
 
+
#Open the existing attack, such as the one Roll20 automatically creates when you drag a crossbow from the Compendium.  
−
Finally click on add Script button in the bottom:
+
# Mouse over the attack, click in the inline engine icon that will appear and locate the '''AMMUNITION''' field.
−
 
+
# Type the exact name of the equipment you want to auto-decrement automatically. <br />[[File:OGL_Ammo_Instructions_7.jpeg|600px|thumbnail|center]]
−
[[File:OGL_Ammo_Instructions_4.jpeg|400px|thumbnail|center]]
+
−
 
+
−
This script also have other features I won't talk about, for instance it also keeps track of you spell slot usage if you're using default spell slots rules.
+
−
All you have to do now is go inside the game and open the character sheet you want to configure. On the sections menu select the Engine icon, locate the right column named General Options and change Ammo Tracking value to "On".
+
−
 
+
−
[[File:OGL_Ammo_Instructions_5.jpeg|600px|thumbnail|center]]
+
−
 
+
−
Back into the CORE section you must define what you want to keep track of, inside the equipment section mouse over the equipment line click in the “I” icon that will appear, select the option “User as Resource”.
+
−
This will make it also be controlled by the resource section, so that whenever you change the quantity there it also changes in your inventory.
+
−
 
+
−
[[File:OGL_Ammo_Instructions_6.jpeg|600px|thumbnail|center]]
+
−
 
+
−
Open the existing attack, such as the one roll20 automatically creates when you drag a crossbow from the compendium. Move mouse over the attack, click in the inline engine icon that will appear and locate the AMMUNITION field and type the exactly same name of the equipment you want to auto decrement a counter automatically.  
+
−
 
+
−
[[File:OGL_Ammo_Instructions_7.jpeg|600px|thumbnail|center]]
+
  
 
Now whenever you run an attack you will see both the resources and the equipment counter decrement.
 
Now whenever you run an attack you will see both the resources and the equipment counter decrement.
Line 40: Line 29:
 
[[File:OGL_Ammo_Instructions_8.jpeg|600px|thumbnail|center]]
 
[[File:OGL_Ammo_Instructions_8.jpeg|600px|thumbnail|center]]
  
−
Another example would be a cleric from tempest domain that can use his reaction to give some damage. He can use this ability let’s say 3 times until recover.
+
==Tracking Ability Usage==
−
As long as you type type same name of an existing resource in the AMMUNITION field inside the attack setup, even if you don’t have that resource in the inventory (remember you can create resources independently of anything in your sheet), it will decrement from it.
+
You can also set this up for classes that have a limited number of times they can use a particular ability. The below example shows a Cleric from the Tempest domain that can use their Wrath of the Storm ability 3 times a day. You could set this up for a Fighter's Second Wind ability, Channel Divinity, etc.
−
 
+
−
Look the following example for the Cleric, note that after you run the attack for the first time the system will update the AMMUNITION field value adding a | (pipe) symbol to separate the name from the id it needs to keep reference of which field it should update. You basically ignore this id and leave it there.
+
  
 
[[File:OGL_Ammo_Instructions_9.jpeg|600px|thumbnail|center]]
 
[[File:OGL_Ammo_Instructions_9.jpeg|600px|thumbnail|center]]
  
−
Finally you can do the same for Second Wind ability for fighters with a heal attack, Channel Divinity, etc.
+
Note that after you run the attack for the first time the system will update the '''AMMUNITION''' field value adding a | (pipe) symbol to separate the name from the id it needs to keep reference of which field it should update. You can ignore the id; do not remove it.
  
−
===Advanced Ammunition Depletion===
+
==Advanced Ammunition Depletion==
  
 
{{mbox | text = Before changing the resource depletion amount ensure you have used the attack at least once so that the resource_id is appended to the Ammunition field}}
 
{{mbox | text = Before changing the resource depletion amount ensure you have used the attack at least once so that the resource_id is appended to the Ammunition field}}
  
−
If you need to deplete a resource by a value greater than 1, you can simply add a comma after the name of the resource and then the number in the Ammunition section of the Attack.  
+
If you need to deplete a resource by a value greater than 1, you can simply add a comma after the name of the resource and then the number in the Ammunition section of the Attack.  
  
 
For example:
 
For example:

Revision as of 18:47, 23 July 2019

The Ammunition and Resource tracker allows you to automatically decrement a counter whenever you trigger an attack in the application. This works for ammunition such as crossbow bolts, and other abilities and attacks that limited, such as a Cleric's Channel Divinity. This article shows you how to set up resources in the Roll20 OGL sheet.

To add the Ammunition and Resource tracker to games you have created, you need a pro account.

Contents

Adding Ammunition and Resource Tracking to Your Game

To set up ammunition tracking in a game you created:

  1. When you open Roll20, click on the game title you want to setup ammunition tracker.
    OGL Ammo Instructions 1.jpeg
  2. On the game page, open the Settings menu and select API Scripts.
    OGL Ammo Instructions 2.jpeg
  3. In the API Scripts page, go to the Script Library tab and locate the dropdown that allows you to search.
  4. Search for Companion. Select 5th Edition OGL by Roll20 Companion.
    OGL Ammo Instructions 3.jpeg
  5. Click the Add Script button at the bottom:
    OGL Ammo Instructions 4.jpeg

This script also has other features, such as keeping track of your spell slot usage if you're using default spell slots rules. These features are not detailed in this article.

Configuring Ammunition Tracking on a Character Sheet

To add ammunition tracking to a character sheet:

  1. Launch the game and open the character sheet you want to configure.
  2. On the sections menu select the engine icon. Then locate the right column named General Options, and change Ammo Tracking value to On.
    OGL Ammo Instructions 5.jpeg
  3. Return to the CORE section.
  4. To define what you want to keep track of, go to the equipment section and mouse over the equipment line.
  5. Click the “I” icon that will appear, select the option Use as a Resource. This will make it also be controlled by the resource section, so that whenever you change the quantity there it also changes in your inventory.
    OGL Ammo Instructions 6.jpeg
  6. Open the existing attack, such as the one Roll20 automatically creates when you drag a crossbow from the Compendium.
  7. Mouse over the attack, click in the inline engine icon that will appear and locate the AMMUNITION field.
  8. Type the exact name of the equipment you want to auto-decrement automatically.
    OGL Ammo Instructions 7.jpeg

Now whenever you run an attack you will see both the resources and the equipment counter decrement.

OGL Ammo Instructions 8.jpeg

Tracking Ability Usage

You can also set this up for classes that have a limited number of times they can use a particular ability. The below example shows a Cleric from the Tempest domain that can use their Wrath of the Storm ability 3 times a day. You could set this up for a Fighter's Second Wind ability, Channel Divinity, etc.

OGL Ammo Instructions 9.jpeg

Note that after you run the attack for the first time the system will update the AMMUNITION field value adding a | (pipe) symbol to separate the name from the id it needs to keep reference of which field it should update. You can ignore the id; do not remove it.

Advanced Ammunition Depletion

Before changing the resource depletion amount ensure you have used the attack at least once so that the resource_id is appended to the Ammunition field

If you need to deplete a resource by a value greater than 1, you can simply add a comma after the name of the resource and then the number in the Ammunition section of the Attack.

For example: 

Healing Power,5|resource_id

You can also expand this by using Roll Queries. To do so, make a roll query in your Attack then use the same Roll Query name in the value portion of the ammunition field.

For example: Enter ?{Amount to heal?} in the damage section of your attack, then put Healing Power,?{Amount to heal?}|resource_id in the Ammunition field.

Retrieved from "https://wiki.roll20.net/index.php?title=OGL_5e_DnD:_How_to_setup_Ammunition_and_Resource_tracker&oldid=18186"