A simple calendar module for FoundryVTT that is system independent.
This module allows you to create a calendar with any number of months per year, any number of days per month and customizable hours, minutes and seconds for your game world. It is intended as a way for a GM to show a calendar like interface that maps to their in game world.
Simple Calendar has a number of features that make it a great time keeping tool for your games!
- Complete customization of the calendar to meet your worlds needs:
- Set the year as well as add any prefix or postfix to the years name.
- Define how many months in a year.
- Set a custom name, the number of days and days during a leap year (if applicable) for each month.
- Choose if months are considered intercalary (fall outside normal months).
- Set the number hours in a day, minutes in an hour and seconds in a minute.
- Set up your own Leap Year rules.
- Set up different seasons for your calendar and how they are displayed to the users.
- Set up your own custom moons.
- Or choose from a selection of preset calendars.
- Set and change the current day and time as your game story progresses or have it automatically advance based on real world time and passing combat rounds.
- Add notes to specific days on the calendar to remind yourself of events or other world related things.
- These notes can either be visible to players as well as the GM or just the GM.
- Browse a calendar interface to see the years, months and day of the game world.
- See the current day and time of the game world.
- Select days to view any notes/events specific to that day.
- If the GM allows it, the ability to add their own notes to the calendar.
- The Ability to switch between a full and compact view of the calendar.
- Installation
- Compatible Modules
- Accessing and using the calendar
- Changing the date and time
- Notes
- Configuring your Calendar
- Macros
- Hooks
- Translations
There are 2 ways to install the module, using the module.json file or by manually downloading the zip file.
To install using the module json file, use this link https://github.com/vigoren/foundryvtt-simple-calendar/releases/latest/download/module.json
To install the most recent version of the module, view the releases section to the right of the main GitHub page. Selecting the latest release will bring you to a page where you can download the module.zip asset. This will contain everything you need to manually install the module.
These are other time keeping modules that Simple Calendar can work if they are installed in your world.
Important: None of these modules are required, the option to work with them is available to make a GMs life easier if they want to use Simple Calendar but have another of these modules installed.
- about-time: See the about-time module configuration for Simple Calendar for more information.
- Calendar/Weather: See the Calendar/Weather module configuration for Simple Calendar for more information.
Simple Calendar is available in languages other than English thanks to the following people:
| Language | Translator(s) |
|---|---|
| German (de) | MasterZelgadis |
| Traditional Chinese (zh) | benwater12 |
If your language is missing from the list, and you would like to help translate Simple Calendar please follow these steps:
- Fork this repository.
- Under the src/lang folder copy the en.json file.
- Rename that file so that it matches your languages 2 letter ISO code.
- Go through that file and translate all the english values to your language.
- Open the src/module.json and add your language to the list under "languages"
- Update the ReadMe file to add your name to the table above.
- Create a pull request back into this repository with your additions.
- Know that your help is appreciated to bring this module to as many users as possible!
Moon Icons by Wolf Böse