guide
You built a settlement worth showing off — now let’s turn it into a mod anyone can drop into their game, even Xbox players. It takes about five minutes, it’s mostly clicking, and you never have to touch the Creation Kit.
There are two tools here. The City Plan Mod Creator turns your build into a Sim Settlements 2 city plan that settlers construct over time, and the WSFW Layout Mod Creator turns it into a Workshop Framework layout you can drop straight into a settlement. Pick whichever you’re making — the steps are nearly identical.
What you'll need
Two things, and you probably already have both:
- Workshop Framework — it does the exporting in-game, and it’s already required for Sim Settlements 2, so you’re set.
- A settlement export — a
.logfile. If you haven’t made one yet, it’s quick:
- Load the save with the settlement you want, and head there.
- Walk up to the settlement’s workbench and choose Manage.
- Pick Settlement Layout, then Export Layout, and confirm.
- When it finishes, it’ll tell you the filename. You’ll find it in
Documents\My Games\Fallout4\Logs\Script\User— that’s the file you upload here.
Heads up
Making a City Plan
- Head to the City Plan Mod Creator.
- Give your plan a name, your designer credit, and a short description — this is what players see when they pick it in-game, so it’s worth a sentence. (All optional, but the name makes life easier when you’re building a pack.)
- Drop your WSFW export onto the upload box. That’s the only piece that’s actually required — the moment it’s in, the status bar at the bottom reads Ready to build.
Tip
- Hit Create Mod. A few seconds later your plugin downloads straight to your PC as an
.esp. That’s it — you made a mod!
Can't click Create Mod?
Making a Leveled City Plan
Most city plans are leveled — the settlement starts small and grows as the game goes on, so coming back to it later actually feels different. A leveled plan is really just several exports stacked together, one per stage — and the easiest way to make them is to build your finished design first, then strip it back down.
- In-game, build the settlement the way you want it to look at its finished, highest level, and export it — the same Manage → Settlement Layout → Export Layout as above. That’s your top level.
- Now scrap and put away whatever shouldn’t be there yet at the stage below, so the settlement looks like its earlier self, and export again. Keep peeling it back one stage at a time down to the foundation — each stage is its own
.log. - Head to the City Plan Mod Creator and fill in the name, designer, and description like usual.
- Turn on This is a multi-level plan — the single upload box becomes four slots, Level 0 through Level 3.
- Drop each export into its slot, top down: your finished design goes in Level 3 (that’s the required one), the next-most-stripped-back stage in Level 2, and so on. (Doing fewer levels? Leave the lower slots empty.)
- Hit Create Mod and grab your plugin, exactly like the single-level version.
Save each stage as you go
save MySanctuaryBuild_Level3, swapping in whatever name you like.How many levels do I need?
Prefer to build forward?
Advanced City Plan options
The City Plan tool tucks a few extra toggles under Advanced options — most people never touch them, but here’s what they do:
- Player select only — keeps this plan out of the automatic pick list, so a settlement will never choose it on its own. Players have to pick it by hand from the City Planner’s Desk — handy for niche or oddly-specific designs you don’t want settlers grabbing at random.
- Outpost plan — marks the plan as meant for an Outpost (the war-mechanics settlements from Chapter 3) rather than a normal settlement.
- Extra layouts — for when you want to hand-craft conditional layers in the Creation Kit. It preps your layouts so you can open them up and put your own requirements on extra pieces — quest completion, player level, whatever you dream up — so those bits only build once the player meets them. It’s how the Rise of the Commonwealth city plan pulls off Longfellow’s Cabin’s museum: a series of tiny layouts gated behind certain quests.
Making a WSFW Layout
The WSFW Layout Mod Creator works the same way, just simpler — one export per layout, no leveling:
- Name the layout, add your designer credit and a description.
- Drop in the WSFW export.
- Hit Create Mod and grab your plugin.
Installing what you made
Your download is an ordinary Fallout 4 plugin — install it however you install any mod:
- Add it with your mod manager, or drop it straight into your
Fallout 4\Datafolder and enable it on the Mods/Creations screen. - Make sure it loads after Sim Settlements 2 and Workshop Framework.
- Load in — a city plan shows up at the City Planner’s Desk when you go to select one, and a layout is ready to drop in through Workshop Framework’s import.
City Plan or Layout Not Showing Up?
Setup mod details (optional)
You can skip this entirely — a blank form makes a perfectly good plugin with sensible defaults. Open Setup mod details only if you want to set your own:
- File name — what the download is called (skip the extension; we add
.esp/.eslfor you). - Mod name, author, version — stored in the plugin’s header.
- EditorID prefix — stuck on the front of every record so your forms don’t collide with anyone else’s if you ever open the plugin in the Creation Kit. No effect in-game.
- Light plugin (ESL) — saves a slot in the load order. A great default for something small like this.
ESP or ESL — which should I use?
Scrap data
Scrap data is how a plan knows which vanilla objects to clear away and which player-scrapped ones to put back when it builds. For every vanilla and DLC settlement we’ve already got this on our server, so most of the time you don’t touch it at all.
The exception is a third-party settlement — one added by another mod. There’s nothing on file for those, so you’ll want to make your own scrap data. It only takes two extra exports:
- Go to the settlement in its original, untouched state — nothing you’ve scrapped or added — and export it. That’s your Untouched copy: the baseline of what’s normally there.
- Now scrap everything you can in that settlement and export again — that’s your Fully-scrapped copy. It sharpens the scrapping and keeps a few invisible objects from getting caught up in it.
- Build and export your actual design like normal.
- In the tool, open a plan’s Advanced options → Scrap data and drop those two exports into the Untouched settlement and Fully scrapped settlement fields.
Turning scrap off, or doing a partial layout?
Requiring a scrap mod like Scrap Everything?
For advanced authors
Two more toggles most people will never need — reach for these only if you already know you want them:
- For merge — builds a stripped-down file with just the layout records and none of the registration glue that connects it to Sim Settlements 2, ready to hand-merge into an existing plugin. Only reach for it if you know you’re merging; a file built this way won’t work on its own.
- Script name override — on both tools, under a plan’s Advanced options. Leave it blank for the standard City Plan / Settlement Layout script. If you’ve extended that script in the Creation Kit to add your own behavior, put your script’s name here so the tool applies its properties to yours — include your namespaces, no file extension (e.g.
SimSettlementsV2:Weapons:CityPlan).
A few good-to-knows
- Editing a plan you already shared? Regenerate it here rather than hand-editing the plugin — and if it’s a multi-plan pack, rebuild the plans in the same order. The tool hands out record IDs in order, and if those shift, players who already have your pack can run into save problems.
- Sharing your plugin? Upload it wherever you like — Nexus Mods for PC players, or Bethesda.net so Xbox players can grab it too.
- Big batches are fine, within limits — up to 25 plans and 250 files per go, and about 32 MB per file, 160 MB total. If a giant one gets turned away, split it into a couple of smaller plugins and you’re good.
Found a bug? Got an idea?
These tools are brand new, so if a plugin comes out wrong or you think of something that’d make them better, we’d genuinely like to hear it. Post it on GitHub so it doesn’t get lost:
Report an issue on GitHub →