Easy Timekeeping implements simple timekeeping without any fuss or complicated features. It's a lightweight, customisable, and easy to use timekeeping tool for any game. While general purpose, this module has some features that make it particularly suited to the Dragonbane game system. However, those optional features are turned off by default, and the Dragonbane system is not a dependency of Easy Timekeeping.
New feature in v1.5.0: optional analog clock. It's highly customisable, with the size, colors of the hands, 12-o-clock tick, and face all adjustable for each client. The time displays in the mouseover text and there's an additional setting for hiding the text-based time display while this clock is shown. As with the other features, this clock respects the GM setting controlling whether players can see the exact time. If your players shouldn't know what time it is, they won't ever see this clock.
Easy Timekeeping has the following main features:
-
The GM is always in control of the passage of time. At present, time is tracked independently of Foundry's world time, though I am planning an optional integration with that in a future release.
-
Media buttons allow the GM to quickly change the time by configurable small and large jumps. By default these are set to 15 minutes for small changes and 6 hours for large, but these can be changed in the module settings. Hold down the alt key for a double jump, or the shift key for a half jump.
- All time control buttons on the UI have keybindings, but they are unset by default. If you want to use keyboard shortcuts, you can assign keys in the Foundry Configure Controls menu.
-
An optional daylight cycle provides configurable automation of scene lighting. Note that the daylight cycle is disabled by default. Turn it on in the module settings. Once enabled, it is active for every scene in your world. To disable daylight cycles for a single scene, use the Foundry Darkness Level Lock setting in the scene lighting configuration.
-
By default, players see the exact time of day, though this can be changed. You can tell them nothing, show them the fuzzy time, or only show them the exact time at predefined intervals using a feature that posts the time to game chat at predefined intervals.
- A fuzzy time mode, showing the current game turn, shift, day, and week in both text and and visual form:
-
An API allows most features to be controlled from macros, such as setting the time, incrementing or decrementing the time, querying the current time, and posting the time to chat. All API functions are fully documented on the GitHub page.
- Extensive GM customisation options:
- fine-grained control over the amount of time information shown to players
- the number of days in a week
- the names of the days in a week
- the name of the week itself
- the names of the four shifts in a day
- the name of a game turn (defaults to 'stretch', which is 15 minutes in Dragonbane)
-
You can configure the system to automatically post a reminder of the time to the game chat:
-
Time change events allow further automation. There is a hook for world scripts, and the ability to specify a time change handler macro through the module settings (requires GM permissions). This allows you to develop scripted events that occur in response to the passage of time, or that take place only at certain times of day.
- Optional GM macro to customise the time chat message format.
- Client settings to customise the appearance of nearly all visual elements.
- Floating or docked UI modes.
- Bindable hotkey to show or hide the user interface (defaults to
Alt-Shift-E). - Extensive API examples in a compendium of macros.