Settlement Names Modding

Adding custom Settlement Name Lists

Adding custom Settlement Name Lists is achieved by adding a single content file to any mod. Since these lists are just content files (JSON) you can have any number of lists within a single mod as well as any other file you want.

For each list you add to a mod a new entry will appear in the Main Menu when creating a new map (for any game mode, Career, Sandbox or even Scenario creation). This new entry will appear as a possible selection in the TOWN NAMES GENERATOR world option. The asset type we are creating is of type ProjectAutomata.SettlementNameList, the docs for that type can be used as a reference when creating new lists.

Example

In this example we will create a new Settlement Name List that will add a new list with some names of Italian cities.

1. Create a new folder for your mod inside the Mods folder of the game and a desc.json for it (if you are not familiar with mods creation check out this article.)
2. Inside the content folder of your mod add a JSON file named ItalianTowns.json
3. Edit the new JSON file as follows:

{
 "type": "ProjectAutomata.SettlementNameList",
 "object": {
   "name": "ItalianTowns",
   "displayName": "Italy",
   "uiOrder": 500,
   "names": [
     "Bari",
    "Caserta",
     "Napoli",
    "Milano",
    "Palermo",
     "Torino",
     "Venezia"
   ]
 }
}

Now run the game, a new choice (Italy) will be available when choosing which TOWN NAME GENERATOR to use. Select Italy and start map generation, when the world is ready you’ll see that now Settlements have Italian names.