Register

Force Client Settings

An Add-on Module for Foundry Virtual Tabletop

Author: kimitsu Project Source: Project URL Versions 10+ (Verified 11) Last Updated 2 months, 1 week ago

Force Client Settings

Allows to force chosen settings for all clients to the defaults provided by the GM.

Overview

This module adds a lock icons next to the client settings in the settings configuration app. Clicking or Alt-clicking these icons changes the behavior of the settings:

This allows the GM to either force chosen critical settings to ensure they will not be altered, or "soft-force" other settings that the GM finds helpful to be set to new defaults, but still let the players alter them if they choose to. The GM may also set the defaults for clients, but then adjust their own settings privately by Alt-clicking the lock icons and escaping the force. The GM may also choose to either leave the forced settings visible, or hide all of them away from the clients, in order to reduce clutter, via a global setting.

The module also adds the "Force Client Settings Editor". It allows the GM to force settings that are hidden from the configuration app (usually those that are edited via modules' custom configuration windows).

Current Limitations

Compatibility and issues

Force Client Controls

Module Management+

  • Fully compatible

Tidy UI - Game Settings

Illandril's Tidy Module Settings

DF Settings Clarity

SocketSettings by Blitz

Troubleshooting

Migration to 2.0.0

There was an issue where not all settings were properly migrated from 1.0.x to 2.0.0. That was fixed in 2.0.1. If you've experienced the issue and wish to redo the migration, please enter the following into the console (F12) and refresh your browser:
game.settings.set('force-client-settings', 'versionWorld', '1.0.0')

Settings fail to be forced properly

Some settings may be loaded before Force Client Settings is initialized. These settings may not be properly forced for the clients. Force Client Settings will produce a warning in the console if such settings are attempted to be forced. If such situation happens, the following might help:

Settings not meant to be forced

Forcing certain settings may result in unpredictable behavior, proceed on your own risk. This is unlikely to cause problems for the GM, so they may unlock the problematic settings at any time, however in a tiny chance that the GM would somehow be locked-out from the settings menu, the folowing might help:

If nothing helps, please file an issue to let me know of the problem!
https://gitlab.com/kimitsu_desu/force-client-settings/-/issues

License

MIT License (c) 2021 kimitsu

Categories

Available Versions

  1. Version 2.4.1

    2 months, 1 week ago
    Foundry Version 10+ (Verified 11) Manifest URL Read Notes