Lock The Sheets! for Foundry VTT
 |
|
 |
Oh Game Master, thou shalt be the gatekeeper! Lock and unlock all your players' character sheets at once with just one click. May you never ever again watch them accidentally delete that beloved item from their inventory ("Uuuugh... NOOOOO!")... or let those nasty cheaters among them mess around secretly with their hitpoints ("AAAAArrrrgh!"). |
- Are you on Forge VTT?
- Do you like my work?
- Do you REALLY like my work?
- Could you even imagine to DONATE?
Feel free to head over to this mod on Forge, where you can even pay for it what you like.
This is absolutely optional! Don't feel obliged in any way to do so. My mod is and will remain available for free.
- What it does ...
- Why I created this ...
- Changelog
- Adjustable module settings
- Toggle by hotkey
- Control it by macro
- Compatibility and Dependencies
- Copyrights and Credits for used assets
Table of contents generated with markdown-toc
What it does ...
With this nice little helper module the Game Master can block and unblock any edits to character sheets by the players. This helps, for instance, to protect them from accidental changes. And of course, if you're of the paranoid type, it prevents cheating.
Toggling on/off works in various ways:
- By a checkbox in the module settings
- Through a nice UI Button in the scene control on the left (optional, turn it off in the settings, if you don't like it)
- By macro code (see below - a ready-to-use macro is already included).
In default settings, lock status is indicated by overlay icons, both in the scene and in the sidebar's actors list:
These icons can be configured and also switched off in the module settings!
Lock ON:
Lock OFF:
And it is even indicated in the Combat Tracker (thus reminding you that it should always bee green there, naturally):
Let's see what happens if players try to manipulate their hitpoints:
But apart from cheating prevention, let's see what happens if a player accidentally happens to delete an inventory item:
Even more, the GM receives alerts about it (optional, can be turned off):
Why I created this ...
No, I did not create this out of paranoia towards my players! IMO, role-playing is and has always been (since the Pen & Paper era) based on trust!
So it is not about cheating prevention (though it may serve for it as well!).
Instead, I am usually running hybrid, in-person game sessions with children of age 10+, who are permanently at risk of messing around with their character sheets. I just wanted to protect them against arbitrary havok clicks.
Even more, it turned out that locking character sheets from time to time can bring even much more focus and relaxedness into the more narrative parts of role-playing (which I love more than combat action). So the regular calls to order, like ...
"Everybody now, get your hands off your sheets, stop clicking, lean back, listen and watch!"
... are now replaced by a single, convenient button click. How I love it!
Changelog
See CHANGELOG.md
Adjustable module settings
This screenshot shows the default values.
Toggle by hotkey
You (gamemasters only) can assign a custom hotkey in the game settings (by default it is empty to prevent unwanted key collisions). My personal preference is SHIFT + L:
Control it by macro
A ready-to-use macro button for doing the toggle is already included as a compendium pack:
Use it as it is, or have a look inside how it works - it uses the exposed class LockTheSheets - it's a no-brainer:
// Toggle (pretty obvious)
LockTheSheets.toggle();
// ON and OFF-only
LockTheSheets.switchOn();
LockTheSheets.switchOff();Compatibility and Dependencies
- Lock The Sheets! uses socketlib for sending sync messages between the GM's session and the clients.
- Heavily factory tested it myself with dnd5e and tde5. I cannot guarantee compatibility with other systems. But I consider it system-agnostic for now.
- Mild warning: While sheets are locked, some intended changes may (in rare situations) be suppressed, such as macro or chat triggered actions. I put much effort into testing and I assume it's a rare case. Rest assured: There will be a screen message whenever that happens. In such cases, just unlock the sheets and repeat the blocked action. If this doesn't help, please report it as an issue on guithub.
Copyrights and Credits for used assets
Goblins
The cute, beloved badass goblins used in my screenshots have thankfully been published by David Wilson and Hammertheshark for free use on https://tools.2minutetabletop.com under the CC BY 4.0 License. I have grown so fond of them that they've become my special module demo'ing pets.
Banner
The banner image with the dark fantasy portal was AI-created by myself.
Lock icons
The red lock symbol was published by UIHuBoro on wikipedia for free use under the CC BY-SA 4.0 License. I have slightly edited it for my needs, as it is granted by that license- The green lock symbol was created by myself by editing the red icon
- The blue/violet UI/macro button image is actually the unmodified user-lock icon from fontawesome.com. There it is published under the Font Awesome Free License, which in turn is (basically) a CC BY 4.0 License