Modding guide

Overview

How to create graphical mods, add new products and objects, and more.

Basics

Here are instructions on how to create and publish your own mods for the game.
Mods can provide graphical modifications, alternate gameplay conditions and additional content (such as new products and objects).

First things first, you should get yourself familiar with this folder (copy/paste this path to the Windows search bar or the file explorer):

Tip: create a shortcut to this directory on your desktop for easy access.

In

create a new folder and give it a unique name for your mod (use latin characters to avoid compatibility issues).

In this new folder, create a new text file (right-click in the folder in explorer and select New > Text Document) and rename it to moddata.xml (remove the .txt extension, the full filename should be moddata.xml).

Tip: Although you can use Notepad to edit moddata.xml, you might want to use a proper XML editor such as Microsoft XML Notepad[www.microsoft.com].

Copy/paste the following code in your moddata.xml file:

You should replace the content in <nodes></nodes> with your own.

Please note that when a node has <english></english>, it means that it is localizable.
Use the API language codes referenced there to add translations as desired.
For example, to add a french translation to your mod’s name:

Next you need an image to showcase your mod in-game and on the workshop (aka the capsule).
Create a 1024×576 PNG image and save it as capsule.png in your mod’s folder.
You can save the image below to serve as a temporary capsule (right-click > Save image as…).

At this point, although your mod does nothing yet, you can test it in-game to verify that it is detected and appears properly.
Go to the New game menu and to the Manage mods menu.

If your mod is not there or has errors, you might want to check the console.log file for possible errors, and double check the instructions above.

Tip: if you enable the debug overlay (F1) on the Manage mods menu, the folder names of mods will appear, which might come in handy later.

Graphical mods

Graphical mods can ‘patch’ existing art (sprites, tiles and UI) with custom art.

The game’s textures are usually located in

If you installed the game elsewhere, you can access the game’s local files from your Steam library: right-click on the game in your library > select Properties > select the ‘Local files’ tab > press ‘Browse local files’.

There are 3 textures there you can patch:

sprites01.png (a 4096×4096 PNG which contains most of the sprites in the game).

Tip: Yes, the bottom half of sprites01.png is empty, it is reserved for content mods. In this section we only want to replace ‘vanilla’ art.

tiles01.png (a 2048×2048 PNG which contains the tiles, walls and roadwork art for the game).

gui.png (a 2048×1024 PNG which contains the user interface art for the game).

Your patch will be a png image file (give it a relevant name) that will replace art at specified coordinates in a given texture. Of course, it should be located in your mod’s folder.

The <GfxPatch> node structure in the XML looks like this:

In this example, the mypatch.png image will be pasted onto the sprites01.png texture at coordinates (0,1280).

Add as many <GfxPatch> nodes as you need within the <ModData> node, and don’t forget to add the corresponding png files.

Now for a practical exercise, let’s say we want everyone in the game to sport a clown nose (because why not?).

First, locate the noses in sprites01.png and write down their coordinates and the size of the space they occupy.

So the noses occupy a 512×64 space located at coordinates (512,1472).
Select the (512×64) area, crop the image and replace the noses with clown noses.
You should now have a png image that looks like this:

Save it as clown_noses.png in your mod’s folder.

Now your moddata.xml should look something like this:

Let’s try it out:

A game changer, surely 😛

Please note: empty (transparent) space in your patch image will replace existing art. You can use this to remove cosmetic features.

For example, to remove noses from characters, create a fully transparent 512×64 PNG, rename it to blank_512x64.png and create the following <GfxPatch> node::

There you go: characters without noses!
If you want to remove eyes, change the offset coordinates to (0,1472). For mouthes (0,1536).

Floor tiles mods

In addition to modifying existing floor tiles as described in the Graphical mods section, you can add extra floor tiles to the game.

Each added floor tile type needs a 512×64 png image with 8 64×64 tile variants (It can be the same tile depending on the style, the game will randomly use one of the variant for each cell the tile is applied to).

