Make the world yours

Quick start

Open Godwright's install directory from Steam using Manage, then Browse local files. Create mods/my_first_mod/ beside the game executable and add this required file:

[mod]
name = My First Mod
author = Your Name
version = 1.0.0
enabled = true

1. Create the folder. The folder name controls local load order.
2. Add content. Start with a power, stat override, or sprite.
3. Restart Godwright. Mods are loaded once during startup.
4. Check Mods. Your name and version should say Active this launch.

Use any plain-text editor. For pixel art, Aseprite, LibreSprite, GIMP, and similar PNG editors all work. Keep filenames lowercase and use forward slashes in INI paths.

Package layout

Only mod.ini is required. A local mod and a Workshop upload use the exact same content-root layout. Do not put the files inside an extra nested folder.

my_first_mod/
├── mod.ini
├── entities.ini              optional stat overrides
├── simulation.ini            optional world tuning
├── buildings/                optional building definitions
│   └── crystal_spire.ini
├── powers/                   optional power definitions
│   └── verdant_pulse.ini
└── sprites/                  optional PNG replacements
    ├── buildings/
    │   └── crystal_spire.png
    └── icons/tools/
        └── verdant_pulse.png

INI sections, keys, and enum values are case-insensitive. Use # or; for comments. Unknown keys and malformed lines are skipped, so watch the startup log when testing.

Custom powers

Add one lowercase .ini file per power under powers/. IDs are stored as bytes; use stable IDs from 200 through 255 and never renumber a published power. Check other required mods for collisions.

[power]
id = 200
name = Verdant Pulse
group = Nature
icon = assets/icons/tools/verdant_pulse.png
builtin =
radius = 12
ent_damage = -50
fire_add = 0
tile_set =
elevation_add = 0
moisture_add = 0.30
spawn_entity =
spawn_count = 0
spawn_on_water = false
shake = 2
particles = sparkle
sound = heal

Pixel art and asset overrides

Mirror a game asset's path beneath your mod's sprites/ directory. In definitions, always reference the portable assets/... path. This works both locally and after Steam installs the Workshop item under its numeric ID.

Definition path:
icon = assets/icons/tools/verdant_pulse.png

File in your mod:
sprites/icons/tools/verdant_pulse.png

Other examples:
sprites/buildings/house.png
sprites/sprites/human/walk_down_0.png
sprites/menu/logo_godwright.png

• Use transparent PNGs for isolated icons and sprites.
• Power icons should be 24×24 pixels for a direct 1:1 toolbar fit.
• Match the original canvas and frame dimensions when replacing animation art.
• Animated buildings use equal-width frames in one horizontal strip.
• Keep artwork pixel-aligned and disable antialiasing.
• Never use absolute paths or .. segments inside definitions.

Entity overrides

Add entities.ini at the mod root. Each section changes one entity type; omitted fields keep their normal values.

[Dragon]
max_health = 2800
attack_damage = 65
color_r = 166
color_g = 104
color_b = 255

Saved entities preserve health, maximum health, damage, and size. Test changed combat stats with newly spawned entities or a fresh world.

Simulation tuning

Add simulation.ini at the mod root to tune global world behavior. Later mods replace earlier values.

[simulation]
day_length = 180
veg_growth_mult = 1.20
tree_spread_mult = 1.10
disaster_damage_mult = 1.10

Building definitions

Add one lowercase .ini file per definition under buildings/. Reusing a base-game ID changes that building. A new stable ID should use the 200–255 range.

[building]
id = 200
name = Crystal Spire
category = civic
sprite = assets/buildings/crystal_spire.png
anim_frames = 1
anim_fps = 6
cost_wood = 5
cost_stone = 20
cost_metal = 0
tier = 0
race = any
light_radius = 6
walkable = false
min_age = 0
race_variants = false

A new building ID can render and survive saves, but it does not automatically appear in the fixed Build tab or gain custom AI behavior. Override an existing building ID when you need its established placement and simulation behavior.

Test locally

1. Set enabled = true in mod.ini.
2. Place the folder under the installed game's mods/ directory.
3. Launch Godwright and open Mods from the main menu.
4. Confirm the mod says Active this launch.
5. Start a fresh world and test every changed power, entity, building, and sprite.
6. Quit completely before changing files; restart to reload them.

On Windows, the default install is usually under C:\Program Files (x86)\Steam\steamapps\common\Godwright\. On Linux, it is usually under ~/.local/share/Steam/steamapps/common/Godwright/. Use Steam's Browse local files action if your library is elsewhere.

Publish to Steam Workshop

Install Valve's SteamCMD, then create an upload VDF outside your mod's content folder. Use absolute paths. The contentfolder must point directly to the folder containing mod.ini.

"workshopitem"
{
    "appid"            "4884560"
    "publishedfileid"  "0"
    "contentfolder"    "C:\GodwrightMods\my_first_mod"
    "previewfile"      "C:\GodwrightMods\preview.png"
    "visibility"       "0"
    "title"            "My First Mod"
    "description"      "A short, clear description of the mod."
    "changenote"       "Initial release."
}

Run SteamCMD from a terminal:

steamcmd +login "YOUR_STEAM_USERNAME" +workshop_build_item "C:\GodwrightMods\item.vdf" +quit

1. Approve the Steam Guard sign-in when prompted.
2. Wait for Success. SteamCMD writes a Published File ID into the VDF.
3. Never reset that ID to zero after the first successful creation.
4. Open the new item page and accept the Workshop legal agreement if requested.
5. Add screenshots, compatibility notes, and clear usage instructions.
6. Subscribe, restart Godwright, and test the Steam-installed copy before announcing it.

Visibility values are 0 public, 1 friends-only, 2 private, and 3 unlisted. Start private while testing if you do not want an unfinished item visible.

Update a published mod

1. Change your files and increment version in mod.ini.
2. Test the updated folder locally, including an existing save.
3. Update changenote in the VDF.
4. Run the same SteamCMD command with the existing Published File ID.
5. Wait for Steam to download the update, then restart Godwright and verify it.

Never reuse a published building or power ID for unrelated content. IDs are stable identities and may be stored in player saves.

Troubleshooting