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
+15-16Lines changed: 15 additions & 16 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 supports **D&D 5e v5.2+ native calendar**, **Seasons & Stars**, **Simple Calendar**, or falls back to Foundry's core time system.
10
+
It supports **D&D 5e v5.2+ native calendar**, **Seasons & Stars**, **Simple Calendar Reborn**, or falls back to Foundry's core time system.
11
11
12
12
---
13
13
@@ -21,10 +21,10 @@ It supports **D&D 5e v5.2+ native calendar**, **Seasons & Stars**, **Simple Cale
21
21
```
22
22
23
23
2. Enable the module in your world.
24
-
3. (Optional) Configure calendar system in settings: Auto-detect (default), D&D 5e Calendar, Simple Calendar, Seasons & Stars, or None.
24
+
3. (Optional) Configure calendar system in settings: D&D 5e Calendar, Simple Calendar Reborn, Seasons & Stars, or None (default).
25
25
26
26
> Compatibility: Designed for FVTT v13 (min 13, max 13.x).
27
-
> **Calendar Support:** D&D 5e v5.2+ native calendar, Seasons & Stars, Simple Calendar, and core time fallback.
27
+
> **Calendar Support:** D&D 5e v5.2+ native calendar, Seasons & Stars, Simple Calendar Reborn, and core time fallback.
28
28
> Settings dropdown dynamically shows only available calendar systems. Detection display shows all systems with status.
29
29
30
30
---
@@ -36,18 +36,18 @@ About Time Next uses a **calendar adapter system** to integrate with multiple ca
36
36
**Supported Calendars:**
37
37
-**D&D 5e Calendar (v5.2+)**: Native Foundry v13 calendar system with Harptos, Greyhawk, Gregorian, and Khorvaire calendars.
38
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.
39
+
-**Simple Calendar Reborn**: Full integration with time authority model. Simple Calendar has been reborn as Simple Calendar Reborn (maintained by Arctis Fireblight for Foundry v13+), and we have integrated it with complete time management support.
40
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.
41
+
**Neutral Calendar Selection:**
42
+
The module uses neutral selection logic with no automatic favoritism:
-**1 calendar available** → Auto-selects that calendar
45
+
-**2+ calendars available** → Uses "None" and shows selection dialog
46
+
47
+
All supported calendars (D&D 5e, Simple Calendar Reborn, Seasons & Stars) are treated equally. The module never automatically picks one third-party calendar over another.
48
48
49
49
**Calendar Integration Settings:**
50
-
- Dropdown shows **only detected** calendars (plus "Auto-detect" and "None")
- Live **clock display** (SC-formatted if SC is present)
94
+
- Live **clock display** (calendar-formatted when available)
95
95
- Small toggles for realtime behavior (GM):
96
96
-**Link Pause** (pause realtime if the game is paused)
97
97
-**Auto-Pause on Combat** (pause/resume around combats)
@@ -164,7 +164,7 @@ Actions (top buttons):
164
164
-**Send Queue to Chat** (GM-whisper)
165
165
-**Stop all Events** / **Stop all + 1h reminder**
166
166
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.
167
+
> Time formatting uses the active calendar adapter (D&D 5e, Seasons & Stars, or Simple Calendar Reborn when available). Falls back to Foundry core time if no calendar system is configured.
168
168
169
169
### Event Notification Cards
170
170
When events trigger, they display standardized notification cards with detailed information:
@@ -262,7 +262,7 @@ Event notifications play automatically when scheduled events fire, helping GMs t
262
262
- M4A (.m4a) - AAC audio, good quality
263
263
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+).
264
264
265
-
> 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.
265
+
> Date/time formatting uses the active calendar adapter (D&D 5e, Seasons & Stars, Simple Calendar Reborn when available), otherwise it falls back to Foundry core time.
266
266
267
267
---
268
268
@@ -280,7 +280,6 @@ Best practice: MP3 is the safest choice for maximum browser compatibility across
280
280
- This module is part of the **OverEngineeredVTT Suite** and Requires the installation of the lightweight OEV Suite Monitor, a master module that tracks OEV module versions for you and lets you know when updates or new modules are available.
281
281
282
282
## Additional links
283
-
284
283
- Join our [Discord](https://discord.gg/VNZwZTCB5U) server
285
284
- Support me on [Patreon](https://www.patreon.com/cw/u45257624)
**Simple Calendar** has been forked and updated for Foundry v13+ as **Simple Calendar Reborn** by Arctis Fireblight. This release brings full SCR integration to About Time Next with proper time authority delegation.
6
+
7
+
---
8
+
9
+
## Simple Calendar Reborn Support ✅
10
+
11
+
-**New SCRAdapter Class**
12
+
Added `SCRAdapter.js` implementing **Time Authority Model B**: When SCR is active, it becomes the authoritative time controller. ATN routes all time manipulation through SCR's API instead of directly modifying `game.time.worldTime`.
13
+
14
+
-**Time Routing Through Adapters**
15
+
All ATN time controls now use the adapter pattern:
16
+
- Realtime clock → `adapter.advanceTime(seconds)`
17
+
- Fast forward/rewind buttons → `adapter.advanceTime(seconds)`
When SCR is active, these calls route through `SimpleCalendar.api.changeDate()`. When using Seasons & Stars or D&D5e, they use `game.time.advance()` as before.
21
+
22
+
-**SCR as Time Authority**
23
+
When SCR is enabled, it controls worldTime and ATN enhances it with:
24
+
- Event scheduling and notifications
25
+
- Elapsed time tracking
26
+
- Additional UI controls (mini panel, toolbar)
27
+
28
+
ATN respects SCR's pause/combat settings and bypasses its own hooks to prevent conflicts.
29
+
30
+
-**0-Based Indexing Support**
31
+
SCRAdapter correctly handles Simple Calendar's 0-based month/day indexing (JavaScript Date-style), converting to 1-based display for users while maintaining API compatibility.
32
+
33
+
---
34
+
35
+
## Neutral Calendar Selection 🤝
36
+
37
+
-**No Calendar Hierarchy**
38
+
Removed the concept of "top-tier" calendars. All supported calendars (D&D5e, Simple Calendar Reborn, Seasons & Stars) are now treated equally.
39
+
40
+
-**Ethical Auto-Detection**
41
+
-**0 calendars available** → Use "none" (Foundry core time)
42
+
-**1 calendar available** → Auto-select that calendar (no favoritism)
43
+
-**2+ calendars available** → Use "none", show selection dialog
44
+
45
+
ATN no longer automatically picks one third-party calendar over another.
46
+
47
+
-**Selection Dialog for Multiple Calendars**
48
+
When multiple calendars are detected, GMs see a dropdown with all available options sorted alphabetically. Users make an explicit choice with a note: "All calendar systems are equivalent. Choose based on your preference."
49
+
50
+
-**Change Detection**
51
+
Dialog appears when new calendar modules are enabled, even if you're already using a different calendar system. Users are always informed of their options.
52
+
53
+
---
54
+
55
+
## Settings UI Enhancements 🎨
56
+
57
+
-**Calendar System Dropdown Tooltip**
58
+
Added explanation of time authority: "⚙️ Time Authority: SCR controls worldTime when active; ATN manages worldTime for D&D5e/S&S."
59
+
60
+
-**Detection Display Updates**
61
+
Calendar detection info now shows which system manages time:
62
+
- "✓ D&D 5e Calendar (available) - *Uses ATN Time Management*"
When SCR is active, ATN's pause/combat settings are disabled with informational boxes showing SCR's equivalent settings:
68
+
-`rtAutoPauseCombat` → Shows SCR's `combatRunning` value
69
+
-`rtLinkPause` → Shows SCR's `unifyGameAndClockPause` value
70
+
71
+
Both display: "⚠️ **Managed by SCR:**[setting status]"
72
+
73
+
---
74
+
75
+
## Architecture Improvements 🏗️
76
+
77
+
-**Time Authority Models**
78
+
Formalized two patterns:
79
+
-**Model A** (S&S, D&D5e): ATN controls time, calendar provides display
80
+
-**Model B** (SCR): Calendar controls time, ATN enhances with events
81
+
82
+
-**Logic Bypass for SCR**
83
+
Added `isSCRActive()` helper in `about-time.js` that skips ATN's pause/combat hooks when SCR is managing behavior, preventing conflicts.
84
+
85
+
-**Timestamp-Based Events Confirmed**
86
+
Events are stored as timestamps (seconds since epoch), making them calendar-agnostic. Switching between calendars preserves all events—only display format changes.
87
+
88
+
---
89
+
90
+
## Documentation 📚
91
+
92
+
-**SCR-ref-Doc.md**
93
+
Comprehensive Simple Calendar Reborn API reference with ATN integration patterns, time authority explanation, and 0-based indexing notes.
94
+
95
+
-**SCR-Integration-Summary.md**
96
+
Complete implementation guide covering time routing architecture, settings UI changes, logic bypass, and testing checklist.
97
+
98
+
-**Updated Reference Documentation**
99
+
`referenceDocumentation.md` now includes calendar system status, adapter architecture, and integration details for all supported calendars.
100
+
101
+
---
102
+
103
+
## User Interface Refinements 🎨
104
+
105
+
- A new calendar scan is run on load and shows a dialog allowing you to pick the calendar you want ATN to use. This may be dismissed until the next load or until a different calendar is selected in the settings page.
106
+
107
+
---
108
+
109
+
## Documentation Updates 📚
110
+
111
+
-**README.md**
112
+
Updated all Simple Calendar references to Simple Calendar Reborn with integration notes. Added explanation that Simple Calendar has been reborn and is now fully integrated with ATN.
113
+
114
+
---
115
+
116
+
## Migration Notes 📝
117
+
118
+
-**Legacy Simple Calendar**
119
+
Simple Calendar v1.x is archived and incompatible with Foundry v13. Users should migrate to Simple Calendar Reborn v2.4.0+.
120
+
121
+
-**Existing Events**
122
+
All existing events continue to work. Event timestamps are calendar-agnostic, so switching between SCR, S&S, and D&D5e preserves event timing.
123
+
124
+
-**Settings**
125
+
First-time users with multiple calendars will see a selection dialog. Existing users keep their current selection unless they enable additional calendar modules.
0 commit comments