Permissions
A role-based permission system controls what actions each user role can perform.
Overview
Section titled “Overview”You configure which features are available to three roles:
- Players. Standard player role
- Trusted Players. Trusted player role
- Assistant GMs. Assistant GM role
GMs always have full access to all features.
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 Stopwatch.
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 from the gear icon on any Calendaria application
- 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 Stopwatch | viewStopwatch | Can see the Stopwatch |
Action permissions
Section titled “Action permissions”| Permission | Key | Description |
|---|---|---|
| Add Notes | addNotes | Can create own calendar notes |
| Delete Notes | deleteNotes | Can delete own calendar notes |
| 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:
| Permission | Player | Trusted | Assistant GM |
|---|---|---|---|
| View BigCal | - | ✓ | ✓ |
| View MiniCal | - | ✓ | ✓ |
| View Note Viewer | ✓ | ✓ | ✓ |
| View HUD | ✓ | ✓ | ✓ |
| View Time Keeper | - | ✓ | ✓ |
| View Sun Dial | - | ✓ | ✓ |
| View Chronicle | - | ✓ | ✓ |
| View Stopwatch | - | ✓ | ✓ |
| 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 control buttons are hidden without Change Date/Time permission
- The weather picker is disabled without Change Weather permission
- Note creation buttons are hidden 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 hidden without Edit Calendars permission
- Action enrichers such as
advancetotimeandsetweatherare gated by Change Date/Time and Change Weather; a non-GM click relays to a GM
For Developers
Section titled “For Developers”See API Reference and Hooks.
Permission inheritance
Section titled “Permission inheritance”The permission checkboxes cascade upward:
- Cascade up. Checking a lower role also checks the higher roles
- Independent unchecking. Unchecking a 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
- A user can delete only their own notes as the original author; a GM can delete any note
- If the user lacks Foundry’s core
JOURNAL_CREATEpermission, note creation relays to a connected GM over socket
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 only available to GMs. Players cannot change who has access to a note, even their own notes.
View weather forecast
Section titled “View weather forecast”- Gates the
getWeatherForecast()API method - Gates the
/forecastchat command - 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
- A GM always has access regardless of this permission
Settings tab access
Section titled “Settings tab access”- The Stopwatch and Sun Dial settings tabs expose their user-scope settings to non-GM users for personal customization
- World-scope settings on those tabs stay GM-only
- Settings Panel tabs for BigCal, HUD, Chronicle, Stopwatch, and Sun Dial are hidden from a user who lacks the matching view permission
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.