Text Enrichers

Calendaria provides inline enrichers for journals, chat, items, and anywhere Foundry renders rich text.

[[cal.<type>]]                 → basic
[[cal.<type> <params>]]        → with parameters
[[cal.<type>]]{Custom Label}   → custom display label
[[cal.<type> cal=<id>]]        → cross-calendar query

[!TIP] Custom labels replace the display text but the tooltip still shows the real value. Custom labels disable live updates.

Date & Time

date

Display a date. Clickable: navigates calendar to that date.

[[cal.date]]                 → 5 Shadowmoon, 1499
[[cal.date 15 Mirtul 1492]]  → 15 Mirtul, 1492
[[cal.date 15 5 1492]]       → 15 Mirtul, 1492
[[cal.date format=dateFull]] → Mercday, 5 Shadowmoon 1499
[[cal.date approx=true]]     → Late Winter
[[cal.date time=true]]       → 5 Shadowmoon 1499, 14:30
[[cal.date format="{the }Do{ day of }MMMM"]] → the 5th day of Shadowmoon

Parameter	Type	Description
positional	`day month year`	Specific date (month name or index). Omit for current date
`format`	`string`	Format preset or token string
`approx`	`boolean`	Approximate date description
`time`	`boolean`	Include time

Custom format strings inside enrichers must use {...} for literal text, not [...]. The [[...]] enricher delimiters collide with [literal], so {literal} is the enricher-safe form. Both forms work identically in the settings Display Format editor.

time

Display the current time.

[[cal.time]]              → 14:30
[[cal.time 12h=true]]     → 2:30 PM
[[cal.time approx=true]]  → Afternoon

Parameter	Type	Description
`12h`	`boolean`	12-hour format
`approx`	`boolean`	Approximate time of day

weekday

[[cal.weekday]] → Mercday

season

[[cal.season]] → Spring

era

[[cal.era]] → Second Age

cycle

[[cal.cycle]] → Temporis

festival

Clickable. Opens festival note if one exists.

[[cal.festival]] → Midsummer

restday

[[cal.restday]] → Work Day

Time Math

countdown

Days until a target date. Clickable: navigates to target.

[[cal.countdown 1 Mirtul 1500]] → in 45 days
[[cal.countdown 1 6 1500]]      → in 45 days

countup / elapsed

Days since a target date, or days until when to= points to a future date. Clickable: navigates to target. Tooltip shows “X days until ” for future static targets and “X days since ” otherwise.

