Repository navigation
GM Guide
Everything a GM sets up for Sundial Calendar, from turning the calendar on to the settings that dress it for your campaign.
The module replaces the look of D&D 5e's own calendar. The calendar's date, time, festivals and seasons are still D&D 5e's, set in D&D 5e's settings. Sundial Calendar adds the bar, the sky, the moons and the settings below.
Install the module as described in the README, then turn on Sundial Calendar under Manage Modules in a D&D 5e world. It needs Foundry VTT 14 and D&D 5e 6.x.
D&D 5e's calendar is off in a new world, and Sundial Calendar only shows once it's on.
The first time a GM loads the world with the module active, the module offers to turn it on. Choose Turn It On. If you choose Not Now, it won't ask again, but you can turn the calendar on yourself: in Game Settings → Configure Settings, open D&D 5e's Configure Calendar and tick Enabled.
Turning the calendar on changes how items recover. With the calendar on, D&D 5e recovers items with daily, dawn and dusk uses as time passes, not on a long rest. To keep recovery on rests, set Daily Recovery Mode to Manual Recovery in the same window.
Also in Configure Calendar, choose the world's Calendar. The world reloads when you change it.
| Calendar | Setting | Festivals | Moons |
|---|---|---|---|
| Calendar of Harptos | Forgotten Realms | Midwinter, Greengrass, Midsummer, Shieldmeet, Highharvestide, the Feast of the Moon | Selûne, with the Tears of Selûne |
| Calendar of Greyhawk | Greyhawk (Oerth) | Needfest, Growfest, Richfest, Brewfest | Luna and Celene |
| Calendar of Khorvaire | Eberron | None | All twelve, Zarantyr to Vult |
| Gregorian | Earth | None | The Moon |
| Exandrian Calendar | Exandria (Tal'Dorei, Wildemount) | 21 holidays, from New Dawn to Winter's Crest | Catha and Ruidus |
| Solamnic Calendar | Krynn (Dragonlance) | None | Solinari, Lunitari and Nuitari |
The last two are the module's own. They're only in the list once you add them: see Additional calendars.
The Moons covers each calendar's moons in detail.
Set the starting date with the calendar button on the bar (Set Date), or move the time on with the bar's buttons or /advance. See Running time.
The module's settings are in Game Settings → Configure Settings → Sundial Calendar. Settings marked World are the GM's choice, for everyone. Settings marked Player are each player's own choice, for their own screen.
| Setting | Who | Default | What it does |
|---|---|---|---|
| Animate Time Changes | Player | On | Plays a change of time out on the calendar: the clock runs, the wheel turns and the moons move. Off, the calendar jumps straight to the new time. |
| Calendar Style | Player | Gilded Night | How the calendar looks: Gilded Night (gold on a night sky), Parchment (bronze and ink on parchment) or Underdark (steel on stone). |
| Dress the Sky for the Season | World | None | Trims the rim of the sky round the day wheel. Follow the Seasons changes with the year and dresses festival days for the festival. Just Winter, Just Spring, Just Summer or Just Autumn keeps to one season all year. |
| Dress the Bar for Your Adventure | World | None | Trims the bar for the adventure you're running, or the world it's set in. See Adventure trims. |
| Darken Scenes at Night | World | Off | Keeps the active scene's darkness in step with the sky. See Darkness. |
| Warm Light at Dawn and Dusk | World | On | Tints the active scene gold around sunrise and amber around sunset, while Darken Scenes at Night is on. See Dawn and dusk. |
| Show the Weather in the Sky | Player | On | Draws the weather of the scene you're looking at in the sky. See Weather. |
| Long Summer Days | World | Off | Moves sunrise and sunset with the seasons: sixteen hours of daylight at midsummer and eight at midwinter. See Long summer days. |
| Announce Each Dawn | World | Off | Posts each new day to the chat as the sun rises. See Dawn announcements. |
| Additional Calendars | World | None | A button that opens a list of the module's own calendars to add to D&D 5e's. See Additional calendars. |
D&D 5e's own Calendar Preferences, which each user sets for themselves, still apply: Display Calendar HUD hides or shows the calendar, and Date Format and Time Format change how the date and time are written.
D&D 5e has calendars for the Forgotten Realms, Greyhawk, Eberron and Earth. The module adds more, for other settings. Click Choose Calendars under Additional Calendars, tick the ones you want, and Save. When the world reloads, they're choices in D&D 5e's Configure Calendar, alongside its own.
| Calendar | Setting | Source | Starts |
|---|---|---|---|
| Exandrian Calendar | Exandria: Tal'Dorei and Wildemount | Tal'Dorei Campaign Setting Reborn, Explorer's Guide to Wildemount | 836 PD |
| Solamnic Calendar | Krynn | Dragonlance: Shadow of the Dragon Queen | 351 AC |
- Exandria: eleven months of 27 to 32 days, 328 days in all, and seven-day weeks from Miresen to Da'leysen. Its 21 holidays fall on ordinary days, so the date is still shown, and the holiday is marked beside the sky. The seasons start on the holidays that mark them: the Renewal Festival, Zenith, Harvest's Close and Barren Eve. Where the two books differ, the module follows Tal'Dorei Campaign Setting Reborn, the newer.
- Krynn: twelve months of four seven-day weeks, from Newkolt to Frostkolt, with the seasons by month as in our own year.
The world's own calendar can't be unticked, as the world would lose it. Pick another calendar in Configure Calendar first.
Every D&D adventure and campaign setting Wizards of the Coast has published for fifth edition has a trim for the bar, and there's one for World of Warcraft: 49 in all, chosen in Dress the Bar for Your Adventure. Where a setting and its adventures share a world, they share a trim. Trims and Styles shows each one, with the books it covers, and the sky's trims and the styles too.
The adventure trim and the sky's seasonal trim can be used together.
Only the GM can move the time. Players see the calendar follow along.
| Button | Who sees it | What it does |
|---|---|---|
| ⏪ Rewind | GM | Moves the time back an hour. Hover for a drop-down of other amounts: 7 days, 1 day, 8 hours, 1 hour, 10 minutes or 1 minute. |
| 📅 Set Date | GM | Opens D&D 5e's dialog to set the date and time. |
| 👤 Character Sheet | Players with a character | Opens your character's sheet. |
| ⏩ Advance | GM | Moves the time on an hour, with the same drop-down as Rewind. |
| 👥 Party Sheet | Anyone who can see the party | Opens the party's sheet. |
| ⌃ Collapse | Everyone | Folds the calendar up to the bar alone, or opens it again. Each user's choice is kept. |
Buttons other modules add to D&D 5e's calendar appear on the bar too.
| Command | Who | What it does |
|---|---|---|
/date |
Everyone | Whispers you the date, the time, the season, any festival, and each moon's phase and when it's next full. |
/advance 8 hours |
GM | Moves the time on. Amounts can be combined and shortened: /advance 1 day 6 hours, /advance 1d 6h, /advance 90 minutes, /advance 2w. A number on its own is hours, and /advance on its own is an hour. |
/advance dawn |
GM | Moves on to the next dawn, noon, dusk or midnight (sunrise and sunset work too). |
/rewind 90 minutes |
GM | Moves the time back by an amount, or to the last dawn, noon, dusk or midnight. |
Units can be written as seconds (s, sec), minutes (m, min), hours (h, hr), days (d) or weeks (w, wk).
With Darken Scenes at Night on, the active scene's darkness follows the sun:
- Full daylight until the late afternoon.
- Fading through the late afternoon, sunset and twilight, by the height of the sun.
- Night once twilight has passed, lightened a little by a bright moon high in the sky.
- The same in reverse before dawn.
Things to know:
- Only the active scene is changed. Switching scenes brings the new one into step.
- Scenes with no sky can be left out. Each scene has Follow the Sky in its configuration, on the Environment tab under Darkness, ticked to start with. Untick it for a scene that shouldn't follow the time of day, such as a dungeon, the Underdark or a fey glade that's always bright, and set its darkness yourself as usual. Tick it again and the scene comes back into step.
- Scenes with their darkness locked are left alone too. Darkness Level Lock also stops you changing the darkness yourself, so use Follow the Sky for a scene you only want to keep off the sky.
- A GM must be logged in. The active GM's client updates the scene, so time moved while no GM is connected catches up when one joins.
- Small steps, such as a combat round's six seconds, don't update the scene. The darkness moves once the change is large enough to see.
With Darken Scenes at Night and Warm Light at Dawn and Dusk both on, the active scene's light turns warm as the sun nears the horizon: pale gold for about an hour either side of sunrise, deep amber either side of sunset. It fades in and out with the darkness, by the height of the sun, and follows Long summer days.
- Nothing is saved to the scene. Each player's Foundry works the tint out for itself, so turning it off puts every scene back as it was.
- A scene with a tint of its own keeps it. If you've set the scene's own colour in Scene Configuration → Environment (its Intensity above 0), the module leaves its light alone.
- Scenes off the sky are left alone, the same as for darkness: those with Follow the Sky unticked or their darkness locked.
Set a scene's Weather in its configuration, on the Basics tab, and the sky shows it:
| Scene weather | The sky |
|---|---|
| Rain | Clouds and rain |
| Rain Storm | Dark clouds, heavy rain and the odd flash of lightning |
| Snow | Clouds and falling snow |
| Blizzard | Clouds and snow driving across the sky |
| Fog | Banks of fog drifting slowly over the sky |
| Autumn Leaves | Leaves blowing past |
The clouds pass in front of the sun and moons and dim the stars. The snow and leaves are Foundry's own, the same as on the canvas.
- Each player sees their own scene's weather, the scene they're looking at. A player with the canvas off sees the active scene's.
- Weather from other modules that add to Foundry's weather list is shown when its name says what it is: anything named for rain, drizzle, storms, thunder, snow, sleet, hail, fog, mist, leaves, clouds or overcast.
- Each player can turn it off for themselves with Show the Weather in the Sky. It also stays still for anyone whose system asks for reduced motion.
With Long Summer Days on, sunrise and sunset move with the seasons, from sixteen hours of daylight at midsummer to eight at midwinter. Everything that asks the calendar for sunrise and sunset follows:
- The day wheel: the day half grows and shrinks.
- The sun and moons: the sun crosses the sky slowly on a long day and quickly on a short one, and the moons keep pace, so a full moon rises at sunset and sets at sunrise.
- The scene's darkness.
- D&D 5e's dawn and dusk recovery, and its approximate times of day.
-
The dawn announcements, and
/advance dawnand/advance dusk.
Off, the sun rises and sets at the calendar's usual hours all year.
With Announce Each Dawn on, each new day is posted to the chat as the sun rises, by The Calendar:
- The date and the day of the week.
- The first day of a season, when it is one.
- Any festival.
- Any moons full or new that day.
A jump over several days posts only the last dawn, not one for every day passed. As with darkness, a GM must be logged in for the post to be made.
The calendar doesn't show.
- Check D&D 5e's calendar is Enabled in Configure Calendar.
- A player may have turned off Display Calendar HUD in their own Calendar Preferences.
- Another module that replaces D&D 5e's calendar can stop this one showing. D&D 5e says "The default calendar interface isn't available" when that happens.
There are no moons, or no festivals.
- Moons and festivals depend on the world's Calendar. Khorvaire, Gregorian and Krynn have no festivals, and a calendar other than D&D 5e's four and the module's own has no moons until a module adds some. See The Moons.
The scene doesn't darken.
- Check Darken Scenes at Night is on, the scene is the active one, Follow the Sky is ticked in its configuration, and its darkness isn't locked.
- A GM must be logged in.
Items recover on the wrong schedule.
- D&D 5e ties item recovery to the calendar being on. Set Daily Recovery Mode in Configure Calendar: Calendar Recovery for time passing, Manual Recovery for the rest dialog.
The moons of any calendar can be changed, or added for a homebrew calendar, with the sogrom-sundial-calendar.moons hook. See Changing the moons.
These pages are built from the docs in the repository. To change them, edit the docs there.