Permissions
Role-based permission system controlling what actions different user roles can perform.
Overview
Section titled “Overview”GMs configure which features are available to:
- 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; users see nothing in its place. Applies to all 7 widgets: BigCal, MiniCal, HUD, Time Keeper, Sun Dial, Chronicle, and Stopwatch.
When a GM uses Show to All, Calendaria checks whether any active players are blocked by view permissions. If so, the GM gets a notification listing blocked users by name. Permitted users see the widget; blocked users are unaffected.
Configuring Permissions
Section titled “Configuring Permissions”- Open the Settings Panel (gear icon on any Calendaria application)
- Navigate to the Permissions tab (GM only)
- Configure permissions for each role (Player, Trusted, Assistant GM) using 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 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 |
|---|---|---|
| Manage 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 Calendar | changeActiveCalendar | Can switch the active calendar |
| Edit Calendars | editCalendars | Can access the Calendar Editor |
Default Permissions
Section titled “Default Permissions”By default, all non-GM roles have restricted access:
| Permission | Player | Trusted | Assistant GM |
|---|---|---|---|
| View BigCal | - | ✓ | ✓ |
| View MiniCal | - | ✓ | ✓ |
| View HUD | ✓ | ✓ | ✓ |
| View Time Keeper | - | ✓ | ✓ |
| View Sun Dial | - | ✓ | ✓ |
| View Chronicle | - | ✓ | ✓ |
| View Stopwatch | - | ✓ | ✓ |
| Manage Notes | ✓ | ✓ | ✓ |
| Delete Notes | - | - | ✓ |
| Change Date/Time | - | - | ✓ |
| Change Weather | - | - | ✓ |
| View Weather Forecast | - | ✓ | ✓ |
| Change Calendar | - | - | - |
| Edit Calendars | - | - | - |
How Permissions Work
Section titled “How Permissions Work”UI Controls
Section titled “UI Controls”Without permission for an action, UI controls are hidden or disabled:
- Time control buttons hidden without Change Date/Time permission
- Weather picker disabled without Change Weather permission
- Note creation buttons hidden without Manage Notes permission
- Calendar button visibility gated by
canViewBigCalorcanViewMiniCalbased on Calendar Button setting - Calendar Editor button hidden without Edit Calendars permission
- Action enrichers (
advancetotime,setweather, etc.) gated by Change Date/Time and Change Weather; non-GM clicks relay to a GM
For Developers
Section titled “For Developers”See API Reference and Hooks.
Permission Inheritance
Section titled “Permission Inheritance”Permission UI has cascade-up behavior:
- Cascade Up: Checking a lower role (e.g., Player) automatically checks higher roles (Trusted, Assistant GM)
- Independent Unchecking: Unchecking a role does not affect other roles; each can be unchecked individually
Notes on Specific Permissions
Section titled “Notes on Specific Permissions”Manage Notes
Section titled “Manage Notes”- Users view non-GM-only notes they have at least OBSERVER permission on (respects Foundry journal permissions)
- Grants note creation
- Users can only delete their own notes (original author); GMs can delete any note
- If the user lacks Foundry’s core
JOURNAL_CREATEpermission, note creation is relayed to a connected GM via socket
Note Editing
Section titled “Note Editing”Note editing is gated exclusively 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 access to the
getWeatherForecast()API method - Gates the
/forecastchat command - Controls visibility of forecast weather icons on calendar day cells
- Controls visibility of intraday period breakdown in weather tooltips and forecast data. Without this permission, players see only the daily aggregate weather, not per-period details.
- GMs always have access regardless of this setting
Settings Tab Access
Section titled “Settings Tab Access”- Stopwatch and Sun Dial settings tabs expose user-scope settings (fade, opacity, combat behavior) to non-GM users for personal customization
- World-scope settings on these tabs remain GM-only
- Settings panel tabs for BigCal, HUD, Chronicle, Stopwatch, and Sun Dial are hidden from users who lack the corresponding view permission
Change Calendar
Section titled “Change Calendar”Player visibility of the active calendar is controlled separately via “Show Active Calendar to Players” in Settings > Home tab.