Modding Guide - Revision history

Psionusoid: /* How to publish your mod on Steam Workshop */ added missing period

2024-09-28T03:40:33Z

How to publish your mod on Steam Workshop: added missing period

← Older revision		Revision as of 03:40, 28 September 2024
Line 106:		Line 106:
	]		]
	</pre>		</pre>
	where "[steam workshop ID]" would be replaced with the the (number) name of the folder corresponding to the mod when downloaded from the Steam workshop in "Steam/steamapps/workshop/content/763890/" and the local mod IDs would be be the names of the folders for your published mods in "Wildermyth/mods/user/"		where "[steam workshop ID]" would be replaced with the the (number) name of the folder corresponding to the mod when downloaded from the Steam workshop in "Steam/steamapps/workshop/content/763890/" and the local mod IDs would be be the names of the folders for your published mods in "Wildermyth/mods/user/".

	== See also ==		== See also ==

Psionusoid: /* How to publish your mod */ updated info about updating mods from another computer

2024-09-28T03:39:37Z

How to publish your mod: updated info about updating mods from another computer

← Older revision		Revision as of 03:39, 28 September 2024
Line 81:		Line 81:
	# Edit the mod as desired.		# Edit the mod as desired.

	===How to publish your mod===		===How to publish your mod on Steam Workshop===

	Once you have created a mod, publishing it is easy. There is a button right in the game itself.		Once you have created a mod, publishing it is easy. There is a button right in the game itself.
Line 98:		Line 98:

	Congratulations, you are now a published mod author!		Congratulations, you are now a published mod author!

			If you wish to update your mod from another computer, you will need to copy or recreate the "managedModOwnership.json" file in the "Wildermyth/mods" folder. This file is of the form
			<pre>
			[
			{ "steamWorkshopId": "[steam workshop ID]", "localModId": "myCoolMod"},
			{ "steamWorkshopId": "[steam workshop ID]", "localModId": "myOtherCoolMod"}
			]
			</pre>
			where "[steam workshop ID]" would be replaced with the the (number) name of the folder corresponding to the mod when downloaded from the Steam workshop in "Steam/steamapps/workshop/content/763890/" and the local mod IDs would be be the names of the folders for your published mods in "Wildermyth/mods/user/"

	== See also ==		== See also ==

Pbelanger: /* See also */ Added link to Mod Injection page

2024-09-09T21:21:58Z

See also: Added link to Mod Injection page

← Older revision		Revision as of 21:21, 9 September 2024
Line 114:		Line 114:
	* [[Expressions]]		* [[Expressions]]
	* [[Modding Relationship Points\|Adding/strengthening relationships]]		* [[Modding Relationship Points\|Adding/strengthening relationships]]
			* [[Mod Injections]] (A way to make changes to existing json data without needing to overwrite the entire file, useful when modifying files that many modders may want to modify, e.g. the "human" aspect)

	[[Category:Modding]]		[[Category:Modding]]
	[[Category:Modding Guides]]		[[Category:Modding Guides]]

Bioness: /* Where to find installed mods */ reworded the instructions to be more formal and accurate

2022-01-04T23:00:19Z

Where to find installed mods: reworded the instructions to be more formal and accurate

