Modding replace faction - Revision history

Davea: /* Seeing the effect in game */

2020-07-02T19:01:58Z

Seeing the effect in game

← Older revision		Revision as of 19:01, 2 July 2020
Line 98:		Line 98:
	==Seeing the effect in game==		==Seeing the effect in game==
	# 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.		# 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.
	# Start a new game, ~~and~~ make sure that your faction is the "main enemy".		# Start a new game, make sure that your faction is the "main enemy", and enable the cheats such as "objective cheat".
	# In the introductory battle, exactly one monster drawn from your first two tracks should appear.		# In the introductory battle, exactly one monster drawn from your first two tracks should appear.
	# Use the objective cheat to win the first battle; you can add more calamity cards using the cheat menu to make sure that your monster types are appropriate.		# Use the objective cheat to win the first battle; you can add more calamity cards using the cheat menu to make sure that your monster types are appropriate.

Davea: /* Seeing the effect in game */

2020-07-02T19:01:15Z

Seeing the effect in game

← Older revision		Revision as of 19:01, 2 July 2020
Line 98:		Line 98:
	==Seeing the effect in game==		==Seeing the effect in game==
	# 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.		# 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.
	# ~~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~~.		# Start a new game, and make sure that your faction is the "main enemy".
	# In the ~~"Generate a unit" dropdown at the left~~, ~~choose "Davea's~~ monster~~" and then click Side A~~. ~~Your~~ monster ~~should appear:~~		# In the introductory battle, exactly one monster drawn from your first two tracks should appear.
			# Use the objective cheat to win the first battle; you can add more calamity cards using the cheat menu to make sure that your monster types are appropriate.

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

Davea: /* Add tracks */

2020-07-02T18:58:51Z

Add tracks

← Older revision		Revision as of 18:58, 2 July 2020
Line 95:		Line 95:
	</pre>		</pre>
	The first two lines give the name and description of the monster; the second two lines give the name and description of the calamity card. I happen to have used the same text for both.		The first two lines give the name and description of the monster; the second two lines give the name and description of the calamity card. I happen to have used the same text for both.

	~~<li>names~~

	==Seeing the effect in game==		==Seeing the effect in game==

Davea: /* Add tracks */

2020-07-02T18:58:09Z

Add tracks

← Older revision		Revision as of 18:58, 2 July 2020
Line 93:		Line 93:
	monsterCardName.track_yab_dagger=Brigand		monsterCardName.track_yab_dagger=Brigand
	monsterCardBlurb.track_yab_dagger=All daggers, and all out of targets- until now.		monsterCardBlurb.track_yab_dagger=All daggers, and all out of targets- until now.
	<pre>		</pre>
	The first two lines give the name and description of the monster; the second two lines give the name and description of the calamity card. I happen to have used the same text for both.		The first two lines give the name and description of the monster; the second two lines give the name and description of the calamity card. I happen to have used the same text for both.

Davea: /* Add tracks */

2020-07-02T18:57:43Z

Add tracks

← Older revision		Revision as of 18:57, 2 July 2020
Line 85:		Line 85:
	<li>For the introductory mission, only the first two tracks can be selected. Place your most "introductory" monsters here. In addition to onlyIfFlavorHasCards, there are some rules in the game engine about introducing new monsters slowly.</li>		<li>For the introductory mission, only the first two tracks can be selected. Place your most "introductory" monsters here. In addition to onlyIfFlavorHasCards, there are some rules in the game engine about introducing new monsters slowly.</li>
	</ol>		</ol>
	Remove all the ~~cards~~ for the old faction monsters, and add one track for each of your own monsters. You should decide which monsters should have "packs" by multiple card entries, and ~~set~~ onlyIfFlavorCards to roughly set the order in which monsters will be introduced.		Remove all the tracks for the old faction monsters, and add one track for each of your own monsters. You should decide which monsters should have "packs" by multiple card entries, and use onlyIfFlavorCards to roughly set the order in which monsters will be introduced.

	For each track, you will also need to add a display name which appears as the title of the calamity card. You can set this in assets/text/dynamic/dynamic.properties:		For each track, you will also need to add a display name which appears as the title of the calamity card. You can set this in assets/text/dynamic/dynamic.properties:

Davea: /* Add tracks */

2020-07-02T18:57:13Z

Add tracks

