Lockpick Minigames

Disclaimer and credits

What it does

Normally a locked door in Foundry is a dead end until the GM unlocks it. With Lockpick Minigames a player clicks the locked door (or a locked container token, or a locked item such as a collar) while standing within reach, and a lock window opens. They play a short skill-based minigame. Win, and the GM's client unlocks or opens the door, container or item. Fail, and the attempt is recorded, a cooldown may start, their tools may break, and the lock may eventually jam.

• Seven minigames: Sweet Spot, Dual Rotation, Pin Tumbler, Skill Check, Tension, Ward Trace and the magical Arcane Lock. Each lock can pick its own game, or draw a random one.
• Fifteen difficulty tiers from Trivial to Legendary. Every game scales: narrower zones, faster movement, more pins and targets, shorter pauses, fewer allowed errors, extra hazards at high tiers.
• The character's skill matters in every game. On dnd5e the Sleight of Hand total, thieves' tools proficiency and carried tools lower the tier the player actually plays. Arcane Locks use Arcana and the spellcasting modifier instead. Other systems point the module at any actor data path.
• Keys, tools, attempts, cooldowns, jamming, success and failure macros, chat whispers, Item Piles support, an L hotkey, a playground, and live read-only spectating for the rest of the table.
• Safe by design: players never write to the scene. Results go over the module socket to the active GM client, which does the unlocking, bookkeeping and item changes.
• Every lock window shows a short "How to" text, so players learn each game at the table.

How a player uses it

1. Move your token within reach of the lock (10 ft by default).
2. Click the locked door, double-click the locked container token, press the Pick lock button on a locked item sheet, or just press L to pick the nearest lock in reach.
3. If you carry the lock's key item, it opens at once (the key can be consumed). Otherwise the minigame opens.
4. Read the How-to line, play, and watch the pick-health and progress bars.
5. The outcome is whispered to you and the GM. On success the door unlocks (or opens), the container opens, or the item is unlocked, unequipped or removed, as the GM configured.

The seven minigames

Difficulty and skill

Every lock has a difficulty tier from 1 (Trivial) to 15 (Legendary). The tier the player actually plays is the lock's tier minus a reduction earned from their character, so a master thief breezes through a tier 8 lock that would stump a paladin. The reduction applies to all seven games.

dnd5e formula (default)

points = Sleight of Hand total + thieves' tools proficiency bonus + flat amount of the best carried tool, doubled when the character is proficient in both Sleight of Hand and thieves' tools. The tier drops by floor(points / divisor) (divisor 2 by default). An unproficient character still benefits from carrying tools.

Arcane Locks use Arcana total + spellcasting ability modifier, doubled when proficient in Arcana and a spellcaster, and ignore tools.

Other systems

Switch the dnd5e formula off and give the module any actor data path, for example system.abilities.dex.mod or system.skills.slt.total. Carried tools from the tools list then lower the tier directly. Arcane Locks have their own path setting.

Tools and keys

• Tools are listed by item name with their amount, for example Thieves' Tools=2; Masterwork Picks=4. The best tool carried counts. Tools can be required to attempt a lock, and can break (be consumed) on failure with a configurable chance.
• Keys: a character carrying an item named like the lock's key (several names allowed) opens it without a minigame. The key can optionally be consumed.

GM features

An active GM client must be connected while players pick locks. Optional modules: lib-wrapper (safer wrapping of door and token click handlers next to other modules) and Item Piles (locked container piles open after a successful pick).

Settings reference

World settings

Client settings

Per-lock settings (door, token or item)

Keybinding

L — pick the nearest lock in reach (doors, container tokens, and locked items on tokens in reach). Rebindable in Configure Controls.

API

const api = game.modules.get("lockpick-minigames").api;
api.attempt(doc);     // start an attempt on a WallDocument, TokenDocument or Item
api.configure(doc);   // open the lock settings window
api.lock(doc);
api.unlock(doc);
api.resetState(doc);  // clear attempts, cooldowns and jam
api.getLock(doc);     // effective configuration
api.demo();           // playground

Lock configuration lives in flags.lockpick-minigames.lock, attempt state in flags.lockpick-minigames.state, and a token's or item's locked state in flags.lockpick-minigames.locked. Lock requests resolve documents by UUID.

Install

In Foundry's setup screen open Add-on Modules → Install Module and paste this manifest URL:

Or download module.zip from the releases page and upload it to The Forge or unzip it into Data/modules. Then enable Lockpick Minigames in the world's Manage Modules. To install a specific older version use https://github.com/teshaman/lockpick-minigames/releases/download/<version>/module.json.

Changelog

The full history is in CHANGELOG.md. Highlights:

• 1.8.0 — Puzzle Locks doors: open the puzzle, ask the player, or pick the lock.
• 1.7.x — Item locks (collars, manacles, strongboxes), opt-in spectating with a Watch prompt, the window header names the skill that lowered the tier.
• 1.6.0 — Live spectator windows, cached drawing layers and a scene frame-rate cap for smoother play.
• 1.5.0 — Arcane Lock, the seventh minigame.
• 1.4.x — Pin Tumbler pins bind in a hidden random order; tuning after play-testing.
• 1.3.0 — Tier-gated hazards in every game (settling, blinking, fakes, trap arcs, slips, breathing walls, timers).
• 1.2.0 — Harder difficulty curve, high-contrast Dual Rotation spot.
• 1.1.x — Full-circle Sweet Spot, two-phase Dual Rotation, Oblivion-style Pin Tumbler, How-to texts, dnd5e skill formula.
• 1.0.0 — First release with six games, fifteen tiers, keys, tools, attempts, cooldowns, jamming and macros.

License

Lockpick Minigames is released under the MIT License. You may use, copy, modify, merge, publish, distribute, sublicense and sell copies, provided the license notice stays with it. The software is provided "as is", without warranty of any kind.

See the disclaimer above: I claim no ownership of the code. The idea belongs to Reslin, whose Lock Picking module you can support at patreon.com/cw/Reslinfvtt.