RPG Calendar

THIS IS CURRENTLY A WORK IN PROGRESS

I will remove this message, when this library is ready for "prime-time"

About

This is a silly little project related to a much bigger (and even more silly) project. The point of this library is to work with fantasy calendars in a way that make it easy to create UIs.

Example Calendar UI using this library: steamedcotton.github.io/rpg-calendar

Usage

``typescript import { RPGCalendar, calendars } from 'rpg-calendar';

// Create a new Calendar using the Harptos Extra Days configuration. This will add the "special" days as extra days // at the end of each month. If you want the days to be separate months, then you can use // calendars.harptos.extraMonths. const cal = new RPGCalendar(calendars.harptos.extraDays);

// Use the calandar to parse an epoch console.log(cal.epochToDate('500-11:57:30'));

// Helpful format for working with months (to use when creating user interfaces) const monthToDisplay = cal.getDisplayMonth({ year: 1856, month: 4 }};`

`Built in Calendars`

So far just one with a couple options.

`$3`

It was a little difficult to find a source of truth of details around the calendar of Harptos. As best as I can tell, these assumptions are true and they are what I used to implement the configurations in calendars.harptos:

* There is a year 0. There are several references (like this one) to Year 0 - "The Year of the Rising Flame". * Year 0 was a leap year. I didn't find anything about this other than "every 4 years" and this makes it a little more consistent for the negative years (e.g. years -4, 0, 4 are all leap years).

Here are the two calendar settings for Harptos in code:`typescript import { calendars } from 'rpg-calendar';

// Use this calendar if you want the extra "special" days to be included in the preceeding month. // calendars.harptos.extraDays

// Use this calendar if you want the extra "special" days to each be their own month. This means that there // will be 17 months in a year. // calendars.harptos.extraMonths``

References

I used the following for references and inspiration:

- Forgotten Realms Calendar Tool
- D&D Forgotten Realms Calendar
- World Anvil - Calendar of Harptos
- City of Splendors. Dungeon of Madness. : Time in the Forgotten Realms

Usage

typescript
import { RPGCalendar, calendars } from 'rpg-calendar';

// Create a new Calendar using the Harptos Extra Days configuration.  This will add the "special" days as extra days
// at the end of each month.  If you want the days to be separate months, then you can use
// calendars.harptos.extraMonths.
const cal = new RPGCalendar(calendars.harptos.extraDays);

// Use the calandar to parse an epoch
console.log(cal.epochToDate('500-11:57:30'));

// Helpful format for working with months (to use when creating user interfaces)
const monthToDisplay = cal.getDisplayMonth({ year: 1856, month: 4 }};

Built in Calendars

So far just one with a couple options.

$3

It was a little difficult to find a source of truth of details around the calendar of Harptos.  As best as I can tell, these assumptions are true and they are what I used to implement the configurations in

calendars.harptos:

* There is a year 0.  There are several references (like this one) to Year 0 - "The Year of the Rising Flame".
* Year 0 was a leap year.  I didn't find anything about this other than "every 4 years" and this makes it a little more consistent for the negative years (e.g. years -4, 0, 4 are all leap years).

Here are the two calendar settings for Harptos in code:

typescript
import { calendars } from 'rpg-calendar';

// Use this calendar if you want the extra "special" days to be included in the preceeding month. 
// calendars.harptos.extraDays

// Use this calendar if you want the extra "special" days to each be their own month.  This means that there 
// will be 17 months in a year.
// calendars.harptos.extraMonths