You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Multiple trackers: Support multiple trackers at the same time
- Advanced options: Optional array parameter on open() method to pass
advanced options
- Commenting: Comment code
Copy file name to clipboardExpand all lines: README.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,20 @@ An interactive aid to track successes and failures in challenges.
10
10
-**Player View:** Click **Show** on the header to show the tracker to your players and click **Hide** to hide it from your players.
11
11
12
12
## How to Use
13
-
1. Create a macro with a Type of 'script' and enter: `ChallengeTracker.open(successes, failures, {show: true/false})` where `successes` is the number of successes required, `failures` is the number of failures required, and `{show: true/false}` equals `{show: true}` to show the tracker to your players or `{show: false}` to hide it from your players. `{show: true/false}` is optional and is set to false by default.
13
+
1. Create a macro with a Type of 'script' and enter: `ChallengeTracker.open(outer, inner)` where `outer` is the number of segments required on the outer ring (successes) and `inner` is the number of segments required on the inner circle (failures).
14
14
2. Execute the macro to open the Challenge Tracker.
More options can be set using an optional array parameter: `ChallengeTracker.open(successes failures, {options})` where options is a comma-separated list of any of the following parameters in the format `option: value`:
18
+
-**show:** Set to `true` to show the Challenge Tracker to your players. Default is `false`. Example: `show: true`
19
+
-**outerCurrent:** Set the number of completed segments on the outer ring (successes). Default is `0`. Example: `outerCurrent: 3`
20
+
-**innerCurrent:** Set the number of completed segments on the inner circle (failures). Default is `0`. Example: `innerCurrent: 3`
21
+
-**outerColor:** Set the hex color of the outer ring (successes). The 'Outer Color' module setting will be ignored. Example: `outerColor: '#0000FF'`
22
+
-**innerColor:** Set the hex color of the inner circle (failures). The 'Inner Color' module setting will be ignored. Example: `outerColor: '#0000FF'`
23
+
-**frameColor:** Set the hex color of the frame. The 'Frame Color' module setting will be ignored. Example: `outerColor: '#0000FF'`
24
+
-**size:** Set the size of the Challenge Tracker in pixels between 200 to 600. The 'Size' module setting will be ignored. Example: `size: 400`
25
+
-**title:** Set the title of the Challenge Tracker in the window header. Default is `Challenge Tracker`. Example: `title: 'Skill Challenge 1'`
17
26
18
-
By default, successes are tracked on the outer ring while failures are tracked on the inner circle.
Currently, only the GM can open, control and close the Challenge Tracker. In a future release, I'll add the functionality to hand over the Challenge Tracker to a player.
0 commit comments