The <FloorTile> node is simple:

Simply reference your image in <tiles_gfx>.

You can add as many <FloorTile> nodes you want in a single mod (<ModData>), but please note there is a limit of 108 extra floor tiles per game (any extra tile will be ignored).

You might want to subscribe to this mod for reference:

Product mods

Ever felt that a specific product was missing from the game? Product mods let you add custom products to game’s economy.

Modded products require a <Product> node with a name and specifications for the product and up to 3 images for on-shelf representation.

Let’s take a look at the <Product> node:

<codename> is a unique non-localizable codename for the product. Use latin characters. Do not change after the first publication to the workshop!

<name> is the localizable name of the product.

<specialty_name> is the localizable name of the product’s specialty store.
This is optional and only used if the <quality_distribution> of the product is 3 or more (Tier 3 demand).

<subtype> is the sub-category of the product.
Accepted values are:

• 2 – Food
• 3 – Beverages
• 4 – Household Items
• 5 – Health and Beauty
• 6 – Tools and Materials
• 7 – Electronics and Appliances
• 8 – Clothing
• 9 – Media
• 10 – Press and Print
• 11 – Plants and Gardening
• 12 – Misc
• 13 – Sports and Outdoors
• 14 – Toys and Games

<display_type> is the type of shelf/display that is used for the product.
Accepted values are:

• 1 – Food shelf
• 2 – Fridge only
• 3 – Fridge or food shelf (suitable for drinks)
• 4 – Table
• 5 – Cloth rack
• 6 – Pallet
• 7 – Non-food shelf

<depletion_rate> is the percentage of stock that is depleted from the shelf when a customer buys an item.
Accepted values are: 1 – 100

<base_demand> is the base demand. This value is relative to the demand of all the other products.
Accepted values are: 0 – 200

<base_price> is the base value (determines cost/ sell price) of the product.
Accepted values are: 1 – 200

<quality_distribution> is the distributed demand for your product between tiers of quality/rarity. It determines if there is demand for a sub-category specialized store, or a product specialized store, or none of these.
Accepted values are (with demand for Tier 1/Tier 2/Tier 3):

• 0 – no specialization (100/0/0)
• 1 – standard (75/25/0)
• 2 – high sub-category (50/50/0)
• 3 – specialty (30/30/40)
• 4 – high specialty (10/30/70)
• 5 – no middle (30/0/70) – typically for products in the ‘Misc’ sub-category
• 6 – only specialty (0/0/100)

<expires_in_hours> is the expiration time in hours before an item becomes obsolete/expired.
Accepted values are: 1 – 240000

<requires_research> is used to tie a product to a research project.
Accepted values are:

• 1 – Cold chain
• 2 – Alcohol license
• 4 – Frozen food supplier
• 5 – Chemical supplier
• 6 – Clothing supplier
• 7 – Electronics supplier
• 8 – Media supplier
• 9 – Appliances supplier
• 10 – Tools supplier
• 11 – Luxury supplier
• 30 – Tobacco license
• 31 – Newsagent supplier
• 32 – Plants and Gardening supplier
• 33 – E-Cigarettes supplier

<horizontal_gfx> references a 128×128 png with full and half-full representation for the product on horizontally oriented shelves/displays.

<vertical_gfx> references a 128×128 png with full and half-full representation for the product on vertically oriented shelves/displays. (Please note: pallet products do not have a vertical orientation).

<checkout_gfx> references a 32×32 png with a single item to be displayed on the checkout counter.

You should subscribe to this mod:

[link]
Once steam has downloaded the mod and you run the game once, the demo mod data will appear in:

It includes demo products for each display type and Photoshop templates to help overlaying your images correctly.

Patch vanilla products

<PatchVanillaProduct> let’s you patch vanilla products with custom settings, or remove them from the game’s economy. This should come handy for mods or scenarios that aim to completely or partially replace the vanilla products with custom products.

