-
-
Notifications
You must be signed in to change notification settings - Fork 13
Home
This wiki is outdated. Use this documentation for Lock View v2+.
Lock View is a module that gives the GM (or a designated player) control over the zoom and pan capabilities of users, such as locking the zoom or pan, moving the canvas, or setting the view to a specified setting.
The module was originally made as a companion app for my Material Plane module, and to make play using a digital playmat,
such as a horizontally mounted TV, easier.
Over time, however, the module's features have expanded greatly, including many functions that can be useful for digital play.
The module has 6 main functions:
- Autoscaling: Scales the scene in various ways (horizontal fit, vertical fit, automatic fit, or scaled to a physical gridsize)
- Zoom lock: Locks the zooming of the scene to prevent the user from (accidentally) messing up the autoscale
- Pan lock: Locks the panning of the scene. If you use physical minis you don't want to accidentally pan
- Bounding box: Limit zoom and pan to stay within a bounding box
- Force initial view: After loading a new scene, the view is forced to the initial view (as set in the scene configuration menu), regardless of the position of tokens
- Viewbox: Allows the GM to see what's shown on users screens, and allows the GM to control the pan and zoom of those users
'Zoom Lock', 'Pan Lock' and 'Bounding Box' can be enabled and disabled at any time using control buttons.
These functions can be applied to selected connected users (must be set in the GM's module settings).
Note: When 'Zoom Lock' or 'Pan Lock' are enabled, this module disables all zooming and/or panning functionality, regardless of who or what is requesting that zoom or pan. This means that, for example, modules that try to pan or zoom won't work.
When 'Zoom Lock' or 'Pan Lock' are enabled, this module disables all zooming and/or panning functionality, regardless of who or what is requesting that zoom or pan. This means that, for example, modules that try to pan or zoom won't work.
Right now, there appear to be compatibility issues with the following modules:
- DF Active Lights
- Zoom/Pan Options
This module has been tested to work with Foundry V9 and V10.
The last v8 compatible version is v1.5.2, manifest url: https://github.com/CDeenen/LockView/releases/download/v1.5.2/module.json
Feel free report an issue/suggestion, contact me on Discord (Cris#6864), or send me an email: cdeenen@outlook.com.
Author: Cristian Deenen (Cris#6864 on Discord)
If you enjoy using my modules, please consider supporting me on Patreon or buy me a coffee through Ko-fi.
Abandoned modules are a (potential) problem for Foundry, because users and/or other modules might rely on abandoned modules, which might break in future Foundry updates.
I consider this module abandoned if all of the below cases apply:
- This module/github page has not received any updates in at least 3 months
- I have not posted anything on "the Foundry" and "the League of Extraordinary Foundry VTT Developers" Discord servers in at least 3 months
- I have not responded to emails or PMs on Discord in at least 1 month
- I have not announced a temporary break from development, unless the announced end date of this break has been passed by at least 3 months
If the above cases apply (as judged by the "League of Extraordinary Foundry VTT Developers" admins), I give permission to the "League of Extraordinary Foundry VTT Developers" admins to assign one or more developers to take over this module, including requesting the Foundry team to reassign the module to the new developer(s).
I require the "League of Extraordinary Foundry VTT Developers" admins to send me an email 2 weeks before the reassignment takes place, to give me one last chance to prevent the reassignment.
I require to be credited for my work in all future releases.