[[cal.countup 1 Mirtul 1490]]                                               → 730 days
[[cal.countup 1 Mirtul 1490 relative=true]]                                 → in 2 years
[[cal.countup 1 Mirtul 1490 relative=true simple=true]]                     → 2
[[cal.countup 1 Mirtul 1490 to="1 Mirtul 1492"]]                           → 730 days
[[cal.countup 1 Mirtul 1490 to="1 Mirtul 1492" relative=true simple=true]]  → 2
[[cal.countup 1 Mirtul 1490 to="event"]]                                    → 730 days (resolves to the host calendar note's start date)
[[cal.countup 1 Mirtul 1490 to="High Harvestide"]]                          → 730 days (resolves to a calendar note matched by name)
[[cal.elapsed 1 Mirtul 1490]]                                               → 730 days

Parameter	Type	Description
`relative`	`boolean`	Human-readable relative text (years/months/weeks)
`simple`	`boolean`	Return only the numeric count (e.g. `42` not `42 years ago`)
`to`	`string`	End date (`to="1 Mirtul 1492"`), `to="event"` for the host note’s start date, or a note name (`to="High Harvestide"`)

between

Distance between two dates.

[[cal.between 1 1 1490 to 1 6 1490]]             → 150 days
[[cal.between 1 1 1490 to 1 6 1490 unit=months]] → 5 months

Parameter	Type	Description
`unit`	`string`	`months` for month count

timeuntil

Time until a target event.

[[cal.timeuntil sunrise]]           → 3h 20m
[[cal.timeuntil sunset]]            → 8h 15m
[[cal.timeuntil midnight]]          → 9h 30m
[[cal.timeuntil midday]]            → 2h 10m
[[cal.timeuntil sunset hours=true]] → 8h 15m

Parameter	Type	Description
`hours`	`boolean`	Compact “Xh Ym” format

Targets: sunrise, sunset, midnight, midday

datemath

Date arithmetic from current date. Clickable: navigates to result.

[[cal.datemath +30d]]    → 6 Thawmoon, 1500
[[cal.datemath +2m -5d]] → 1 Shadowmoon, 1499
[[cal.datemath +1y]]     → 5 Shadowmoon, 1500

Units: d (days), m (months), y (years)

Calendar

calname

[[cal.calname]] → Forgotten Realms

month

[[cal.month]] → Shadowmoon

year

[[cal.year]] → 1499

dayofyear

[[cal.dayofyear]] → 287

yearprogress

Renders a progress bar.

[[cal.yearprogress]] → [========--] 79%

leapyear

[[cal.leapyear]] → Not a Leap Year

intercalary

[[cal.intercalary]] → Standard

daysinyear

[[cal.daysinyear]] → 365

Sun & Daylight

sunrise / sunset

[[cal.sunrise]] → 06:30
[[cal.sunset]]  → 18:45

daylight

[[cal.daylight]] → 12.3h

isdaytime

[[cal.isdaytime]] → Daytime

dayprogress / nightprogress

[[cal.dayprogress]]   → 65%
[[cal.nightprogress]] → 23%

untilsunrise / untilsunset

[[cal.untilsunrise]] → 5h 30m
[[cal.untilsunset]]  → 2h 15m

Moon

moon

Display moon phase info.

[[cal.moon]]               → Waxing Crescent (with icon)
[[cal.moon 1]]             → Full Moon (second moon)
[[cal.moon icon=true]]     → (icon only)
[[cal.moon position=true]] → 45%
[[cal.moon cycleday=true]] → 12
[[cal.moon isfull=true]]   → Not Full Moon

Parameter	Type	Description
positional	`number`	Moon index (0-based)
`icon`	`boolean`	Icon only
`position`	`boolean`	Cycle position %
`cycleday`	`boolean`	Day in cycle
`isfull`	`boolean`	Full moon check

moons

[[cal.moons]] → Selune: Full Moon, Tears: Waning

nextfullmoon

Date mode is clickable.

[[cal.nextfullmoon]]           → 22 Shadowmoon, 1499
[[cal.nextfullmoon countdown]] → in 8 days
[[cal.nextfullmoon 1]]         → 15 Thawmoon, 1499

convergence

Clickable. Requires 2+ moons.

[[cal.convergence]] → 15 Thawmoon, 1501

Eclipse

eclipse

Current eclipse status for a moon. Requires eclipses enabled in the Calendar Editor moon settings.

[[cal.eclipse]]   → Total Solar Eclipse
[[cal.eclipse 1]] → Partial Lunar Eclipse

Parameter	Type	Description
positional	`number`	Moon index (0-based)

Eclipse types: Total Solar, Partial Solar, Annular Solar, Total Lunar, Partial Lunar, Penumbral Lunar. Returns “No Eclipse” when none is occurring.

nexteclipse

Date of the next eclipse. Date mode is clickable: navigates to that date.

[[cal.nexteclipse]]             → 22 Shadowmoon, 1499
[[cal.nexteclipse countdown]]   → in 12 days
[[cal.nexteclipse 1]]           → 8 Thawmoon, 1500
[[cal.nexteclipse 1 countdown]] → in 45 days

Parameter	Type	Description
positional	`number`	Moon index (0-based)
positional	`string`	`countdown` for relative days

Weather

weather

[[cal.weather]] → Clear Skies (with icon)

temperature

[[cal.temperature]] → 72F

wind

[[cal.wind]] → Moderate SSE

precipitation

[[cal.precipitation]] → None

weathericon

[[cal.weathericon]] → (icon only)

zone

[[cal.zone]] → Temperate

forecast

Weather forecast block.

[[cal.forecast]]   → 3-day forecast (default)
[[cal.forecast 5]] → 5-day forecast

Parameter	Type	Description
positional	`number`	Days to forecast (default 3)

Notes

event

Clickable. Opens note.

[[cal.event The Council Meeting]] → The Council Meeting

notes

[[cal.notes]]                        → Council Meeting, Dragon Attack
[[cal.notes 15 5 1492]]              → Session Recap
[[cal.notes count=true]]             → 3 notes
[[cal.notes count=true scope=month]] → 12 notes

Parameter	Type	Description
`count`	`boolean`	Show count instead of names
`scope`	`string`	`month` for monthly count

Date mode is clickable. Opens note.

[[cal.next Council Meeting]]           → 22 Mirtul, 1492
[[cal.next Council Meeting countdown]] → in 7 days

chronicle

Clickable. Opens the Chronicle View locked to the date range — infinite scroll is disabled at the boundaries and the Today button is hidden.

[[cal.chronicle 1 10 1492 to 31 10 1492]] → 1 Shadowmoon, 1492 - 31 Shadowmoon, 1492
[[cal.chronicle 1 1 1500 to 14 1 1500]]{The Founding Week} → The Founding Week

Parameter	Type	Description
`cal`	`string`	Calendar ID to scope notes/weather to (optional)
`categories`	`string`	Comma-separated preset IDs applied as a one-shot Chronicle category filter; does not modify the persisted user filter (optional)

Composite

summary

Clickable. Navigates to today.

[[cal.summary]] → 5 Shadowmoon, 1499 · Clear · Waxing

almanac

[[cal.almanac]] → (multi-line block)

format

See Format Tokens.

[[cal.format EEEE, Do MMMM Y]] → Mercday, 5th Shadowmoon 1499

compare

Clickable. Navigates to target.

[[cal.compare 1 1 1490]] → in 9 years (3285 days)

peek

Clickable. Navigates to result.

[[cal.peek +7d]] → 12 Shadowmoon, 1499
[[cal.peek +1m]] → 5 Thawmoon, 1499

Actions

Clickable buttons that alter the calendar. Time actions are gated by canChangeDateTime and weather actions by canChangeWeather.

advancetotime

Advance the clock to the next HH:MM.

[[cal.advancetotime 06:30]]                  → advance forward to 06:30
[[cal.advancetotime 06:30 direction=nearest]] → snap to the closer side of midnight

Parameter	Type	Description
positional	`string`	Target `HH:MM`
`direction`	`string`	`nearest` to snap to the closer side of midnight

advanceinterval

Advance time by a composite delta.

[[cal.advanceinterval hour=2 minute=30]] → +2h 30m
[[cal.advanceinterval day=1 hour=6]]     → +1d 6h

Unit	Suffix
`second`	`s`
`round`	`r`
`minute`	`m`
`hour`	`h`
`day`	`d`
`week`	`w`
`month`	`mo`
`season`	`sea`
`year`	`y`

advancetopreset

Advance to the next named time-of-day.

[[cal.advancetopreset sunrise]]
[[cal.advancetopreset sunset]]

Targets: sunrise, midday, noon, sunset, midnight.

settime

Snap the clock to HH:MM on the current date without changing the day.

[[cal.settime 06:00]]

jumptodate

Move the world clock to the given date, preserving the current time of day.

[[cal.jumptodate 15 Mirtul 1492]]
[[cal.jumptodate 15 5 1492]]

toggleclock

Toggle the real-time TimeClock on/off.

[[cal.toggleclock]]

setweather

Apply a weather preset id.

[[cal.setweather clear]]
[[cal.setweather rain temperature=12 period=morning]]
[[cal.setweather snow allPeriods=true]]

Parameter	Type	Description
positional	`string`	Preset id
`temperature`	`number`	Override temperature
`period`	`string`	Intraday period to apply to
`zoneId`	`string`	Climate zone id
`allPeriods`	`boolean`	Apply to all intraday periods

Cross-Calendar

Any enricher accepts cal=<id> to query a non-active calendar.

[[cal.date cal=harptos]]     → 15 Mirtul, 1492
[[cal.moon cal=krynn]]       → Full Moon
[[cal.season cal=gregorian]] → Winter

This is read-only. Click navigation still targets the active calendar.