← Older revision		Revision as of 18:57, 2 July 2020
Line 81:		Line 81:
	There are several important points.		There are several important points.
	<ol>		<ol>
	<li>Smaller monsters will eventually appear in packs. For example, the Roe will initially appear in groups of one, but later it may appear in groups of up to three. In game, you will see monster cards like "Gorgon Roe II", where the roman II means that two of these monsters appear at once; this corresponds to the second entry in the cards array which lists two. It is certainly possible to have ~~multiple monsters~~ in the same card entry. This could be a little confusing since only one image appears to the player.</li>		<li>Smaller monsters will eventually appear in packs. For example, the Roe will initially appear in groups of one, but later it may appear in groups of up to three. In game, you will see monster cards like "Gorgon Roe II", where the roman II means that two of these monsters appear at once; this corresponds to the second entry in the cards array which lists two. It is certainly possible to have different monster types in the same card entry. This could be a little confusing since only one image appears to the player.</li>
	<li>Some monsters are prevented from appearing early in the game, by the entry "onlyIfFlavorHasCards". For example, the bear will only appear, after the calamities column for this faction has at least four cards. Calamity cards are added at different points during the game, and sometimes subtracted in the chapter interval. This roughly measures your progress through the game. For monsters which can appear at the beginning, don't place any value; for more advanced monsters, use increasing numbers. It's unlikely that as many as 10 calamities will appear for the faction, so numbers in the range 4-8 are probably best.</li>		<li>Some monsters are prevented from appearing early in the game, by the entry "onlyIfFlavorHasCards". For example, the bear will only appear, after the calamities column for this faction has at least four cards. Calamity cards are added at different points during the game, and sometimes subtracted in the chapter interval. This roughly measures your progress through the game. For monsters which can appear at the beginning, don't place any value; for more advanced monsters, use increasing numbers. It's unlikely that as many as 10 calamities will appear for the faction, so numbers in the range 4-8 are probably best.</li>
	<li>For the introductory mission, only the first two tracks can be selected. Place your most "introductory" monsters here. In addition to onlyIfFlavorHasCards, there are some rules in the game engine about introducing new monsters slowly.</li>		<li>For the introductory mission, only the first two tracks can be selected. Place your most "introductory" monsters here. In addition to onlyIfFlavorHasCards, there are some rules in the game engine about introducing new monsters slowly.</li>

Davea: /* Add tracks */

2020-07-02T18:56:17Z

Add tracks

← Older revision		Revision as of 18:56, 2 July 2020
Line 79:		Line 79:
	]		]
	</syntaxhighlight>		</syntaxhighlight>
			There are several important points.
			<ol>
			<li>Smaller monsters will eventually appear in packs. For example, the Roe will initially appear in groups of one, but later it may appear in groups of up to three. In game, you will see monster cards like "Gorgon Roe II", where the roman II means that two of these monsters appear at once; this corresponds to the second entry in the cards array which lists two. It is certainly possible to have multiple monsters in the same card entry. This could be a little confusing since only one image appears to the player.</li>
			<li>Some monsters are prevented from appearing early in the game, by the entry "onlyIfFlavorHasCards". For example, the bear will only appear, after the calamities column for this faction has at least four cards. Calamity cards are added at different points during the game, and sometimes subtracted in the chapter interval. This roughly measures your progress through the game. For monsters which can appear at the beginning, don't place any value; for more advanced monsters, use increasing numbers. It's unlikely that as many as 10 calamities will appear for the faction, so numbers in the range 4-8 are probably best.</li>
			<li>For the introductory mission, only the first two tracks can be selected. Place your most "introductory" monsters here. In addition to onlyIfFlavorHasCards, there are some rules in the game engine about introducing new monsters slowly.</li>
			</ol>
			Remove all the cards for the old faction monsters, and add one track for each of your own monsters. You should decide which monsters should have "packs" by multiple card entries, and set onlyIfFlavorCards to roughly set the order in which monsters will be introduced.

			For each track, you will also need to add a display name which appears as the title of the calamity card. You can set this in assets/text/dynamic/dynamic.properties:
			<pre>
			yab_dagger.name=Brigand
			yab_dagger.blurb=All daggers, and all out of targets- until now.
			monsterCardName.track_yab_dagger=Brigand
			monsterCardBlurb.track_yab_dagger=All daggers, and all out of targets- until now.
			<pre>
			The first two lines give the name and description of the monster; the second two lines give the name and description of the calamity card. I happen to have used the same text for both.

			<li>names

	==Seeing the effect in game==		==Seeing the effect in game==

Davea: /* Update the calamities */

2020-07-02T18:44:42Z

Update the calamities

