Getting Started

Calendaria requires Foundry VTT v14 or newer and the 3DS:ATLAS library module. Foundry offers to install ATLAS for you when you install Calendaria from the package browser.

Installation

From Foundry

1. Open Foundry’s Setup screen
2. Go to Add-on Modules
3. Click Install Module
4. Search for “Calendaria”
5. Click Install

Manual installation

Paste this manifest URL in the Install Module dialog:

https://github.com/Sayshal/calendaria/releases/latest/download/module.json

The Forge

Search for “Calendaria” in The Forge’s Bazaar.

First-time setup

1. Enable the module

1. Launch your world
2. Go to Settings → Module Management
3. Enable Calendaria
4. Save and reload

On a dnd5e world, Calendaria replaces the system’s own calendar and suppresses the system calendar display. If the system calendar was enabled, Calendaria switches it off and turns on the HUD in its place.

2. Choose a calendar

The MiniCal and the HUD open on first load with the Gregorian calendar active. To switch calendars:

1. Click the gear icon on the MiniCal to open the Settings Panel
2. Pick a calendar from the dropdown in the Home tab
3. Confirm the reload prompt

Note

Players see the active calendar name through whichever widgets they can view. The Change Active Calendar permission governs whether they can switch it. See Permissions.

Calendaria ships 20 calendars:

Calendar	Setting
Athasian (Tyr)	Dark Sun / Athas
Barovian	Ravenloft / Barovia
Cerilian	Birthright
Drakkenheim	Drakkenheim
Exandrian	Critical Role
Forbidden Lands	Forbidden Lands
Galifar	Eberron
Golarion (Absalom Reckoning)	Pathfinder (AR era)
Golarion (Imperial)	Pathfinder (IC era)
Gregorian	Real-world calendar
Greyhawk	World of Greyhawk
Harptos	Forgotten Realms
Imperial (Warhammer)	Warhammer Fantasy
Islamic (Hijri)	Real-world lunar calendar
Krynn (Elven)	Dragonlance
Krynn (Solamnic)	Dragonlance
Pact Standard (After Gap)	Starfinder 2E
Renescarran	Homebrew showcase
Thyatian	Mystara
Traveller Imperial	Traveller RPG

On PF2E and SF2E worlds, only Gregorian, Golarion (Absalom Reckoning), Golarion (Imperial), and Pact Standard (After Gap) sync with the system World Clock. The picker tags the other bundled calendars “likely incompatible”.

To build a calendar of your own or convert one from another module, use the Open Calendar Editor and Open Importer buttons in the Home tab. See Calendar Editor and Importing Calendars.

3. Configure applications

The MiniCal and the HUD open on world load. The HUD is a floating display with an animated sky dome. The rest stay closed until you switch them on:

• BigCal. Full calendar view
• Time Keeper. Minimal time display and controls
• Sun Dial. Circular sky clock with a draggable sun handle for setting time
• Stop Watch. Timer with real-time and game-time modes
• Chronicle. Chronological view of calendar notes
• Note Viewer. Filtering and bulk editing for calendar notes

To choose which applications open on load:

1. Open the Settings Panel from the gear icon on the MiniCal
2. Select the application’s tab
3. Toggle its show-on-load setting

The Note Viewer has no tab and no show-on-load setting. Open it from its keybind, or from the note button on the MiniCal, BigCal, and the HUD.

Calendaria apps also open from a button row in the journal directory footer, or from buttons in the Notes control group on the scene toolbar. Both are configured in the Settings Panel Module tab, where you also choose which applications get a toolbar button. The journal footer row is off until you switch it on.

Tip

Alt+C toggles the HUD and Alt+W toggles the Stop Watch. The rest ship unbound: BigCal, MiniCal, Time Keeper, Sun Dial, Chronicle, Note Viewer, and the Stop Watch start/pause and reset controls. Bind them in Settings > Controls Configuration > Calendaria. See Keybinds.

Setting the date

1. Open the HUD and click the date display, or click Set Date & Time in the Settings Panel Home tab
2. Choose the date and time
3. Click Set Date

You can also right-click a day in the MiniCal or BigCal and choose Set Current Date.

Backup and transfer

Export your settings for backup, or to move a configuration between worlds, from the Backup & Transfer section of the Settings Panel Module tab. See Settings Backup.