Permissions
Role-based permissions control which Calendaria features each user role can reach.
Overview
Section titled “Overview”You configure permissions for three roles: Players, Trusted Players, and Assistant GMs.
Foundry treats the Assistant GM role as a GM, so Calendaria’s permission check passes for GMs and Assistant GMs before it ever reads the stored values. An Assistant GM holds every permission, sees every GM-only Settings Panel tab, and never appears in a Show to All blocked-user warning, whatever the Assistant GM column shows. That column changes behavior only for a role Foundry does not report as a GM.
Widget view permissions
Section titled “Widget view permissions”Every widget has a dedicated view permission. Without it, the widget does not render and the user sees nothing in its place. View permissions cover BigCal, MiniCal, HUD, Time Keeper, Sun Dial, Chronicle, and Stop Watch.
Those widgets do not open for a user who lacks the matching permission. When a keybind or a macro tries to open one, the user gets a notification saying access to the feature is not permitted. The Note Viewer is the exception: View Note Viewer hides the buttons that open it, but its keybind still opens it.
When you use Show to All, Calendaria checks whether any active players are blocked by view permissions. If any are, you get a notification listing the blocked users by name. Permitted users see the widget; blocked users are unaffected.
Configuring permissions
Section titled “Configuring permissions”- Open the Settings Panel
- Open the Permissions tab, which is GM only
- Set permissions for each role with the checkboxes
- Changes save automatically
Available permissions
Section titled “Available permissions”UI visibility permissions
Section titled “UI visibility permissions”| Permission | Key | Description |
|---|---|---|
| View BigCal | viewBigCal | Can see the BigCal |
| View MiniCal | viewMiniCal | Can see the MiniCal widget |
| View Note Viewer | viewNotes | Can open the Note Viewer |
| View HUD | viewHUD | Can see the HUD |
| View Time Keeper | viewTimeKeeper | Can see the Time Keeper |
| View Sun Dial | viewSunDial | Can see the Sun Dial |
| View Chronicle | viewChronicle | Can see the Chronicle timeline |
| View Stop Watch | viewStopwatch | Can see the Stop Watch |
Action permissions
Section titled “Action permissions”| Permission | Key | Description |
|---|---|---|
| Add Notes | addNotes | Can create own calendar notes |
| Delete Notes | deleteNotes | Can delete calendar notes in bulk |
| Change Date/Time | changeDateTime | Can modify the world date and time |
| Change Weather | changeWeather | Can set weather conditions |
| View Weather Forecast | viewWeatherForecast | Can view weather forecasts and day-cell forecast icons |
| Change Active Calendar | changeActiveCalendar | Can switch the active calendar |
| Edit Calendars | editCalendars | Can access the Calendar Editor |
Default permissions
Section titled “Default permissions”Non-GM roles start with restricted access. The table records what is stored, not what an Assistant GM can actually do.
| Permission | Player | Trusted | Assistant GM |
|---|---|---|---|
| View BigCal | - | ✓ | ✓ |
| View MiniCal | - | ✓ | ✓ |
| View Note Viewer | ✓ | ✓ | ✓ |
| View HUD | ✓ | ✓ | ✓ |
| View Time Keeper | - | ✓ | ✓ |
| View Sun Dial | - | ✓ | ✓ |
| View Chronicle | - | ✓ | ✓ |
| View Stop Watch | - | ✓ | ✓ |
| Add Notes | ✓ | ✓ | ✓ |
| Delete Notes | - | - | ✓ |
| Change Date/Time | - | - | ✓ |
| Change Weather | - | - | ✓ |
| View Weather Forecast | - | ✓ | ✓ |
| Change Active Calendar | - | - | - |
| Edit Calendars | - | - | - |
How permissions work
Section titled “How permissions work”UI controls
Section titled “UI controls”Without permission for an action, the matching UI controls are hidden or disabled:
- Time controls are hidden without Change Date/Time permission, and the Time Keeper renders no controls tray in their place
- The weather picker is disabled without Change Weather permission
- Note creation buttons in the Note Viewer and Chronicle are hidden without Add Notes permission
- BigCal’s add-note controls stay visible but block creation with a warning for a user without Add Notes permission
- The Note Viewer button is hidden without View Note Viewer permission
- Calendar button visibility is gated by
canViewBigCalorcanViewMiniCalper the Calendar Button setting - The Calendar Editor button is GM-only
- The Edit Calendars permission gates calendar editing through the API
- The MiniCal’s Open BigCal button is hidden without View BigCal permission
- The Open context submenu lists only the widgets the user has view permission for
- The Calendaria buttons in the Scene Controls sidebar and in the Journal sidebar footer show only the apps the user has view permission for
- Action enrichers such as
advancetotimeandsetweatherare gated by Change Date/Time and Change Weather; a non-GM click relays to a GM - An enricher pinned to a past date honors fog of war for players; an enricher pinned to a future weather date honors View Weather Forecast
Change Date/Time and Change Weather do not let a non-GM write world state directly. A permitted non-GM’s action is sent to the primary GM over socket and applied there, so it takes effect only while a GM is connected.
BigCal’s weather indicator opens the Weather Picker for a GM only. A non-GM holding Change Weather reaches the picker from the MiniCal or the HUD instead.
Permission inheritance
Section titled “Permission inheritance”A permission granted to a lower role also applies to the higher roles. The checkboxes stay independent, so checking or unchecking one role leaves the other roles untouched.
Notes on specific permissions
Section titled “Notes on specific permissions”Add notes
Section titled “Add notes”- A user views non-GM-only notes they hold at least OBSERVER permission on, respecting Foundry journal permissions
- The permission grants note creation
- If the user lacks Foundry’s core
JOURNAL_CREATEpermission, note creation relays to a connected GM over socket
Delete notes
Section titled “Delete notes”The permission governs bulk deletion through the API. On the note sheet, the delete button appears in edit mode for the note’s author and for a GM, regardless of this permission. The Note Viewer’s context-menu Delete entry requires both GM and this permission.
Note editing
Section titled “Note editing”Note editing is gated solely by per-note Foundry document ownership. Each note’s ownership is set via the Ownership section on the note sheet’s Settings tab. The Ownership fieldset on the note sheet is disabled for players. Players cannot change who has access to a note, even their own notes.
Change weather
Section titled “Change weather”The permission covers choosing a weather preset and generating weather. Setting fully custom weather values stays GM-only; a non-GM holding the permission is told that only the GM can set custom weather.
View weather forecast
Section titled “View weather forecast”- Gates the
getWeatherForecast()API method - Gates the
/forecastand/weatherprobchat commands - Controls the forecast weather icons on calendar day cells
- Controls the intraday period breakdown in weather tooltips and forecast data; without it a player sees only the daily aggregate weather
- Gates a weather enricher pinned to a future date; without it a player sees
Not yet known - A GM always has access regardless of this permission
Settings tab access
Section titled “Settings tab access”- The app settings tabs expose their user-scope settings to non-GM users
- World-scope settings on those tabs stay GM-only
- The Notes, Time, Weather, Fog of War, Macros, Chat, Permissions, Canvas, and Cinematics tabs are GM only
- Settings Panel tabs for BigCal, MiniCal, HUD, Chronicle, Time Keeper, Stop Watch, and Sun Dial are hidden from a user who lacks the matching view permission
- A hidden tab’s contents are not built for that user, so its inputs never reach the panel
- When a non-GM opens the panel on a tab they cannot see, the panel falls back to the Home tab
- A player’s save writes only the user-scoped settings on the tabs they can see; world-scoped keys are skipped
- A rejected write is logged and the remaining settings in the same save still apply
Change active calendar
Section titled “Change active calendar”On the Settings Panel Home tab, the active-calendar select is enabled only when the user is a GM or holds the Change Active Calendar permission. This controls whether the user can switch the active calendar, not whether players can see it. There is no separate player-visibility toggle for the active calendar.
Hide Moons from Players
Section titled “Hide Moons from Players”The Permissions tab also carries a Player Visibility section with the Hide Moons from Players setting. When enabled, players see no moon displays anywhere: calendar day cells, Chronicle banners, the HUD dome, the Sun Dial, and moon icons in formatted dates. GMs always see moons. This is a world setting, not a role permission.