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:

• "Unlocked" icons mean that the settings are free to be changed by the individual clients.
• "Half-locked (with visible keyhole)" icons mean that the settings will be defaulted to those set by the GM, however any client may optionally "unlock" these settings and adjust them if necessary.
• "Locked (with no visible keyhole)" icons mean that the settings will be forced to those set by the GM and may not be changed by clients.
• "Gate" (Alt-click the lock icon to activate) icons mean that the settings are locked or half-locked for the clients, however the GM has escaped the force and may adjust these settings privately.
• "Eye" icons mean that a submenu button is available to the clients.
• "Eye-slashed" icons mean that a sumbenu button is hidden from the non-GM clients, however the settings on the submenu are not neccessarily forced (use Force Client Settings Editor for that).

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).

Finally, if the GM wishes to restrict clients from accessing these configuration windows, they can hide their submenu buttons by clicking the "eye" icons.

Current Limitations

• The clients may be required to refresh their browser before any alterations to the forced settings made by the GM will take effect.

Compatibility and issues

Force Client Controls

• Recomended: https://gitlab.com/kimitsu_desu/force-client-controls/

Tidy UI - Game Settings

• Fully compatible

Illandril's Tidy Module Settings

• Fully compatible

DF Settings Clarity

• Issue: Lock icons will disappear when you use the settings filter.

SocketSettings by Blitz

• Compatible: Can be used to immediately apply forced settings to all connected clients.

Troubleshooting

game.settings.set('force-client-settings', 'versionWorld', '1.0.0')

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:

• Try prioritizing Force Client Settings to the top of the list in the libWrapper priority settings window.

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:

• Launch the game as the GM and open the developer's tools (F12), go to console and type:

  game.settings.set("force-client-settings", "forced", {})

  This will unlock all settings for all clients.

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