HUD
A draggable widget shows date, time, weather, and events. It has two display modes: full HUD with an animated dome or slice, and compact calendar view.
Opening the HUD
Section titled “Opening the HUD”- Press Alt+C to toggle visibility.
- The HUD opens on world load when enabled in settings.
- Double-click the HUD bar to toggle between fullsize and compact modes.
See also: MiniCal and Time Keeper for alternative display options.
HUD mode
Section titled “HUD mode”Set the mode on the Settings HUD tab.
| Mode | Description |
|---|---|
fullsize | Animated sky view with sun/moon arc and info bar |
compact | Condensed bar with slice dial, no dome |
Double-click the HUD bar to toggle between fullsize and compact modes. Right-click the bar for a context menu:
- Settings - Opens the HUD settings tab.
- Show to All / Hide from All - Toggle HUD visibility for all players (GM only). The label is “Show to All” when the HUD is not forced, and “Hide from All” when it is.
- Reset Position - Resets the HUD to its default position.
- Lock/Unlock Position - Toggles position locking.
- Switch to Compact/Fullsize - Toggles between display modes.
- Close - Closes the HUD.
Dial styles
Section titled “Dial styles”Two styles render the sun and moon:
| Style | Description |
|---|---|
dome | Semi-circular dome above the bar with sun/moon arc |
slice | Horizontal strip in the bar with sun/moon traveling left-to-right |
Set the style on the Settings HUD tab.
Combat behavior
Section titled “Combat behavior”The HUD uses the shared combat behavior system through a per-user “Combat Behavior” dropdown on the Settings HUD tab.
The HUD adds two options beyond the standard set:
| Option | Description |
|---|---|
| None | No change during combat |
| Compact on Combat | Switch to compact/slice when combat starts |
| Compact on Encounter | Switch to compact/slice when a combat encounter is created |
| Hide on Combat | Hide the HUD entirely when combat starts |
| Hide on Encounter | Hide the HUD entirely when a combat encounter is created |
“On Encounter” modes trigger when a combat encounter is created in the tracker, before the “Start Combat” button is pressed. “On Combat” modes trigger only when combat actively starts.
Other widgets share the three common options: None, Hide on Combat Start, and Hide on Encounter Creation. Widgets restore when combat ends. See Settings for per-widget configuration.
Full HUD
Section titled “Full HUD”Dome display
Section titled “Dome display”Draws sky, sun, moon, stars, and weather particles in a single animated display.
Sky and celestial bodies
Section titled “Sky and celestial bodies”The sky crossfades through color keyframes over the day. The sun arcs across the dome during daylight with a corona pulse, and the moon takes over at night. Phase shadows use bezier curve terminators for accurate crescent shapes. Stars twinkle in the background and fade around twilight.
Multi-moon rendering
Section titled “Multi-moon rendering”When Show All Moons is enabled on the Settings HUD tab, secondary moons trail behind the primary moon at a scaled size. Each moon displays its phase and color glow from the calendar configuration.
Weather particle overlay
Section titled “Weather particle overlay”Weather conditions render as particle effects in the dome. Each weather preset maps to a hudEffect with its own particle behavior. See Weather Presets for the full list.
Wind speed and direction influence particle movement. Each weather effect can override the sky gradient colors.
Weather FX mode
Section titled “Weather FX mode”A per-client dropdown on the Settings HUD tab controls weather particle effects in the HUD dome and Sun Dial:
| Mode | Description |
|---|---|
| Full | All weather particle effects at full density |
| Reduced | Lower particle density |
| Off | No weather particle effects; sky, sun, and moon unaffected |
Performance mode
Section titled “Performance mode”Particle rendering scales with Foundry’s core performance mode:
| Mode | Description |
|---|---|
| Low | Reduced particle count |
| Medium | Standard particle count |
| High | Full particle count and effects |
Dome below bar
Section titled “Dome below bar”When enabled on the Settings HUD tab, the dome renders below the info bar instead of above it.
GM Only: Click the dome to open the Sun Dial.
Players: The dome is view-only and cannot be clicked.
Non-standard time support
Section titled “Non-standard time support”The HUD supports calendars with non-standard time units:
- The Sun Dial and hour markers scale to
hoursPerDay. - Sunrise and sunset positions are calculated from the calendar’s daylight settings.
- All time displays respect
minutesPerHourandsecondsPerMinute.
Sun Dial (GM only)
Section titled “Sun Dial (GM only)”Click the dome or slice to open the Sun Dial overlay:
- Drag the sun or moon around the arc to set the time.
- Time updates as you drag.
- Release to confirm.
- Click outside or press Escape to cancel.
Slice display
Section titled “Slice display”A horizontal sky strip used in place of the dome:
- Sun/moon travels left-to-right across the bar
- Time displayed over the sky gradient
- Used in compact mode automatically
Info bar
Section titled “Info bar”Bar contents (left to right):
- Search button - Opens the Note Viewer
- Add Note button - Creates a new note at the current game time
- Events - Icons for today’s notes; click an icon to open the note
- Date - Click to open the Set Date dialog (GM only)
- Time - Current time with play/pause button (GM only); shift-click to lock or unlock the clock
- Weather - Current weather; click to open weather picker (GM only). Shows “click to generate” prompt when no weather set. When Intraday Weather is enabled, hovering the weather block shows a tooltip with per-period weather breakdown (Night, Morning, Afternoon, Evening), highlighting the active period.
- Season - Current season name and icon
- Era - Current era indicator
- Cycle - Current cycle value
- Open Calendar - Opens BigCal or MiniCal per the Calendar Button setting; hidden when the user lacks view permission
- Settings - Opens the settings panel
Block visibility
Section titled “Block visibility”Hide each indicator block (weather, season, era, cycle) on the Settings HUD tab. Hiding blocks shrinks the HUD width.
Weather display modes:
- Full (icon + label + temperature)
- Icon + Temperature
- Icon Only
- Temperature Only
Season display modes:
- Icon + Text
- Icon Only
- Text Only
These settings are user-scoped; each player customizes their own view.
Event border glow
Section titled “Event border glow”When “Event Border Glow” is enabled and events exist on the current day, the HUD shows a glowing border. The toggle is a world-scoped, GM-only setting on the HUD tab; players do not see it. Disabling it removes the glow but keeps event icons, tooltips, and note actions.
Time controls tray (GM only)
Section titled “Time controls tray (GM only)”Hover over the bar to reveal time controls:
| Button | Action |
|---|---|
| Sunrise | Advance to next sunrise |
| Midday | Advance to solar noon |
| Custom Dec 2 | Jump backward by custom amount (if configured) |
| Custom Dec 1 | Jump backward by custom amount (if configured) |
| Reverse | Step backward by one increment |
| Increment dropdown | Set step size (second, round, minute, hour, day, week, month, season, year). Scroll mouse wheel over dropdown to cycle through options |
| Forward | Step forward by one increment |
| Custom Inc 1 | Jump forward by custom amount (if configured) |
| Custom Inc 2 | Jump forward by custom amount (if configured) |
| Sunset | Advance to next sunset |
| Midnight | Advance to next midnight |
Set the tray to open upward or downward on the Settings HUD tab.
Custom time jumps
Section titled “Custom time jumps”Configure custom jump buttons on the Settings HUD tab. Each increment type can have its own jump values across four buttons: two decrement and two increment. Leave a value blank to hide its button.
Clock lock
Section titled “Clock lock”Shift-click the play/pause button on the HUD, MiniCal, or Time Keeper to lock the clock. When locked:
- All time advancement is blocked: manual toggle, real-time sync, combat time, and rest advancement.
- The play/pause icon changes to a lock icon with an updated tooltip.
- The lock state persists across page refresh as a world setting.
Shift-click again to unlock. This requires time-change permission.
Clock sync
Section titled “Clock sync”The real-time clock syncs with game state:
- Pause Sync: The clock stops when the game is paused and resumes at 1:1 when unpaused.
- Combat Sync: The clock stops during combat, and time advances per turn through the system.
When sync is enabled and blocked by pause or combat, manually starting the clock shows a warning notification.
Configure sync behavior on the Settings Time tab.
Search
Section titled “Search”The Search button opens the Note Viewer, available in both HUD modes:
- Type at least two characters to match note names and category labels.
- Matching is a plain substring search with no prefix syntax.
- Click a result to open the note.
- Click the close button to dismiss the panel.
Positioning
Section titled “Positioning”Dragging
Section titled “Dragging”- Full HUD: Drag the info bar
- MiniCal: Drag the top row (month/year header)
Position is saved for each user.
Sticky zones
Section titled “Sticky zones”Drag the HUD near a predefined zone to snap it into place:
| Zone | Location |
|---|---|
top-center | Centered at top of viewport |
above-hotbar | Above the macro hotbar |
above-players | Above the players list |
below-controls | Below the scene controls |
When dragging into a zone, the HUD wobbles to indicate it will snap. Release to snap.
Mode Switching: Position is preserved when switching between display modes.
Toggle sticky zones on the Settings HUD tab.
Dome visibility (full HUD)
Section titled “Dome visibility (full HUD)”The dome fades as it approaches the top of the viewport and hides when space runs out. Disable this on the Settings HUD tab.
Locking position
Section titled “Locking position”Enable “Lock Position” in settings to prevent dragging. You can also lock or unlock position from the right-click context menu. Snapping to a sticky zone locks position.
Resetting position
Section titled “Resetting position”Use Reset Position on the Settings HUD tab or MiniCal tab.
Auto-Fade
Section titled “Auto-Fade”When enabled, the HUD fades to a configurable opacity after the mouse leaves:
- The fade triggers after a brief delay when the mouse exits.
- Hovering restores full opacity.
- Idle opacity is configurable.
Configure this on the Settings HUD tab.
Keyboard shortcuts
Section titled “Keyboard shortcuts”| Shortcut | Action |
|---|---|
| Alt+C | Toggle HUD visibility |
See Keybinds for all available keyboard shortcuts and configuration instructions.
Player permissions
Section titled “Player permissions”Players can:
- View date, time, and weather.
- Search notes.
- View non-GM notes.
- Create notes.
Players cannot open the Set Date dialog, change time, change weather, or access time controls. The dome and time-related controls are non-interactive for players.
Per-scene visibility
Section titled “Per-scene visibility”You can hide the HUD from players on individual scenes. When a player navigates to a scene with “Hide HUD for Players” enabled, their HUD closes. Navigating to a non-hidden scene restores the HUD if they have “Show HUD on load” enabled.
Enable this in Scene Configuration > Calendaria tab > Hide HUD for Players.