Getting Started
This guide covers installation and initial setup of Calendaria.
Installation
Section titled “Installation”From Foundry
Section titled “From Foundry”- Open Foundry’s Setup screen
- Go to Add-on Modules
- Click Install Module
- Search for “Calendaria”
- Click Install
Manual Installation
Section titled “Manual Installation”Paste this manifest URL in the Install Module dialog:
https://github.com/Sayshal/calendaria/releases/latest/download/module.jsonThe Forge
Section titled “The Forge”Search for “Calendaria” in The Forge’s Bazaar.
First-Time Setup
Section titled “First-Time Setup”1. Enable the Module
Section titled “1. Enable the Module”- Launch your world
- Go to Settings → Manage Modules
- Enable Calendaria
- Save and reload
2. Choose a Calendar
Section titled “2. Choose a Calendar”On first load, the MiniCal appears with the Gregorian calendar selected by default. To change calendars:
- Click the gear icon on the MiniCal (or any Calendaria application) to open the Settings Panel
- In the Home tab, select a calendar from the dropdown (players can also view this tab)
- The world will reload to apply the change
[!NOTE] GMs can enable Show Active Calendar to Players to let players see the currently active calendar name. Use the search box at the top of the sidebar to quickly find settings.
Calendaria includes 19 pre-built calendars:
| Calendar | Setting |
|---|---|
| Athasian | 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 Calendar) | Pathfinder (IC era) |
| Gregorian | Real-world calendar |
| Greyhawk | World of Greyhawk |
| Harptos | Forgotten Realms |
| Imperial (Warhammer) | Warhammer Fantasy |
| Krynn (Elven) | Dragonlance |
| Krynn (Solamnic) | Dragonlance |
| Pact Standard (After Gap) | Starfinder 2E |
| Renescara | Homebrew showcase |
| Thyatian | Mystara |
| Traveller | Traveller RPG |
Gregorian, Golarion (Absalom Reckoning), Golarion (Imperial Calendar), and Pact Standard (After Gap) sync with the PF2E/SF2E World Clock out of the box. Other bundled calendars are tagged “likely incompatible” in the Calendaria settings picker on PF2E/SF2E worlds.
To create a custom calendar or import from another source, use the buttons in the Calendar tab. See Calendar Editor and Importing Calendars for details.
3. Configure Applications
Section titled “3. Configure Applications”By default, the MiniCal appears on world load. Other applications are available:
- HUD. Floating HUD with animated sky dome
- Time Keeper. Minimal time display and controls
- BigCal. Full calendar view via Journal footer or toolbar button
- Sun Dial. Circular sky clock with a draggable sun handle for setting time
- Stop Watch. Physical stop watch with real-time and game-time modes
Calendaria apps are also available via the Journal footer button or toolbar button (configurable in settings).
To configure which applications display:
- Open the Settings Panel (gear icon on any Calendaria application)
- Select the HUD, MiniCal, or Time Keeper tab
- Enable or disable the Show option for each application
[!TIP] Use the keyboard shortcut Alt+C to quickly toggle HUD visibility. Additional keybinds for BigCal, MiniCal, and Time Keeper are available but unbound by default. Configure them in Settings > Configure Controls > Calendaria.
Setting the Date
Section titled “Setting the Date”To set the initial date for your campaign:
- Open the HUD (Alt+C) or use the MiniCal
- Click on the current date display in the info bar
- Use the Set Date dialog to choose your starting date and time
- Click Set to apply the new date
Backup & Transfer
Section titled “Backup & Transfer”GMs can export settings for backup or to transfer configurations between worlds via Settings > Module tab > Backup & Transfer.