← Older revision		Revision as of 18:44, 2 July 2020
Line 43:		Line 43:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	The key is to find all the calamities in the file where "flavor" matches the faction you are replacing, which may be scattered around in the existing file. As you will see, there are 3 basic types: GAINS_armor, GAINS_health, GAINS_damage; GAINS_range is no longer used and always has "weight:0" to prevent it from appearing. There are also several faction specific types, like GAIN_imposeConcuss and GAINS_imposeMindworm. ~~You can~~ add your own aspects as described elsewhere on the wiki~~, but for~~ now, ~~just remove all~~ the ~~existing~~ calamities of your ~~faction,~~ and ~~add~~ a ~~new set using your monsterIds~~.		The key is to find all the calamities in the file where "flavor" matches the faction you are replacing, which may be scattered around in the existing file. As you will see, there are 3 basic types: GAINS_armor, GAINS_health, GAINS_damage; GAINS_range is no longer used and always has "weight:0" to prevent it from appearing. There are also several faction specific types, like GAIN_imposeConcuss and GAINS_imposeMindworm. Later, you could add your own aspects as described elsewhere on the wiki.

			For now, add the three basic calamities for each of your monster types. It may be easier to do this using cut and paste in a text editor.

	If you accidentally leave some monsterIds which refer to the monsters you removed, then the player may see these calamity cards appear, even though the monsters they refer to will never appear.		If you accidentally leave some monsterIds which refer to the monsters you removed, then the player may see these calamity cards appear, even though the monsters they refer to will never appear.

Davea at 18:11, 2 July 2020

2020-07-02T18:11:38Z

← Older revision		Revision as of 18:11, 2 July 2020
Line 29:		Line 29:
	==Update the calamities==		==Update the calamities==

	All of the calamities are listed in the file assets/data/calamity/calamities.json. Today, there is no way to "merge" calamities between different mods. So, if it happens that two mods change this file, the file from the mod with higher priority will take effect, and the other files with this name will be ignored. The file contains all the calamities, one after the other. Each ~~one~~ looks like this:		All of the calamities are listed in the file assets/data/calamity/calamities.json. Today, there is no way to "merge" calamities between different mods. So, if it happens that two mods change this file, the file from the mod with higher priority will take effect, and the other files with this name will be ignored. The file contains all the calamities, one after the other, for all the factions. Each calamity looks like this:


	~~==Add tracks==~~

	~~NYI~~

	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
Line 48:		Line 43:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			The key is to find all the calamities in the file where "flavor" matches the faction you are replacing, which may be scattered around in the existing file. As you will see, there are 3 basic types: GAINS_armor, GAINS_health, GAINS_damage; GAINS_range is no longer used and always has "weight:0" to prevent it from appearing. There are also several faction specific types, like GAIN_imposeConcuss and GAINS_imposeMindworm. You can add your own aspects as described elsewhere on the wiki, but for now, just remove all the existing calamities of your faction, and add a new set using your monsterIds.

			If you accidentally leave some monsterIds which refer to the monsters you removed, then the player may see these calamity cards appear, even though the monsters they refer to will never appear.

			==Add tracks==
			The tracks section is similar to the "encounter table" you may find in other games. The related file is: assets/data/generation/monsterDecks.json. As with the calamity file, only the file from the highest priority mod is currently used. Each of the five factions appears in its own "groupFlavor" section, and each monster has its own entry in the "tracks" section. Here is a section of the monsterDecks file for Gorgons.

			<syntaxhighlight lang="json">
			"tracks": [
			{
			"name": "track_gorgon_deer",
			"advanceWeight": 1.4,
			"cards": [
			["gorgon_roe"],
			["gorgon_roe", "gorgon_roe"],
			["gorgon_roe", "gorgon_roe", "gorgon_roe"]
			]
			},
			{
			"name": "track_gorgon_raccoon",
			"cards": [
			["gorgon_coon"],
			["gorgon_coon", "gorgon_coon"]
			]
			},
			{
			"name": "track_gorgon_bear",
			"onlyIfFlavorHasCards": 4,
			"cards": [
			["gorgon_gheist"]
			]
			}
			]
			</syntaxhighlight>

Davea at 17:52, 2 July 2020

2020-07-02T17:52:30Z

← Older revision		Revision as of 17:52, 2 July 2020
Line 29:		Line 29:
	==Update the calamities==		==Update the calamities==

	~~NYI~~		All of the calamities are listed in the file assets/data/calamity/calamities.json. Today, there is no way to "merge" calamities between different mods. So, if it happens that two mods change this file, the file from the mod with higher priority will take effect, and the other files with this name will be ignored. The file contains all the calamities, one after the other. Each one looks like this:


	==Add tracks==		==Add tracks==
Line 36:		Line 37:

	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	[
	{		{
	"~~modId~~": "~~lewe~~",		"weight": 0.35,
	"id": "~~lewe_stun_lord~~",		"card": {
	"~~effects~~": [ "~~lewe_stun_lord~~" ],		"id": "buff_yab_dagger_GAINS_armor",
	"~~importance~~": ~~-1,~~		"category": "buffMonster",
			"flavor": "drauven",
			"monsterIds": [ "yab_dagger" ],
			"aspects": [ "calamityBuffMonster_armor" ]
			}
	}		}
	]
	</syntaxhighlight>		</syntaxhighlight>