Eras and Cycles
Eras and cycles are both optional. A calendar works without either one.
Eras are named historical periods with their own year numbering. Configure them on the Eras tab of the Calendar Editor.
Era fields
Section titled “Era fields”| Field | Description |
|---|---|
| Name | Full era name |
| Abbreviation | Short form. Leave it empty and the abbreviation tokens fall back to the first two characters of the name |
| Start Year | First year of the era |
| End Year | Last year of the era. Leave it empty for an ongoing era |
Era resolution
Section titled “Era resolution”A year matches an era when it falls on or after the Start Year, and on or before the End Year if one is set. The year within the era is the display year minus the start year, plus one.
Eras may overlap. Every era covering the current year matches, in the order the eras appear on the tab, and indexed format tokens pick one of them by position.
Displaying eras in date formats
Section titled “Displaying eras in date formats”The indexed tokens take a zero-based index into the matching eras. Index 0 is the first matching era, 1 the second.
| Token | Description |
|---|---|
G | Era abbreviation |
GGGG | Full era name |
[era=N] | Full name of the era at zero-based index N |
[eraAbbr=N] | Abbreviation of the era at zero-based index N |
[yearInEra=N] | Year within the era at zero-based index N |
[yearInEraOrdinal] | Year within era, ordinal form |
[yearInEraOrdinal=N] | Ordinal year within the era at zero-based index N |
Examples:
Y Gproduces “1492 DR”[era=0] / [era=1]produces “Dale Reckoning / Age of Mortals” when both eras overlap
Cycles
Section titled “Cycles”Cycles are repeating sequences of named stages. Configure them on the Cycles tab of the Calendar Editor.
Cycle fields
Section titled “Cycle fields”| Field | Description |
|---|---|
| Name | Cycle name |
| Length | How many based-on units pass before the cycle advances to its next stage. Use 1 for one stage per unit |
| Offset | Starting offset for the calculation |
| Based On | The unit that drives the cycle |
| Stages | The named stages, in order |
The whole cycle repeats every Length x number of stages based-on units.
Based-on options
Section titled “Based-on options”| Value | Description |
|---|---|
year | Calendar year |
eraYear | Year within current era |
month | Month index |
monthDay | Day of month |
day | Absolute day count from epoch |
yearDay | Day of year |
A cycle based on eraYear counts from the matching era with the latest Start Year. Era format tokens index the matching eras in calendar order instead, so with overlapping eras [yearInEra=0] and an eraYear cycle can count from different eras.
Display format
Section titled “Display format”The Display Format field builds the tooltip on the cycle indicator. Write each cycle’s number in brackets, one per configured cycle in order. Each placeholder is replaced with that cycle’s current stage name.
Example: [1] - Week of [2] produces “Gemini - Week of Fire”.
The indicator’s visible text does not come from this field. It comes from the cycles display mode set for the HUD, MiniCal or BigCal. See Settings.
A cycle with no stages contributes nothing, and its placeholder stays in the output as literal text. Placeholder numbers still follow the cycle order, so the cycles after it keep their numbers.
For developers
Section titled “For developers”See API Reference and Hooks.