<aside> 📑 Navigation

Main page

Create mods

Installing mods

<aside> 📎 Links

Steam Workshop

Discord

Steam Discussions

</aside>

Adding images using Mod Creator

  1. To add image to the mod, press “Image” button in “Mod Content” panel.
  2. Press on the new image block to show information about the image
  3. Fill in the info about your image and select path to it. Supported image formats: .png, .jpg, .bmp

image.png

Adding images manually (Advanced)

You can import images as a painting surfaces that can be applied to objects.

<aside> ⚠️ To import images you need to create and setup mod folder first. Instructions

</aside>

To import an image, simply put them under /Surfaces folder into your mod folder.

Supported image formats: .png, .jpg, .bmp

For best results, import only images that are a power of two. For example 512x512, 1024x1024, 256x512

Metadata

You can specify additional information for your surface by placing a metadata file near your image. Metadata specified in JSON format.

<aside> 💡 Metadata files are not necessary for the image to be imported. However, it is recommended to make one.

</aside>

In order to make the game find this metadata, it should be placed in the same folder as the image and called the same name, but have an extension of .json.

For example your image is called Textile_01.png then your metadata file should be called Textile_01.json.

File example:

{
    "Name": "Simple image",
    "Categories": ["surfacecategory_images", "surfacecategory_wallpapers"],
		"Parameters": {
			"surfaceparam_color": {"R":255, "G":255, "B":255, "A":255},
			"surfaceparam_texturetransform": {"X":1.0, "Y":1.0, "Z":0.0}
		}
}

Metadata fields

Name

The name of your surface. It will be displayed in the game. If this field is not specified, surface will have a name of the file.

You can also specify the name for several languages. Instead of specifying the name as a text, you need to specify a dictionary of names with default value and a name for each culture.

	"Name": {
		"default": "Simple image",
		"en": "Simple image",
		"es": "imagen sencilla",
		"ru": "Простое изображение"
	}

Categories

Categories this surface will appear in. All imported surfaces will also be shown in the “Mods” category by default.

Parameters

Parameters are extra features a player can change for this surface. For now, there are only two options.

Parameter tag Description Value example
surfaceparam_color Color overlay. Each channel from 0 to 255 {"R":255, "G":255, "B":255, "A":255}
surfaceparam_texturetransform Size and rotation of the image {"X":1.0, "Y":1.0, "Z":0.0}