<DisableVanillaProduct> has been deprecated, please use <PatchVanillaProduct> and <disable> instead.

Let’s take a look at the <PatchVanillaProduct> node.
The code below patches Jackets with custom settings:

The code below disables Shirts entirely:

<product_name> references a vanilla product with the localizable xml name ProductName_*.
Here is the list of all current vanilla products (0.27.*):

• ProductName_FastFood
• ProductName_Bar
• ProductName_FineDining
• ProductName_Bowling
• ProductName_Movies
• ProductName_CoffeeShop
• ProductName_ArcadeGames
• ProductName_Liquor
• ProductName_Soda
• ProductName_Candies
• ProductName_BottledWater
• ProductName_Beer
• ProductName_Wine
• ProductName_CannedFood
• ProductName_BreakfastCereal
• ProductName_Snacks
• ProductName_IceCream
• ProductName_Milk
• ProductName_Cookies
• ProductName_Dairy
• ProductName_FreshMeat
• ProductName_SlicedBread
• ProductName_SaucesandSeasoning
• ProductName_RiceandPasta
• ProductName_FrozenVegetables
• ProductName_FrozenPizzas
• ProductName_FreshFish
• ProductName_CoffeeandTea
• ProductName_PetFood
• ProductName_Detergents
• ProductName_SoapandShampoo
• ProductName_Cosmetics
• ProductName_ToothCare
• ProductName_Deodorants
• ProductName_ShavingCreamandRazors
• ProductName_Diapers
• ProductName_ToiletPaper
• ProductName_LightBulbsandElectricity
• ProductName_CarTools
• ProductName_HandTools
• ProductName_PowerTools
• ProductName_Toys
• ProductName_Books
• ProductName_DVDsandBluRays
• ProductName_MusicCDs
• ProductName_VideoGames
• ProductName_BedSheets
• ProductName_FirstAid
• ProductName_Drugs
• ProductName_MenShoes
• ProductName_WomenShoes
• ProductName_FreshFruits
• ProductName_FreshVegetables
• ProductName_FreshBread
• ProductName_Jewelry
• ProductName_LaptopComputers
• ProductName_GameConsoles
• ProductName_Smartphones
• ProductName_Tablets
• ProductName_MP3Players
• ProductName_Cameras
• ProductName_TVSets
• ProductName_T-Shirts
• ProductName_Pants
• ProductName_Dresses
• ProductName_Shirts
• ProductName_Jackets
• ProductName_Coats
• ProductName_Cookware
• ProductName_Dishes
• ProductName_PadsandTampons
• ProductName_Juices
• ProductName_MenUnderwear
• ProductName_WomenLingerie
• ProductName_WashingMachine
• ProductName_DishWasher
• ProductName_DryingMachine
• ProductName_Fridge
• ProductName_GreetingCards
• ProductName_Newspapers
• ProductName_Magazines
• ProductName_ComicBooks
• ProductName_SchoolSupplies
• ProductName_Tobacco
• ProductName_ECigs
• ProductName_GardeningTools
• ProductName_SoilFertilizer
• ProductName_Plants
• ProductName_Flowers
• ProductName_Backpacks
• ProductName_SportsBalls
• ProductName_BoardGames
• ProductName_ActionFigures
• ProductName_Fitness

All the other parameters are optional:

<disable> set to 1 to remove the product. (Non-retail businesses will still be buildable but will have zero demand).

<base_demand> is the base demand. This value is relative to the demand of all the other products.
Accepted values are: 0 – 200

<base_price> is the base value (determines cost/ sell price) of the product.
Accepted values are: 1 – 200

<depletion_rate> is the percentage of stock that is depleted from the shelf when a customer buys an item.
Accepted values are: 1 – 100

<quality_distribution> is the distributed demand for your product between tiers of quality/rarity. It determines if there is demand for a sub-category specialized store, or a product specialized store, or none of these.
Accepted values are (with demand for Tier 1/Tier 2/Tier 3):

