Workshop Framework

A framework for opening settlement systems for community editing.

Previous version introduction:

Chinese patch:

Author's words:

Summary: The Workshop Framework attempts to open up the settlement system in a way that many modders can contribute (not just programmers! There's plenty even the greenest modder can take advantage of). It brings immediate benefits to players, as detailed in the Player-Focused Features list below.

If you use an unofficial patch - make sure Workshop Framework comes after it in the load order.

Next generation update information:

Since 2.4.0, the workshop framework has supported next-generation updates for Fallout 4. Players who choose to continue playing a previous-gen version of Fallout 4 should still update, but also download "old-gen replacement" files and overwrite the base mod files with these. This ensures that you can use the latest fixes for WSFW while retaining support for dll/pex files from older versions of F4SE.

Player-focused features

Faster and more stable workshop scripts

Settlement import and export system

Automatically open and close doors in workshop mode

Automatic workspace menu protection

Fixed Pipboy data screen issue

Fixed "Wonder Island" issue

No DLC requirements

Added options via MCM/Holotapes

Automatic distribution control

Adjusted the maximum amount of food and defense a settler can make

Adjust base robot happiness (can cancel the penalty if you wish)

Let bots not count towards the maximum population

And more!

Mod author-focused features:

Rewrite the workshop script – faster and more open

Fully backwards compatible* - no changes to property names or function signatures

Any workshop value can be adjusted at any time - no more hard-coded variables

Provide a simple API for advanced functionality for those with little coding skills (e.g. dynamic placement of workbench items like in Sims Settlement with just a few lines of code).

50+ new workbench values ​​that you can apply to workbench items to create more interesting new bonuses for players

Add your own workshop values ​​for production and consumption with just one line of code

High-capacity, easily expandable thread system

Added container system to route production to more than just shop floor containers

Uninstalled safety injection to change workshop production, settler pools, and more

Automatic workbench menu protection means no more unloading chemicals to do workshop mods.

The settlement layout import/export system is extensible and code-driven, enabling powerful automated settlement construction.

The UIManager system provides simple access to complex interface interactions, such as using the barter menu to select player options.

Provides easy-to-use scripts for complex shop floor items such as display racks, cluttered surfaces, and supplier inventory displays.

The HUDFramework abstraction layer takes care of automatic detection, rate limiting, and communication, so you can include HUDFramework calls in your code without worrying about whether the player has HUDFramework installed.

Includes new easy-to-use progress meter system!

Completely open source and community driven

• Any mod that modifies the workshop script will break this functionality and will likely be incompatible. The exception is unofficial patches, which should be placed first in the load order so that additional script modifications made by the Workshop Framework will overwrite the UFO4P version.

New for 2020 – Settlement Layout System

Overall goals:

The goal of the workshop framework is to open up the settlement system so we can do more interesting things.

Adjusting most behavior of a settlement requires adjusting the workshop script - once you do this, you become incompatible with all other mods that want to edit the same script. Since settlements are controlled with just a few scripts - a lot of stuff that you might think is simple, basically never gets made into a mod because people don't want to deal with the hassle of modifying vanilla …