Modding add monster

This page is a work in progress. It will walk through the process of adding a new monster with a custom image. The focus is on getting something simple which you can see in the game, and adding more details later. The description and screenshots are current as of November 2019, early access version 0.10+98 Ryvio Wartmarch.

Preparation

Before you begin, create or find an image file for your monster. It should be a few hundred pixels in each dimension (not tens, and not thousands) and should have a transparent background. Please be sure it does not have any copyright restrictions, that is, the image should be one you drew, or one which is clearly public domain. We will use this guy:

[[File::ModdingMonsterRedDragon.PNG]]

Getting started

1. Select "Tools" at the main game screen, then "Open Editor", then "Content and Comics Editor"
2. At the upper left, click "Mods", click "Create New Mod" in the browser, and fill in the form. This will pop up a file browser showing the files the tool just created; note that the directory is steam\steamapps\common\wildermyth\mods\user\<your mod name>. You will use this directory soon.
3. Click the "save" button and then exit. Most of the work for this mod is done outside the in-game editor; the editor doesn't appear to support creating monsters yet.

Modifying the files

1. Using a file explorer, navigate to the game install directory: steam\steamapps\common\Wildermyth\assets. We need to copy (not move!) several files from there to your mod directory. For each file when it is mentioned below, create folders in your mod as needed and copy, and then modify. These files are program source code and proper syntax is very important.
2. Add the monster definition. Copy file data\monsters\animal_goat.json, and call the new file davea_monster1.json. On the line where the image is shown, change to misc/davea_monster1:

   "skin": [
   	{
   		"image": [ "misc/davea_monster1" ]
   	}
   ]
   

3. Copy the image file to figures\misc\davea_monster1.png. (Filenames appear to be case sensitive, davea_monster1.PNG appears to not work.)
5. Add the name and blurb for the item. Copy and modify file text\dynamic\dynamic.properties. Delete all the text and add these lines:
   #suppress inspection "UnusedProperty" for whole file
#suppress inspection "UnusedProperty" for whole file
davea_monster1.name=Davea's monster
davea_monster1.blurb=Davea's monster's blurb
6. Later, you can look at other monsters in the source directory and change the monster's abilities, health and difficulty scaling to suit.

Seeing the effect in game

1. If you haven't already done so, enable developer mode. (Save and exit before doing this.) In file explorer, create an empty file under steam\steamapps\common\Wildermyth called devmode.txt.
2. Choose tools from the game main menu, then select combat lab. This will give you a chessboard-like battle map with a few characters and monsters already spawned.
3. In the "Generate a unit" dropdown at the left, choose "Davea's monster" and then click Side A. Your monster should appear: