Skip to content

Commit 2695b04

Browse files
authored
Update Readme.md
1 parent 46e95d5 commit 2695b04

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

Readme.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
# Global Progress Clocks
22

3-
Blades in the Dark style progress clocks that show on the sidebar for Foundry VTT. These are shown globally to all players, and are not stored in actor data like other modules so they should be system agnostic (except for those that make use of that space in some way).
3+
Blades in the Dark style progress clocks and point trackers that render in the main interface of Foundry VTT. These are shown globally to all players, and are system agnostic in their implementation.
44

5-
![image](https://user-images.githubusercontent.com/1286721/232355007-becf4713-ee84-49df-9803-1724f7fd8684.png)
5+
![image](https://github.com/user-attachments/assets/a1683812-4d26-4284-8c1b-91f6a35c79e2)
66

77
These clocks are only editable by the gamemaster, and can either be edited with a dialog or ticked by left or right clicking.
88

9+
## Supported Features
10+
11+
### Clocks
12+
13+
The module is capable of creating clocks, a feature used in games such as Blades in the Dark in order to track completion of a goal or the moment in which a problem manifests. More information about clocks can be seen https://bladesinthedark.com/progress-clocks or https://www.indiegamereadingclub.com/indie-game-reading-club/clocks-forged-in-the-darks-underappreciated-killer-app/.
14+
15+
This module is currently best used for scene clocks. Any long term or player clock such as a faction or project clock is best represented in other ways, such as the clockworks module or with the clock actors in some systems. I will likely add a new way to display clocks in the sidebar similar to clockworks at a later date.
16+
17+
### Points
18+
19+
Some system like Pathfinder 2e use something similar to clocks called victory points, which are numbers that count up. These numbers lack an obvious max but denote progress or advantages the party has obtained. While any system can use this feature, in Pathfinder 2e the module adjusts its position if the system's effect panel is in view.
20+
21+
![image](https://github.com/user-attachments/assets/92828d6a-03b5-4a22-90ed-ef7e32226765)
22+
923
## Scripting
1024

1125
There is no full api, but there is `window.clockDatabase` to mess with the clocks themselves. Here's an example to increment an existing clock.

0 commit comments

Comments
 (0)