Releases: vigoren/foundryvtt-simple-calendar
2.3.13 - Bug Fixes
Bug Fixes
- Fixed an issue loading images related to system specific themes on The Forge. (#517)
- Fixed a few issues with the classic theme when used in the Warhammer Fantasy Roleplay 4th Edition System.
- Fixed an issue loading images related to system specific themes when a
routePrefix
is set for FoundryVTT. - Fixed an issue displaying the Compact View Date/Time Control Layout images in the configuration when a
routePrefix
is set for FoundryVTT. - Fixed an issue with the Compact Display where very long date text would wrap. (#518)
- Fixed an alignment issue in the Compact Display with the date control buttons when the date text was wider than the buttons.
- Fixed a visual bug when importing from a configuration with notes. Each note would be counted twice until the page was refreshed.
2.3.6 - Bug Fixes
Bug Fixes
- Fixed a bug where certain chat messages would appear twice if the Use Game Time For Chat Message Timestamps setting is enabled. (#515)
- Fixed a bug where the game time would not be included when the chat log was exported. (514)
- Fixed a bug when players saved their client settings through Simple Calendars configuration dialog the date of the calendar would change to a year of 0.
- Fixed an error that would get logged in certain circumstances when using the configuration dialog. (424)
- Fixed a bug when importing from an invalid source that could result in a calendar with 0 months. (502)
- Fixed an issue where occasionally notes would not open. (468)
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- vincent (French)
- Jakub (Polish)
- TravelingK (Chinese (Simplified))
Documentation Changes
- Added search to the documentation site. This search is quite robust and is powered by algolia.
- Fixed several redirects that were not working.
2.3.0 - Chat Message Timestamps, Quality of Life Updates & Bug Fixes
Chat Message Timestamps
Simple Calendar can now be configured to change chat message timestamps from using the real life timestamps to using the date and time from SC (in game timestamps). (#490)
IMPORTANT: Only chat messages created after this version of SC is installed will show timestamps using in game timestamps. Chat messages created before do not contain the required metadata for displaying the in game time they were created.
- New setting under the
Global Configuration
called "Use Game Time For Chat Message Timestamps" that is used to enable or disable this feature. This will re-render the entire chat log for every player when changed. - New setting under the
Display Options -> Date/Time Formatting
for each calendar called "Chat Message Timestamp Format" that allows you to specify how the chat message timestamp is displayed.
Quality of Life Updates
- Added a keybinding to toggle if the calendar is visible or hidden. The binding can be edited to any key but by default uses the
Z
key. (#478) - Added an option when editing a note to set if you want to be reminded of the note. (#484)
Bug Fixes
- Fixed a bug when using the compact view and using the Quick Increment layout where hitting the
Shift
orControl
keys would cause the entire compact view to change widths. (#499) - Fixed a bug where the calendar would not always remember the last position it was moved to.
- Improved how custom themes look when system specific images fail to load. (#503)
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- Sven Hesse (German)
- Lucas (Portuguese (Brazil))
- Demian Wright (Finnish)
Documentation Changes
The documentation site has been completely re-done. The new site makes it easier to find information about how to configure and use Simple Calendar as well as develop for it using the API.
The new site also contains documentation for past versions of Simple Calendar so users can get help they need no matter the version they are using!
Be sure to check it out! https://simplecalendar.info
2.2.0 - Foundry Version 11 Update, Quality of Life Updates & Bug Fixes
Foundry Version 11 Update
Updated Simple Calendar to be functional with FoundryVTT version 10 and 11.
Fixes Include:
- Fixed when moving the application window to a new location, releasing the mouse would not stop the dragging action.
- Fixed switching into compact mode would fail to stay in compact mode.
- Fixed the icon for the button under "Journal Notes" not displaying correctly.
Quality of Life Updates
- Added a new predefined calendar for White Wolf's Exalted setting (Thanks Aliharu!)
Bug Fixes
- Fixed a bug where system specific themes would not load images properly if a routePrefix was set in Foundry's configuration.
- Fixed an issue where if the setting Show Clock was disabled and a user was using the Quick Increment Compact view layout no buttons would appear to adjust the date.
- Fixed a bug where a macro could not be selected from the macro list in a note.
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- Sven Hesse (German)
- vincent (French)
- Jakub (Polish)
- SwedishRabbit (Swedish)
2.1.80 - Quality of Life Updates & Bug Fixes
Quality of Life Updates
- Changed the Update Frequency setting so that it can support decimals. This can allow you to set an "Update Frequency" of 0.5 and a "Game Seconds Per Real Life Seconds" of 2 to get the game to move at twice the speed but have the clock still update for every game second.
- Updated the compact view to show up to 5 moons before collapsing them into a hover-over view.
- Added a new client setting "Compact View Scale" that allows you to change the scale at which the compact view is displayed at. You can use this to make the compact view appear larger or smaller. The number represents the percentage of the scale size when compared to the default size, 100%. The range goes in increments of 10 from 70% to 200%.
- Added support for keyboard key modifiers when in compact view with Time Control Layout set to
Quick Increment
:- Shift Key: When the shift key is held down the amount of time that is changed for each increment is increased from
1 round, 1 minute, 5 minutes, 15 minutes, 1 hour
to5 rounds, 5 minutes, 20 minutes, 45 minutes, 5 hours
. - Control Key: When the control key is held down each increment will be subtracted from the current time, this can be combined with the shift key for going back in time by larger amounts.
- Shift Key: When the shift key is held down the amount of time that is changed for each increment is increased from
Bug Fixes
- Fixed an issue where the hook
SimpleCalendar.Hooks.DateTimeChange
would fire twice when the time changed while the clock was running. It should now only fire once for every time increment. - Fixed an issue where on the full calendar view the preset time of day buttons would sometimes get bumped down to a second row.
- Fixed an issue where when in the compact view with the Time Control Layout set to
Full Controls
the unit selector would open up when near the top of the page potentially making some options inaccessible.
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- vincent (French)
Documentation Changes
- Improved the wording of the "Persistent Open" client setting to be more clear on where the toggle button is.
- Updated the Update Frequency documentation to note it supports decimals.
- Updated the Client Setting documentation to include information about the new "Compact View Scale" setting.
2.1.73 - Refreshed Compact Display, Quality of Life Updates and Bug Fixes
Refreshed Compact Display
The compact display has been updated to make it a little cleaner and utilize the unused space to keep it nice and compact without losing any functionality.
Changes include:
- If seasons are configured the current season will be shown by just its icon (or the first 2 letters of its name if no icon is chosen) in the top left of the header. Hovering over the icon will show the full season name.
- If moons are configured they are shown next to the season in the top left of the header. The current phase of the moon(s) are shown. If 1-2 moons are configured they will be shown beside each-other, if 3 or more moons are configured the first moon will be shown with an indicator that hovering over that icon will show a dialog will all the moons current phases.
- The note indicators (Notes for that day and notes you want to be reminded of) are shown in the top right of the header next to the close button.
- If the player has permissions to add notes the add note button is displayed next to the note indicators in the top right of the header.
- The main body of the display contains the current date and time. The primary GM will see the buttons to start/pause/stop the real time clock next to the time.
- If the player has permissions to change the current date and time at the bottom the buttons used to change the date and time as well as the dawn/midday/dusk/midnight buttons.
- All the themes have been updated to take advantage of this new layout.
Overall these changes have helped reduce the height and width of the compact display making it easier to keep on the screen while playing.
A preview of all themes for the new compact mode:
Time Control Button Options
The compact display also now lets you choose from 2 button layouts for changing the time!
- Full: This is the current layout and allows you to change any time unit forward or back.
- Quick Increment: This layout offers 5 options (1 Round, 1 Minute, 5 Minutes, 15 Minutes, 1 Hour) and allows users to quickly advance the time by those amounts.
The setting for this can be found under the calendars Display Options configuration section.
Quality of Life Updates
- Added a new client setting, Persistent Open, that when enabled will remove the close button from the calendar window and prevent the escape key from closing it. The button under the scene control then becomes a toggle to open and close the calendar.
Bug Fixes
- Fixed an issue when changing the Update Frequency setting while the clock was running that would result in the time updating incorrectly.
- Fixed an issue when reloading the page would not properly recognise any active combats and in certain cases the clock could be started.
- Fixed a few style issues with the Forbidden Lands theme.
- Fixed an issue with the Eclipse Phase system where note pages couldn't be added (Style change hide the interface).
- Fixed an issue where "When Leap Years Happen" could be set to 0 or a negative value, which doesn't make sense and would cause issues. If the value is set to something not valid the leap year rule will be set to None.
- Fixed a bug where loading of corrupt calendar configurations would prevent the module from working at all.
- Fixed an issue where some systems would break the displaying of icons within Simple Calendar.
API Changes
- Added a new function
SimpleCalendar.api.isOpen()
that will return a boolean if the calendar is open or closed. - Added a new hook
SimpleCalendar.Hooks.Init
. This hook fires as Simple Calendar is initializing but before the module is fully ready to use. - Added a new function,
SimpleCalendar.api.addSidebarButton
, for adding custom buttons to the right of the calendar.
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- Greg R. (Polish)
- Farevell (Chinese (Simplified))
- Sir Motte (German)
- Chris76J (German)
- Novella Locritani (Italian)
- Davide Lamberti (Italian)
Documentation Changes
- Added a new FAQ page to help answer some commonly asked questions!
- Added documentation for the new client setting Persistent Open.
- Added documentation for the new compact view options.
- Updated the client settings documentation for the new Persistent Open setting.
- Updated images of the compact view.
- Updated image for the client settings.
- Updated the image for the date/time formatting section of the display options.
- Added an image for the compact view options section of the display options.
2.1.60 - Bug Fix and Translation Updates
Bug Fixes
- Fixed broken help links in the configuration dialog.
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- vincent (French)
- Marc Feuillen (French)
- Raul Castaño (Spanish)
- Farevell (Chinese (Simplified))
- Greg R. (Polish)
- Michał Gołaszewski (Polish)
2.1.58 - Bug Fixes and API Changes
Bug Fixes
- Fixed an issue where if the
Remember Position
option was enabled and theRemember Compact Position
option was disabled the compact view would snap back to the full view's position when the time was changed.
Predefined Calendar
- Added a predefined calendar for the Ambrian Calendar from the Symbaroum system (Thanks bithir!)
API Changes
- Added a new function
SimpleCalendar.api.currentDateTime()
that returns a DateTime object with the current date and time of the active calendar, or calendar with the passed in ID. - Added a new function
SimpleCalendar.api.currentDateTimeDisplay()
that returns a DateDisplayData object for the current date and time of the active calendar, or the calendar with the passed in ID. - Added a new function
SimpleCalendar.api.formatTimestamp()
that functions just like the formatDateTime function but instead takes in a timestamp instead of a DateTimeParts object. - Added a new function
SimpleCalendar.api.getAllThemes()
that returns a list of all available themes for players to choose from. - Added a new function
SimpleCalendar.api.getCurrentTheme()
that returns the ID of the theme being used by the player. - Added a new function
SimpleCalendar.api.setTheme()
that takes in a theme ID and will set Simple Calendars theme to that ID for the player. An information notification will be shown to the player if the theme was changed to let them know it has been changed programmatically.
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- vincent (French)
- eunaumtenhoid (Portuguese (Brazil))
- ricdark (German)
2.1.50 - Quality of Life Improvements, Bug Fixes and a New Theme
Quality of Life Improvements
- A new client setting Always Show Note List has been added. This setting will make it so the note list will always be visible and can not be closed. The only exception is if the calendar list or note search are opened they will open over top of the note list, but when closed the note list will remain visible.
Bug Fixes
- Fixed an issue with the DSA/TDE 5 system theme that would cause the dialog background not to load properly.
- Fixed an issue with the DSA/TDE 5 system theme that cause the compact view dialog header to display incorrectly.
- Fixed an issue with the DSA/TDE 5 system theme where the clock would have a background color in compact view.
- Fixed an issue with the Warhammer 40,000: Wrath & Glory system theme where the clock would have a background color in compact view.
- Fixed an issue with the Warhammer Fantasy Roleplay system theme that would cause the dialog borders to not load correctly.
- Fixed a bug where the context menu for the note list would not appear in the correct location when the list expanded to the left or bottom of the calendar.
- Fixed a bug where if the side drawers were set to open below the calendar, the note list would not fully open in the compact view.
New Themes
- New Eclipse Phase 2E System Theme
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- vincent (French)
- eunaumtenhoid (Portuguese (Brazil))
2.1.40 - Theming, Quality of Life Improvements, Bug Fixes & API Updates
Theming
I have done a lot of work around making theming Simple Calendar as easy as possible. This allows me to add new themes easier and quicker. It also opens up the ability of third party modules or individuals to easily customize the look of Simple Calendar. For more details on how to theme Simple Calendar check out the theming documentation!
Changes that has been done to enable easy theming:
- Changed all sizes to use REM instead of PX so that the entire interface can scale easily with any changes to the root REM size.
- The addition of many CSS variables to quickly change how Simple Calendar looks. All the included themes use these variables to style SC.
Themes
To go along with these changes I have updated all the existing themes and added a couple of new themes to Simple Calendar!
Dark Theme | Light Theme |
Classic Theme | Warhammer Fantasy Roleplay 4th Edition System Theme |
NEW Forbidden Lands System Theme | NEW Das Schwarze Auge / The Dark Eye (5th Edition) System Theme |
NEW Starfinder System Theme | NEW Warhammer 40,000 Roleplay: Wrath and Glory System Theme |
Quality of Life Improvements
- Added a new client setting Remember Compact Position. When enabled Simple Calendar will remember where the compact view is on the screen separate from where the full view is. This allows users to place the compact view in a corner, switch to full view and have the full view in the middle of the screen, then switch back to compact view, and it will return to the corner.
- Added a new client setting Side Drawer Open Direction. This allows users to choose which direction from the calendar side drawers like the note list will open. The current options are Right, Left and Down that will open the side drawers to the right, to the left and below the main calendar.
Bug Fixes
- Fixed a few instances where the notes dialog would not be sized correctly.
- Fixed an issue where deleting a note after starting an edit would spawn several "Discard current changes" dialogs.
- Fixed a bug where notes shown in the search result list would not properly show who had access to view the note.
- Fixed a bug where the compact view would not have the correct height set.
- Fixed a bug with the
Unify Clock Start/Pause With Game Pause
setting that would make it so the game always started paused. (Fixes a compatibility error with the Koboldworkds - Pause Control module).
API Updates
- Changed the
SimpleCalendar.api.addNote()
function so that therepeats
andcategories
parameters are now optional. - Changed the
SimpleCalendar.api.addNote()
function so that the start and end dates are now DateTimeParts and any missing date/time properties on them will be filled out with the current date/time equivalent. - Added a new optional parameter to the
SimpleCalendar.api.addNote()
function,userVisibility
that takes in an array of user ID's. These users will be able to view the note. - Added a new optional parameter to the
SimpleCalendar.api.addNote()
function,remindUsers
that takes in an array of user ID's. These users will be reminded of the note.
Translation Updates
Thank you to the follow people for making updates to Simple Calendars translations:
- Bextia (Spanish)
- DragonHale (Spanish)
- Marc Feuillen (French)
- vincent (French)
- Sir Motte (German)
- Greg R. (Polish)
- Damian Wodziński (Polish)
- eunaumtenhoid (Portuguese (Brazil))
- benwater12 (Chinese Traditional)
Documentation Changes
- Added a link to the GitHub page for the module in the header of the documentation site.
- Added documentation for customizing the themes of Simple Calendar.
- Added documentation for contributing a new theme to Simple Calendar.
- Added documentation that outlines all the available themes within Simple Calendar.
- Updated the client settings documentation to include the new settings
Remember Compact Position
andSide Drawer Open Direction
. - Fixed some typos in the example of the setDate API function
- Fixed typos in the API documentation when referencing a
second
property when it should beseconds
. - Updated the example for the timestampToDate API function.
- Updated the example for the DateTimeChange hook.
- Updated the example for the getAllSeasons API function.
- Updated the example for the getCurrentSeason API function.
- Updated the example for the getAllMonths API function.
- Updated the example for the getCurrentMonth API function.
- Updated the example for the getAllWeekdays API function.
- Updated the example for the getCurrentWeekday API function.