• 0 – no specialization (100/0/0)
• 1 – standard (75/25/0)
• 2 – high sub-category (50/50/0)
• 3 – specialty (30/30/40)
• 4 – high specialty (10/30/70)
• 5 – no middle (30/0/70) – typically for products in the ‘Misc’ sub-category
• 6 – only specialty (0/0/100)

<expires_in_hours> is the expiration time in hours before an item becomes obsolete/expired.
Accepted values are: 1 – 240000

Object mods

You can now add custom objects to the game.
Modded objects can replicate the functionality of any buildable vanilla object (checkout counters, shelves, vending machines, restaurant tables, etc…).

Let’s take a look at the <Object> node.
In the following example we’re adding a sculpture that replicates the function, collisions and dimensions of the vanilla ‘Sculpture Type C’ object.

<codename> is a unique non-localizable codename for the object. Use latin characters. Do not change after the first publication to the workshop!

<name> is the localizable name of the object.

<ref_object> is the vanilla object reference for your modded object. The modded object will have the same functionality and collision box. The object image must have the same dimensions as the reference object (including variations, eg: the toilet cubicle has both a door-open and door-closed statuses), but you are free to fill that space as you wish (try to respect the reference object’s collision box).
Accepted values are:

• 0 – Door
• 1 – Double Door
• 2 – Staff Door
• 3 – Food Shelf
• 4 – Fridge
• 5 – Table
• 6 – Checkout Counter
• 7 – Vending Machine
• 8 – Arcade Cabinet
• 9 – Toilet Cubicle
• 10 – Toilet Sink
• 11 – Toilet Urinal
• 13 – Order Counter
• 14 – Fast Food Soda Dispenser
• 15 – Fast Food Warmer
• 16 – Fast Food Cooking Range
• 17 – Movie Projector
• 18 – Spectator Seat
• 19 – Bowling Lane
• 20 – Diner Table
• 21 – Food Court Table
• 22 – Restaurant Table
• 23 – Trash Can
• 24 – Plant Type A
• 25 – Plant Type B
• 26 – Water Dispenser
• 27 – Pinball Machine
• 28 – Fountain
• 29 – ATM
• 30 – Cloth Rack
• 31 – Shelf
• 32 – Pallet
• 33 – Office Desk
• 40 – Bench
• 41 – Fine Dining Cooking Range
• 42 – Kitchen Pass
• 43 – Cafe Table
• 44 – Bar Counter
• 45 – Bar Counter with Stools
• 46 – Bar Shelf
• 47 – Anti-theft Detector
• 48 – Sculpture Type A
• 49 – Sculpture Type B
• 50 – Sculpture Type C
• 51 – Lounge Sofa
• 52 – Lounge Table
• 53 – Plants Type C
• 54 – Plants Type D
• 55 – One-way Swing Gate
• 56 – Self-checkout
• 57 – Coffee Shop Counter
• 58 – Outdoor Light
• 59 – Weight Bench
• 60 – Treadmill

<default_gfx> is the png image for your object’s default orientation.

<vertical_gfx> is the png image for your object’s vertical orientation. Required if the reference object only has a vertical alternate orientation (shelves, benches,…).

<right_gfx> is the png image for your object’s right orientation. Required if the reference object has all 4 orientations.
<down_gfx> is the png image for your object’s down orientation. Required if the reference object has all 4 orientations.
<left_gfx> is the png image for your object’s left orientation. Required if the reference object has all 4 orientations.

<misc_parameter> is a miscellaneous and optional parameter that alters an object’s function or display depending on the reference object.
The current functions are:

• Checkout Counter (6): set to 1 if your checkout counter doesn’t have a conveyor belt.

For reference, you can subscribe to this mod:

Once steam has downloaded the mod and you run the game once, the demo mod data will appear in:

Business skins

You can now create ‘skins’ for non-retail businesses.
The skin will be selectable from the ‘Manage Zone’ menu.

