Difference between revisions of "Modding Guide"

From Wildermyth Wiki
Line 24: Line 24:
= How it Works =  
= How it Works =  
Each mod lives in its own folder, and mirrors the folder structure of the game itself. When the game loads, are mods are scanned in order to show available scenarios, which can come from any mod. When a particular game is started, the mod where the story is found is always used, and additional mods can be specified. Mods can override any of the main categories of data that the game uses, and can provide new images too. Not all image-modding functionality is supported currently, however.
Each mod lives in its own folder, and mirrors the folder structure of the game itself. When the game loads, are mods are scanned in order to show available scenarios, which can come from any mod. When a particular game is started, the mod where the story is found is always used, and additional mods can be specified. Mods can override any of the main categories of data that the game uses, and can provide new images too. Not all image-modding functionality is supported currently, however.
= Where to find installed mods =
* Mods included with the game are stored under steam\steamapps\common\wildermyth\mods\builtin
* Mods that you create are stored under steam\steamapps\common\wildermyth\mods\user
* Mods that you download from the steam workshop are harder to find.  Under steam\steamapps\workshop\content, you need to know or guess the numeric steam game ID.  It seems to be 763890, so go inside that folder.  Then each mod is assigned a numeric steam mod ID.  If you have several mods, you may be able to guess which goes to a particular mod by the date you installed it.  If not, go into each folder and double click on the preview.jpg file to view it.  This is the "splash screen" of the mod.  Once you have found the steam ID of a particular mod, it may be easiest to write that down on a sticky by your monitor.
* (To do: when mods are installed from other sites such as nexusmods, where do they get installed?


= Game Data Reference =
= Game Data Reference =

Revision as of 09:53, 30 November 2019

Wildermyth is intended to be pretty moddable, but a lot of stuff isn't documented yet.


Tutorials and Guides

How to write your own Villain

This is a series of blog posts that walk through how to create a villain (campaign story). The story is called "Heart of the Forest" and the mod is shipped with the game so you can inspect it or use it as a baseline.

Writing Stories

There are a bunch of helpful articles on the wiki for this!

Adding a wilderness encounter

This section is under development.


How it Works

Each mod lives in its own folder, and mirrors the folder structure of the game itself. When the game loads, are mods are scanned in order to show available scenarios, which can come from any mod. When a particular game is started, the mod where the story is found is always used, and additional mods can be specified. Mods can override any of the main categories of data that the game uses, and can provide new images too. Not all image-modding functionality is supported currently, however.

Where to find installed mods

  • Mods included with the game are stored under steam\steamapps\common\wildermyth\mods\builtin
  • Mods that you create are stored under steam\steamapps\common\wildermyth\mods\user
  • Mods that you download from the steam workshop are harder to find. Under steam\steamapps\workshop\content, you need to know or guess the numeric steam game ID. It seems to be 763890, so go inside that folder. Then each mod is assigned a numeric steam mod ID. If you have several mods, you may be able to guess which goes to a particular mod by the date you installed it. If not, go into each folder and double click on the preview.jpg file to view it. This is the "splash screen" of the mod. Once you have found the steam ID of a particular mod, it may be easiest to write that down on a sticky by your monitor.
  • (To do: when mods are installed from other sites such as nexusmods, where do they get installed?

Game Data Reference

How the game works.