← Older revision		Revision as of 23:00, 4 January 2022
Line 69:		Line 69:

	* Mods included with the game are stored under steam\steamapps\common\wildermyth\mods\builtin		* 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. ~~Also, mods~~ that you download from other sites such as [https://www.nexusmods.com/wildermyth nexus] will instruct you to install them in this folder.		* Mods that you create are stored under steam\steamapps\common\wildermyth\mods\user. Mods that you download from other sites such as [https://www.nexusmods.com/wildermyth nexus] will instruct you to install them in this folder.
	* 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 folder 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~~.		* Mods that you download from the steam workshop are located under steam\steamapps\workshop\content\763890, with 763890 being Wildermyth's Steam ID. Each mod is assigned a numeric steam ID, which can be viewed by looking at last digits of the URL in the browser version of Steam or by copying the page URL from the client and pasting it somewhere else. You can also identify which mods are which by viewing the mod.json file in mod folder. If you need to refer back to a mod frequently, saving the mod ID somewhere for future use will help save time.

	===Using an existing mod as a starting point===		===Using an existing mod as a starting point===

Pbelanger: Added "Starting Out" section, with a bit of a broad overview

2021-10-18T14:48:42Z

Added "Starting Out" section, with a bit of a broad overview

← Older revision		Revision as of 14:48, 18 October 2021
Line 2:		Line 2:

	For background on writing, as opposed to the mechanics of creating mods, see instead: [[Writer's Guide]] and [[Story Inputs and Outputs]]		For background on writing, as opposed to the mechanics of creating mods, see instead: [[Writer's Guide]] and [[Story Inputs and Outputs]]

			==Starting Out==
			When creating a mod of any kind, the first thing you'll usually want to do is go into the editor from the Wildermyth main menu (Tools > Editor), and create a new mod from either the '''Content and Comics Editor''' (Mods > Create New Mod) or the '''Steam Workshop''' page (Create New Mod button). Most of Wildermyth's data is stored as json files. Mods are stored in mods/user/[yourModName], with a parallel file structure to the core game. For example, if you wanted to modify the assets/data/balance/campaignBalance.json file, you would create a file at mods/user/[yourModName]/assets/data/balance/campaignBalance.json.

			The '''Content and Comics Editor''' is probably the first thing you'll want to look at. From there, you can see all the events, abilities, aspects, campaigns, items, and monsters used in the core game. Feel free to duplicate existing things as a starting place for your own mods (we certainly do!)

			In order to understand the structure of the data and tools, these are probably the best starting places (which are also linked to on the editor landing page):
			* [[Data Format Overview]] (A broad overview of the files in Wildermyth and how they work together)
			* [[Comic Editor Reference]] (How to create events, explanations of some of the editor tools)

	== Encounters (events) ==		== Encounters (events) ==

Davea at 03:53, 30 June 2021

2021-06-30T03:53:19Z

← Older revision		Revision as of 03:53, 30 June 2021
Line 18:		Line 18:
	* [[Modding quest chains]]. Creating a linked set of encounters, or "quest chain".		* [[Modding quest chains]]. Creating a linked set of encounters, or "quest chain".
	* [[Modding scripted missions]]. Creating a mission which has a specific map and script, as opposed to random monsters on a procedurally generated map.		* [[Modding scripted missions]]. Creating a mission which has a specific map and script, as opposed to random monsters on a procedurally generated map.
			* [[Modding generic chapters]]. As of June 2021, release 1.0 has a structure for chapters in the generic campaign. This topic shows how they work and how to add more.
	== Campaigns (Villains) ==		== Campaigns (Villains) ==

Davea at 15:10, 24 November 2020

2020-11-24T15:10:30Z

← Older revision		Revision as of 15:10, 24 November 2020
Line 60:		Line 60:

	* Mods included with the game are stored under steam\steamapps\common\wildermyth\mods\builtin		* 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. Also, mods that you download from other sites such as [~~http://~~https://www.nexusmods.com/wildermyth nexus] will instruct you to install them in this folder.		* Mods that you create are stored under steam\steamapps\common\wildermyth\mods\user. Also, mods that you download from other sites such as [https://www.nexusmods.com/wildermyth nexus] will instruct you to install them in this folder.
	* 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 folder 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.		* 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 folder 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.

Kermon: Adding a new guide, I said I'd write.

2020-08-01T18:29:30Z

Adding a new guide, I said I'd write.

← Older revision		Revision as of 18:29, 1 August 2020
Line 36:		Line 36:
	=== Equipment ===		=== Equipment ===
	* [[Modding add equipment\|Adding equipment]]		* [[Modding add equipment\|Adding equipment]]
			* [[Legacy Carry-Over]] Having an item stick with a hero through legacy.

	=== Monsters ===		=== Monsters ===

Davea: /* Other topics */

2020-07-02T17:16:24Z

Davea: /* How mods are loaded */

2020-07-02T17:14:14Z

How mods are loaded

← Older revision		Revision as of 17:14, 2 July 2020
Line 51:		Line 51:
	=== How mods are loaded ===		=== How mods are loaded ===

	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, all 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 ===		=== Where to find installed mods ===

← Older revision		Revision as of 17:16, 2 July 2020
Line 40:		Line 40:
	* [[Modding add monster\|Adding a monster]] (this is mostly duplicated by [http://yonderinglands.blogspot.com/2019/10/how-to-write-your-own-villain-for.html Part 3 Custom Monsters] above)		* [[Modding add monster\|Adding a monster]] (this is mostly duplicated by [http://yonderinglands.blogspot.com/2019/10/how-to-write-your-own-villain-for.html Part 3 Custom Monsters] above)
	* [[Modding monster abilities\|Adding a custom ability to a monster]]		* [[Modding monster abilities\|Adding a custom ability to a monster]]

			=== Factions ===
			* [[Modding replace faction\|Replacing the monsters in a faction]]

	=== Tidings ===		=== Tidings ===