Let’s take a look at the <BusinessSkin> node.
In the following example we’re adding a ‘Mexican Food’ skin for the Fast Food Restaurant. The skin references custom objects (defined earlier in the xml or elsewhere) for the food warmer, soda dispenser and cooking range.

<codename> is a unique non-localizable codename for the skin. Use latin characters. Do not change after the first publication to the workshop!

<name> is the localizable name of the skin.

<zonetype> is the id of the business type we’re adding a skin to.
Accepted values are:

• 2 – Fast Food Restaurant
• 9 – Fine Dining Restaurant

<foodwarmer_id> is the codename for the custom object to replace the default food warmer (optional, used for fast food restaurants).
<cookingrange_id> is the codename for the custom object to replace the default cooking range (optional, used for fast food restaurants and fine dining restaurants).
<sodadispenser_id> is the codename for the custom object to replace the default soda dispenser (optional, used for fast food restaurants).
<kitchenpass_id> is the codename for the custom object to replace the default kitchen pass (optional, used for fine dining restaurants).

<misc_gfx> is a png image for the meal/product sold in your business skin (see reference mods below for proper layout and dimensions).

Fast Food reference:
[link]
Fine Dining reference:
[link]

Gameplay mods

Gameplay mods let you change gameplay conditions to create custom game modes/difficulty settings.

Here is a <Gameplay> node with all the currently tweakable variables set to their default values:

You don’t have to include all the variables in your mod, you can use only one or a few, the other non-included variables will be set to the default/sandbox value.

Please note that any sandbox setting set by the player from the new game menu will be overridden by gameplay mods.

Also note that, unlike product mods settings, these values are not clamped to ensure run-time safety. Nonsensical values will most likely crash the game or create random, possibly severe, bugs. Use common sense and stress-test your mods before publishing.

<sim_speed>
The simulation speed in seconds per minute: how many real-time seconds it takes to advance one minute in-game at x1 game speed. The default value is 1.0 second per minute. Any value under 0.74 is unsupported and will create problems, use at your own risk!

<starting_money>
Sets the starting money for a new game.

<demand_mode>
0 – standard demand
1 – random demand

<prices_mode>
0 – standard prices
1 – random prices

<demand_amplitude>
How much demand changes for each product.

<demand_frequency>
How often demand changes for each product.

<staffneeds_mode>
0 – no staff needs
1 – staff hunger and bladder needs enabled

<shoplifting_mode>
0 – no shoplifting
1 – mild shoplifting
2 – serious shoplifting
3 – massive shoplifting

<rats_mode>
0 – no infestations
1 – mild infestations
2 – severe infestations

<events_mode>
0 – no random events
1 – standard random events
2 – frequent random events
3 – constant random events

<roadwork_fac>
<maintenancecost_fac>
<margins_fac>
<salary_fac>
<interest_fac>
<foundationscost_fac>
<objectscost_fac>
Factors (coefficients, multipliers) to various costs, minimum salary and base interest rate.

<storecheckout_time>
<selfcheckout_time>
<ordercounter_time>
<fastfood_eatingtime>
<finedining_eatingtime>
<coffeeshop_eatingtime>
<bar_drinkingtime>
<fastfood_cookingtime>
<finedining_cookingtime>
<toilet_time>
The in-game time taken to complete various actions.

<speed_fac>
<patience_fac>
<sociability_fac>
Factors to how efficient characteristics are.

<addskill_fac>
Factor to any increase to a worker’s experience (skill).

<satisfaction_upmod>
<satisfaction_downmod>
<hunger_upmod>
<hunger_downmod>
<bladder_upmod>
<bladder_downmod>
<nausea_upmod>
<nausea_downmod>
Factors to statuses increasing (*_upmod) or decreasing (*_downmod).

Publish to workshop

Once you’re happy with your mod, copy its folder from:

to

You will now be able to upload it to Steam from the main menu (F1 -> upload/update mod).