Register

Nik's Settings Locks

An Add-on Module for Foundry Virtual Tabletop

Author: nikolai.sw Project: Source Foundry Versions 13+ (Verified 14) Last Updated 1 month, 3 weeks ago

Nik's Settings Locks

A FoundryVTT module that lets the GM soft-lock and hard-lock client settings and keybinding controls for all connected clients.

Requires libWrapper.


Compatibility


Other Modules by Nik

🎲 D&D 5e Specific

⚔️ Combat & Token Tools

⚙️ Utilities & System Management


Features

Lock Behavior

  Soft Lock Hard Lock
Applied on load Once per revision Every load
Player can override ✓ Permanently ✗ Blocked
UI indicator 🟡 Yellow lock 🔴 Red lock
Input disabled No Yes (for non-GM)
GM re-sets lock Re-applies (new revision) Always enforced
GM exempt at runtime ✓ ✓

GM Enforcement

Locks are applied to all clients (including GMs) on page load. At runtime, GMs are exempt from the enforcement wrapper — they can freely change settings or controls, remove locks, and save without being blocked.

Usage

Inline Controls (Settings Config)

  1. Open Settings → Configure Settings
  2. Lock icons appear to the left of each client/user setting name
  3. Click to cycle: Unlocked → Soft → Hard → Unlocked
  4. Right-click to cycle backward: Unlocked → Hard → Soft → Unlocked
  5. Changes are saved immediately and broadcast to all clients

Inline Controls (Configure Controls)

  1. Open Settings → Configure Controls
  2. Lock icons appear next to each keybinding action
  3. Same click/right-click cycling as settings

Lock Manager

  1. Open Settings → Module Settings → Nik's Settings Locks → Open Lock Manager
  2. Browse, filter, and manage locks for all settings and controls in one place
  3. Settings show type-appropriate input controls; keybindings show key combo badges
  4. Use the toolbar buttons for export, import, re-enforce, and bulk clear

Re-enforcing Soft Locks

Soft locks are applied only once per revision. If players have overridden a soft-locked value, clicking Re-enforce Soft Locks bumps the revision of all soft locks. Players will receive the GM's values again on their next login.

Installation

Method 1: Manifest URL

Paste the following URL into Foundry's Install Module dialog:

https://github.com/nschoenwald/niks-settings-locks/releases/latest/download/module.json
 

Method 2: Manual

Download the latest module.zip from Releases and extract it into your Data/modules/ directory.

Dependencies

Compatibility

License

MIT License — see LICENSE for details.

Categories

Available Versions

  1. Version 14.1.0

    1 month, 3 weeks ago
    Foundry Version 14+ (Verified 14) Manifest URL
  2. Version 14.0.9

    1 month, 3 weeks ago
    Foundry Version 14+ (Verified 14) Manifest URL
  3. Version 14.0.8

    2 months, 1 week ago
    Foundry Version 13+ (Verified 14) Manifest URL Read Notes
  4. Version 14.0.7

    3 months ago
    Foundry Version 14+ (Verified 14) Manifest URL Read Notes