wgtnGM – Documentation

Mini Calendar

Mini Calendar is a compact, lightweight calendar for Foundry VTT. It provides a streamlined interface for managing time, dates, and notes without taking up valuable screen space. It offers two view modes: an ultra-compact and a month calendar view.

For bug reports, feature requests or general chat about the module or other publications, please join our community on Discord.

Manifest URL: https://github.com/xthesaintx/wgtgm-mini-calendar/releases/latest/download/module.json

Official Package URL: https://foundryvtt.com/packages/wgtgm-mini-calendar

Mini Calendar UI

The Mini Calendar header can be double-clicked to toggle between compact and month views. The window header also gives a visual representation of the time of day through icons and colours. The calendar can be opened with the icon in the sidebar or a shortcut key.

Compact View

The compact view shows today’s date and information, and allows quick switching between times via the bottom slider.

Top row (left to right):

  •  Moon Phase
  • Add a note to today
  • ( or custom icon) Show today’s notes dialogue, or hover for titles. A green icon indicates a repeating note.
  •  Date
  • Set the time to dawn on the following day
  • Set the time to dusk on the current day

Bottom row (left to right):

  • -1 hour
  • -10 minutes
  • Displays the current days weather
  • Time, click to change the current time
  • Start/Stop time (time will pause if running when Foundry pauses)
  • +10 minutes
  • +1 hour

Month View

The month view shows the current month, moon phases for each day, day notes, and the ability to browse months and years.
Events will display with their selected icon, or if there are multiple events on the day. A Green icon indicates a repeating event.

Controls

  • < > move back and forward in months
  • Month / Year, left-click to view or set to a year.
  • Day Grid displays notes (hover for titles), day number, and moon phase. Right-click to open a context menu to set a date or send a note to chat; left-click to edit or add a note.
  • -1 h, -10m, +10m, +1 h adjusts the time accordingly
  • Time, click to change the current time
  • Add a note to today
  • Enable/Disable weather sound effects
  • Enable/Disable weather effects
  • Change the view to today’s date
  • Set the time to dawn on the following day
  • Set the time to dusk on the current day
  • Open the configuration dialogue

The set-time dialogue allows precise time control.

The change-year dialogue allows you to view or set the date to any year.

Notes

When the calendar changes to a day with a note, a whispered chat message containing that day’s notes will be posted. Calendars can be prepopulated with notes; see the documentation on the Custom Calendars page.

Clicking a day or the add notes icon opens the new note dialogue.

A Title, icons, repeat data, and notes can be added.

Repeat: [Number of times to repeat: number, 0=forever] every [Number, period of units between repeats] [Unit, day, month, year]

Player Visible: The note will appear on the player view of the calendar.

If there are notes already on the day grid, a note summary will pop open instead, where notes can be edited (clicking on them) or deleted (clicking on the bin icon). A repeating note will have a icon. The icon indicates the note is visible to players and can be clicked on to toggle visibility.

Notes are stored in a single human-readable journal.

Configuration Dialogue

Several preset calendars are available, and you can add your own custom calendar. Documentation on the JSON format is available on the Custom Calendars page.

  • The Time Multiplier adjusts the ratio between the game clock’s speed and the real-world clock.
  • The icons in the header (/) allow importing and exporting JSON calendar data.
  • Import just the notes section of a JSON file, Documentation on the JSON format is available on the Custom Calendars page.

Scene Configuration

Mini Calendar can adjust the darkness of active scenes according to the time of day. If Enable Scene Darkness Control is enabled in settings, a Mini Calendar – Enable Darkness Control option becomes available in the Scene Configuration Lighting tab. When enabled, Mini Calendar will use the darkness values in settings, along with the dusk, dawn, and sun configuration, to adjust the scene’s darkness levels (if the scene is active).

Weather effects can also be enabled or disabled on a scene within the Scene Configuration.

Configure Weather

  • Current Biome: Temperate, Desert, Polar, Tropical. Adjusts forecasts.
  • Enable Visual Effects: Applies a weather overlay on the scene.
  • Enable Sound Effects: Plays Sound effects consistent with the visual effects.
  • Enable Forecasts: Generates weather forecasts on the calendar.
  • Use Celsius: Display temperatures in ºC rather than ºF
  • Broadcast weather to chat: On the change to a new day, the current day’s weather will be broadcast to the chat for all to see.
  • Non-Seasonal Aurora: If checked, it will show the aurora on a clear night all year round, regardless of season.
  • Chance for aurora on a clear night: 0-1, 1 will always show the aurora.

Macros

Mini Calendar includes a macros compendium with two macros available.

  • Open Calendar: Opens or toggles open/close the calendar.
  • Override Weather: Use this to override a day’s weather. The macro contains options for the weather type.
  • setTime: Change the day and hour, or use dusk/dawn to set the hour.

Settings

  • Calendar Configuration: Opens the Calendar config dialogue.
  • Configure Weather: Adjust weather options.
  • Welcome Message: Disable to view the welcome message.
  • Open Calendar Minimised: Will open the calendar in the minimised state.
  • Pause time on combat: Pauses the clock when combat starts.
  • Resume time on after combat: Restarts the clock after combat.
  • Enable Scene Darkness Control: Enables the option to enable darkness control in Scene Configuration.
  • Adjust Darkness on Active Scenes Only: When enabled a scene needs to be loaded and active to be affected by Darkness Control.
  • Enable Darkness on Scenes by Default: Enables darkness on scenes unless it has been set to false.
  • Darkness Level (Night) / (Day): Sets the darkness level used for night and day.
  • Darkness Level (Night Aurora) / (Full Moon): Sets the darkness level used when an aurora is active or there is a full moon.