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
Copy file name to clipboardExpand all lines: README.md
+51-17Lines changed: 51 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
# About Time Next
8
8
9
9
**About Time Next** is a timekeeping and event scheduling utility for Foundry VTT v13+. It is a spiritual successor to about-time by Tim Posney and is built on top of the original code in an attempt to keep legacy functions.
10
-
It works with **Simple Calendar** (*see installation note 3*) or falls back to Foundry’s core time system.
10
+
It supports **D&D 5e v5.2+ native calendar**, **Seasons & Stars**, **Simple Calendar**, or falls back to Foundry's core time system.
11
11
12
12
---
13
13
@@ -21,18 +21,41 @@ It works with **Simple Calendar** (*see installation note 3*) or falls back to F
21
21
```
22
22
23
23
2. Enable the module in your world.
24
-
3. (Optional) Install **Simple Calendar** for advanced date formatting.
25
-
*Note - When SC is available for FVTT v13 I will reconfirm the original functionality. If there are only minor hook changes, about-time-v13 MAY already be compatible with the v13 SC, it's unlikely though...*
24
+
3. (Optional) Configure calendar system in settings: Auto-detect (default), D&D 5e Calendar, Simple Calendar, Seasons & Stars, or None.
26
25
27
26
> Compatibility: Designed for FVTT v13 (min 13, max 13.x).
28
-
> With SC enabled, About-Time uses SC’s format/interval helpers where available.
29
-
> Works with smalltime and Season and Stars (using foundry's core time system, not Seasons and Stars') but also has it's own Time Management app built in (which can be disabled in settings).
27
+
> **Calendar Support:** D&D 5e v5.2+ native calendar, Seasons & Stars, Simple Calendar, and core time fallback.
28
+
> Settings dropdown dynamically shows only available calendar systems. Detection display shows all systems with status.
29
+
30
+
---
31
+
32
+
## Calendar Integration
33
+
34
+
About Time Next uses a **calendar adapter system** to integrate with multiple calendar systems. The module automatically detects available calendars and provides formatted time displays.
35
+
36
+
**Supported Calendars:**
37
+
-**D&D 5e Calendar (v5.2+)**: Native Foundry v13 calendar system with Harptos, Greyhawk, Gregorian, and Khorvaire calendars.
38
+
-**Seasons & Stars**: Full integration with formatted date/time display.
39
+
-**Simple Calendar**: Legacy compatibility layer retained for reference. Full support depends on a FVTT v13 update of the Simple Calendar module. SC integration may soon be removed if confirmed abandoned.
40
+
41
+
**Auto-Detection (Default):**
42
+
When set to "Auto-detect", the module checks in priority order:
43
+
1. Seasons & Stars (if module active with API)
44
+
2. Simple Calendar (if module active with API)
45
+
3. D&D 5e Calendar (if system v5.2+ with calendar configured)
46
+
4. Falls back to "None" (Foundry core time)
47
+
5. Additional calendars to be added in future updates.
48
+
49
+
**Calendar Integration Settings:**
50
+
- Dropdown shows **only detected** calendars (plus "Auto-detect" and "None")
51
+
- Detection info panel shows **all calendars** with ✓/✗ status
52
+
- If your selected calendar becomes unavailable, module falls back automatically
30
53
31
54
---
32
55
33
56
## Quick Start
34
57
35
-
-**Event Manager (applicationV2):** Open from the **Journal/Notes** toolbar sub-button **“Event Manager”** (GM-only).
58
+
-**Event Manager (applicationV2):** Open from the **Journal/Notes** toolbar sub-button **“Event Manager”** (Timekeeper-only; GMs always allowed).
36
59
Use it to create one-shots or repeating events, stop items by name/UID, view the queue, or flush all.
37
60
38
61
-**Mini Time Manager (optional):** Enable in **Configure Settings → About-Time** to show a compact panel with **Play/Pause**, current time, and tiny toggles for realtime behavior (GM sees controls; players see time).
@@ -48,13 +71,14 @@ It works with **Simple Calendar** (*see installation note 3*) or falls back to F
Show the current queue (GM-whisper; includes UID, args, and next fire time).
95
119
96
120
-`/at clear`
97
-
Clear the entire queue.
121
+
Clear the entire queue. Prompts for confirm/cancel and updates the same chat card.
98
122
99
123
-`/at stop <uid>`
100
-
Stop a specific event by UID.
124
+
Stop a specific event by UID. Prompts for confirm/cancel and updates the same chat card.
101
125
> Tip: In EM V2 you can copy a row’s UID, then run **`/at stop UID**.
102
126
127
+
-`/at pause <uid>`
128
+
Pause a specific event by UID (freezes remaining time).
129
+
130
+
-`/at resume <uid>`
131
+
Resume a paused event by UID.
132
+
103
133
-`/at in <duration> <message>`
104
134
Schedule a one-time reminder.
105
135
Returns a UID so you can stop it later.
@@ -134,19 +164,21 @@ Actions (top buttons):
134
164
-**Send Queue to Chat** (GM-whisper)
135
165
-**Stop all Events** / **Stop all + 1h reminder**
136
166
137
-
> With **Simple Calendar** installed, About-Time uses SC's formatting/conversion where appropriate. Without SC, it falls back to core Foundry world time.
167
+
> Time formatting uses the active calendar adapter (D&D 5e, Seasons & Stars, or Simple Calendar when available). Falls back to Foundry core time if no calendar system is configured.
138
168
139
169
### Event Notification Cards
140
170
When events trigger, they display standardized notification cards with detailed information:
-**Link Pause / Auto-Pause Combat (client)** — How the mini panel reacts to world/game state.
224
258
@@ -241,22 +275,22 @@ Event notifications play automatically when scheduled events fire, helping GMs t
241
275
- M4A (.m4a) - AAC audio, good quality
242
276
Best practice: MP3 is the safest choice for maximum browser compatibility across all platforms (which is why we used it for the notification sounds in v13.2.0.0+).
243
277
244
-
> Where SC is present, date/time formatting in the mini panel and EM uses SC helpers.
278
+
> Date/time formatting uses the active calendar adapter (D&D 5e, Seasons & Stars, Simple Calendar when available), otherwise it falls back to Foundry core time.
245
279
246
280
---
247
281
248
282
## Notes & Limitations
249
283
250
284
- The module **does not** override combat round/initiative time.
251
-
- Complex SC calendars (non-365-day years, custom months) are supported via SC’s own conversions, while raw seconds math remains conservative in fallback mode.
252
-
-Only GMs can create, manage, and view scheduled events.
285
+
- Complex calendar rules are supported through the active calendar system when present; core-time fallback uses raw seconds math.
286
+
-Event queue management is **Timekeeper-only** (configurable role threshold; GMs always allowed).
253
287
- Realtime runner is **single-owner (GM)**; if another GM starts it, ownership is handed off gracefully.
254
288
255
289
---
256
290
257
291
## Credits
258
292
259
-
Originally created by **Tim Posney**, updated and maintained for FVTT v13+ by **paulcheeba** with community input and ChatGPT-assisted refactoring.
293
+
About Time was originally created and maintained by the great **Tim Posney**, About time Next is updated and maintained for FVTT v13+ by **paulcheeba** with community input and AI-assisted refactoring.
260
294
261
295
**Event notification sound effects** by [Notification_Message](https://pixabay.com/users/notification_message-47259947/) from [Pixabay](https://pixabay.com/sound-effects/).
0 commit comments