Modding encounter choice - Revision history

Croald at 05:10, 5 December 2019

2019-12-05T05:10:32Z

← Older revision		Revision as of 05:10, 5 December 2019
Line 57:		Line 57:
	</ol>		</ol>
	For other encounters, you may wish to have other outcomes. Choose different values in the "Add outcome" picklist. To trigger the upgrade gear dialog with a new item, choose UpgradeGear. To add a theme, such as fire, leaf, or crow, choose ApplyTheme.		For other encounters, you may wish to have other outcomes. Choose different values in the "Add outcome" picklist. To trigger the upgrade gear dialog with a new item, choose UpgradeGear. To add a theme, such as fire, leaf, or crow, choose ApplyTheme.

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

Davea: /* Adding the choice in the effect */

2019-12-02T04:53:41Z

Adding the choice in the effect

← Older revision		Revision as of 04:53, 2 December 2019
Line 10:		Line 10:

	==Adding the choice in the effect==		==Adding the choice in the effect==
	::# Expand the choiceTarget line (click the plus sign to its left), hover over the options line, and click the "new target" button. In the "New Choice" dialog, you will see Choice Tag one, Outcome type simple. Leave these choices for now and just click "create".		# Expand the choiceTarget line (click the plus sign to its left), hover over the options line, and click the "new target" button. In the "New Choice" dialog, you will see Choice Tag one, Outcome type simple. Leave these choices for now and just click "create".
	# Create a second new choice, which will be filled in with Choice Tag two. Additional elements in the outcomes list are automatically added. The effect panel should look similar to this. Notice the two options are called one and two, and each one has a "then description" in the outcome section.		# Create a second new choice, which will be filled in with Choice Tag two. Additional elements in the outcomes list are automatically added. The effect panel should look similar to this. Notice the two options are called one and two, and each one has a "then description" in the outcome section.
	[[File:ModdingChoiceEffect.PNG]]		::[[File:ModdingChoiceEffect.PNG]]

	==Filling in the comic panels==		==Filling in the comic panels==

Davea: /* Adding outcomes */

2019-12-02T04:53:16Z

Adding outcomes

← Older revision		Revision as of 04:53, 2 December 2019
Line 50:		Line 50:
	<ol>		<ol>
	<li>Under outcomes, under "Chose << one >>", there is a button "Add Outcome...". Click this and select RelationshipPoints. This fills in the right side of the "New Outcome" dialog:		<li>Under outcomes, under "Chose << one >>", there is a button "Add Outcome...". Click this and select RelationshipPoints. This fills in the right side of the "New Outcome" dialog:
	[[File:ModdingChoiceOutcome.PNG]]		<br>[[File:ModdingChoiceOutcome.PNG]]
	<li>Click on party, and change the value to hero.		<li>Click on party, and change the value to hero.
	<li>Hover over "who", add another entry, and change its value to volunteer. This ensures both characters will get the same update.		<li>Hover over "who", add another entry, and change its value to volunteer. This ensures both characters will get the same update.

Davea at 04:52, 2 December 2019

2019-12-02T04:52:28Z

← Older revision		Revision as of 04:52, 2 December 2019
Line 10:		Line 10:

	==Adding the choice in the effect==		==Adding the choice in the effect==
	# Expand the choiceTarget line (click the plus sign to its left), hover over the options line, and click the "new target" button. In the "New Choice" dialog, you will see Choice Tag one, Outcome type simple. Leave these choices for now and just click "create".		::# Expand the choiceTarget line (click the plus sign to its left), hover over the options line, and click the "new target" button. In the "New Choice" dialog, you will see Choice Tag one, Outcome type simple. Leave these choices for now and just click "create".
	# Create a second new choice, which will be filled in with Choice Tag two. Additional elements in the outcomes list are automatically added. The effect panel should look similar to this. Notice the two options are called one and two, and each one has a "then description" in the outcome section.		# Create a second new choice, which will be filled in with Choice Tag two. Additional elements in the outcomes list are automatically added. The effect panel should look similar to this. Notice the two options are called one and two, and each one has a "then description" in the outcome section.
	[[File:ModdingChoiceEffect.PNG]]		[[File:ModdingChoiceEffect.PNG]]
Line 44:		Line 44:
	# You can test in-game; it is possible, but unlikely that the event will show up as failed to trigger. For example, it will certainly not trigger on a party of three hetero males. For certain other combinations, the event may or may not trigger, depending on which character is selected. In a group of three males where two are attracted to men, choosing the hetero male first will result in no valid combination, while choosing one of the others will result in a valid combination.		# You can test in-game; it is possible, but unlikely that the event will show up as failed to trigger. For example, it will certainly not trigger on a party of three hetero males. For certain other combinations, the event may or may not trigger, depending on which character is selected. In a group of three males where two are attracted to men, choosing the hetero male first will result in no valid combination, while choosing one of the others will result in a valid combination.
	# Here is the way the encounter should look now:		# Here is the way the encounter should look now:
	[[File:ModdingChoiceSelector.PNG]]		::[[File:ModdingChoiceSelector.PNG]]


	~~... in progress~~

	==Adding outcomes==		==Adding outcomes==
			Finally, let us add some results for this encounter. So far we have used a "description" outcome which has no effect. For the "one" branch of our encounter, let us change the relationship.
	... in ~~progress~~		<ol>
			<li>Under outcomes, under "Chose << one >>", there is a button "Add Outcome...". Click this and select RelationshipPoints. This fills in the right side of the "New Outcome" dialog:
			[[File:ModdingChoiceOutcome.PNG]]
			<li>Click on party, and change the value to hero.
			<li>Hover over "who", add another entry, and change its value to volunteer. This ensures both characters will get the same update.
			<li>Change the amount to 2 (or 1 if you prefer a more gradual growth). Change forceChangeRelationship to "lover".
			<li>Save the encounter and test. Now when you reach the end of the encounter, you should get an additional dialog indicating the two characters have fallen in love. Success!
			</ol>
			For other encounters, you may wish to have other outcomes. Choose different values in the "Add outcome" picklist. To trigger the upgrade gear dialog with a new item, choose UpgradeGear. To add a theme, such as fire, leaf, or crow, choose ApplyTheme.

Davea at 04:37, 2 December 2019

2019-12-02T04:37:37Z

← Older revision		Revision as of 04:37, 2 December 2019
Line 1:		Line 1:
	This page walks through the process of creating an encounter with a single choice. 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.		This page walks through the process of creating an encounter with a single choice, and then adding a party selector and rewards. 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.

	==Prerequisite encounter==		==Prerequisite encounter==
Line 36:		Line 36:

	==Adding party selectors==		==Adding party selectors==
	Let's keep going. We will make this encounter one which tries to start up a romance. For ~~this one, because I have in mind a title which requires a female~~, we will choose ~~a female hero~~ who does not already have ~~any~~ romance. Then for the volunteer, we will choose a character whose male/female preferences allow for a match. In case the party does not match the criteria, this will cause the event to be unpickable.		Let's keep going. We will make this encounter one which tries to start up a romance. For the hero role, we will choose any character who does not already have a romance. Then for the volunteer, we will choose a character whose male/female preferences allow for a match. In case the party does not match the criteria, this will cause the event to be unpickable.
			# In the encounter, open the hero section, and make sure the template value is PICK_BY_SCORE.
			# Open the section "How many, and how to choose them". Click on scoreFunction and enter: 1-HAS_LOVER. Click on scoreThreshold and enter 1.
			# Documentation for the functions available in the scoreFunction is currently limited. It is helpful to scan for ideas by looking at the values that show up as suggestions. Once you find an interesting looking function name, search for it in the existing game files to see more of the context.
			# The HAS_LOVER function returns 0 if the character has a lover, that is, any character in their relationship tab who has a "love" type with a nonzero value. Since scoreThreshold is a "greater than or equal" comparison, giving a scoreFunction of 1-HAS_LOVER and a threshold of 1 means that characters who have a lover are excluded.
			# In the volunteer "How many" section, enter the scoreFunction "CAN_ROMANCE.hero" and scoreThreshold 1. This is even more obscure, and arguably this syntax is backwards from what you might expect. CAN_ROMANCE is apparently a predefined function which we cannot examine, but it will ensure that both characters are interested (that is, man attracted to woman and vice versa, or one of the other combinations.) It also apparently has a maximum age difference so that very old characters will not be intersted in very young ones.
			# You can test in-game; it is possible, but unlikely that the event will show up as failed to trigger. For example, it will certainly not trigger on a party of three hetero males. For certain other combinations, the event may or may not trigger, depending on which character is selected. In a group of three males where two are attracted to men, choosing the hetero male first will result in no valid combination, while choosing one of the others will result in a valid combination.
			# Here is the way the encounter should look now:
			[[File:ModdingChoiceSelector.PNG]]


	... in progress		... in progress

Davea at 23:55, 1 December 2019

2019-12-01T23:55:16Z

← Older revision		Revision as of 23:55, 1 December 2019
Line 36:		Line 36:

	==Adding party selectors==		==Adding party selectors==
	Let's keep going. We will make this encounter one which tries to start up a romance. For this one, we will choose ~~a gendered title and~~ a female ~~volunteer~~ who does not already have any romance. Then for the ~~hero~~, we will choose a character whose male/female preferences allow for a match. In case the party does not match the criteria, this will cause the event to be unpickable.		Let's keep going. We will make this encounter one which tries to start up a romance. For this one, because I have in mind a title which requires a female, we will choose a female hero who does not already have any romance. Then for the volunteer, we will choose a character whose male/female preferences allow for a match. In case the party does not match the criteria, this will cause the event to be unpickable.

			... in progress

			==Adding outcomes==

	... in progress		... in progress

Davea at 23:53, 1 December 2019

2019-12-01T23:53:51Z

← Older revision		Revision as of 23:53, 1 December 2019
Line 34:		Line 34:
	<li>When you click the assault button, you should immediately be able to pick your event.		<li>When you click the assault button, you should immediately be able to pick your event.
	</ol>		</ol>

			==Adding party selectors==
			Let's keep going. We will make this encounter one which tries to start up a romance. For this one, we will choose a gendered title and a female volunteer who does not already have any romance. Then for the hero, we will choose a character whose male/female preferences allow for a match. In case the party does not match the criteria, this will cause the event to be unpickable.

			... in progress

Davea at 23:24, 1 December 2019

2019-12-01T23:24:08Z

← Older revision		Revision as of 23:24, 1 December 2019
Line 10:		Line 10:

	==Adding the choice in the effect==		==Adding the choice in the effect==
	# Expand the choiceTarget line (click the plus sign to its left), hover over the options line, and click the "new target" button. In the "New Choice" dialog, you will see Choice Tag one, Outcome type simple. Leave these choices for now and just click "create". Create a second new choice, which will be filled in with Choice Tag two. Additional elements in the outcomes list are automatically added. The effect panel should look similar to this.		# Expand the choiceTarget line (click the plus sign to its left), hover over the options line, and click the "new target" button. In the "New Choice" dialog, you will see Choice Tag one, Outcome type simple. Leave these choices for now and just click "create".
			# Create a second new choice, which will be filled in with Choice Tag two. Additional elements in the outcomes list are automatically added. The effect panel should look similar to this. Notice the two options are called one and two, and each one has a "then description" in the outcome section.
	[[File:ModdingChoiceEffect.PNG]]		[[File:ModdingChoiceEffect.PNG]]

	==Filling in the comic panels==		==Filling in the comic panels==
			# The rest of the work is done in the comics panel. Select comics in the dropdown at the top left, and open your comic.
			# Setting up the encounter has created a number of panels for us:
			** Prompt, which displays when the encounter begins. You can add panels under this, before the choice.
			** Choose, the "left choice"
			** Choose, the "right choice"
			** Outcome 1 >> Chose 1. You can add panels under this, which will appear after the player selects the first choice.
			** Outcome 2 >> Chose 2. You can add panels here, for the second choice.
			# We'll fill in just a little, so that it will make sense when we see it in the game.
			# In the prompt panel, add the hero and the volunteer, and a question, "The path branches left and right". "Which way should we go?"
			# In the left choice, add the hero and the answer, "Left". In the right choice comic, add the hero and the answer "Right".
			# In outcome 1, "Thank goodness we went right". In outcome 2, "Thank goodness we went left".

	==Seeing the effect in game==		==Seeing the effect in game==
	<ol><li>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.		<ol><li>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.

Davea at 23:05, 1 December 2019

2019-12-01T23:05:16Z

← Older revision		Revision as of 23:05, 1 December 2019
Line 17:		Line 17:
	<ol><li>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.		<ol><li>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.
	<li>Start a new one chapter story. Choose your mod in the mod picklist, enable "pick events" so that you can choose your event to trigger, and enable "overland only" to skip all the fights.		<li>Start a new one chapter story. Choose your mod in the mod picklist, enable "pick events" so that you can choose your event to trigger, and enable "overland only" to skip all the fights.
	~~[[File:ModdingEncounterNewStoryDebug.PNG]]~~		<li>When the game starts, you will get the first "pick event" dialog to choose which introductory story to use. Pick random and just click through it. Then choose any nearby territory and move your party to scout it. Most often, when scouting finishes, you will have an "assault" choice. In case you happened to pick a territory with only a station, choose another territory and move to it.
	<li>When the game starts, you will get the first "pick event" dialog to choose which introductory story to use. Pick random and just click through it. Then choose any nearby territory and move your party to scout it. In ~~order for~~ a ~~wilderness encounter to trigger, the~~ territory ~~must be empty; if you get an infestation result and the ambush icon appears~~, choose another territory and move to it. ~~There doesn't appear~~ to ~~be any faster way~~ to trigger ~~an event~~.		<li>Save the game. Now as you work to refine the choice, you can immediately come back to the point where the mod is about to trigger.
	<li>~~Once~~ you ~~complete a scouting event with no infestation~~, ~~the "~~pick ~~event" dialog will appear, showing~~ your ~~new~~ event~~! In this case I have named it "Crops of Stone":~~		<li>When you click the assault button, you should immediately be able to pick your event.
	~~[[File:ModdingEncounterPickMe~~.~~PNG]]~~
	</ol>		</ol>

Davea at 23:03, 1 December 2019

2019-12-01T23:03:08Z

← Older revision		Revision as of 23:03, 1 December 2019
Line 1:		Line 1:
	This page walks through the process of creating an encounter with a single choice. 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.		This page walks through the process of creating an encounter with a single choice. 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~~==		==Prerequisite encounter==
	# ~~A typical encounter has between 1-3 PCs. You will need to think~~ of the ~~criteria for selecting the PCs; it helps to browse the existing events to get some ideas of this. To start with, you can randomly select party members.~~		# This is a brief summary of the prerequisite steps. If you have an example event already skip to the next section. For more details see [[Modding Wilderness encounter\|Adding a wilderness encounter]]
	~~# A typical encounter has 3-10~~ steps~~, which you can think of as rows of the comic~~. ~~Each panel will have 1-2 lines of dialog, which can be chosen depending on the characters' personality. You should write out at least one line for each panel before~~ you ~~start. Later, you can add personality variants~~
	~~# Most encounters~~ have ~~a choice, or there isn't really any point.~~ ~~Decide what choice you will force~~ the ~~player to make~~. ~~If there are three choices, you will need~~ a ~~set of rows for each choice. Write at least one line for each choice, and write the dialog for the rows following each choice.~~
	# Every row of the comic must be designed. The comic tool has drag and drop aspects, but you are still in charge of the detailed visual design of each row. It can help to sketch out how you want each row to look, so that you will spend less time moving and re-moving items in the editor.

	~~==Getting started==~~
	# Select "Tools" at the main game screen, then "Open Editor", then "Content and Comics Editor"		# Select "Tools" at the main game screen, then "Open Editor", then "Content and Comics Editor"
	# 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; you can close this for now~~.		# At the upper left, click "Mods", click "Create New Mod" in the browser, and fill in the form.
	# At the upper left, click "effects", then "New", and fill in the form. In the "Type" dropdown, select "~~Wilderness Scouting~~". The name field will fill in with auto-generated text. ~~In this example, the full name is [davea_enc_01]davea_enc_o1_cropsOfStone~~		# At the upper left, click "effects", then "New", and fill in the form. In the "Type" dropdown, select "Arrive at Hostile Site". The name field will fill in with auto-generated text.
			# On the targets line, add the default "hero" story role and a second story role "volunteer"
	~~==Filling out the encounter==~~		# '''This is the most common mistake, causing a mod to not work! New events are disabled by default.''' Under abilities, set encounterEnabled to true
	# ~~Add one story role for each PC in~~ the ~~dialog you wrote. In this example, we will have "hero", "volunteer2" and "volunteer3".~~
	~~# Hover the mouse over "~~targets~~" and a row of buttons will appear. Click "New Story Role" and the New Story Role dialog will appear. For the first one~~, ~~just click~~ the ~~"Create" button at the bottom right. This will add line 5,~~ "hero".
	~~# Add two more~~ story ~~roles using "New Story Role". For the~~ second ~~one, in the "~~role" ~~dropdown, select volunteer2, and create. For the third one, select volunteer3.~~
	~~# At the bottom, you will see text, "Error: target <N> (choiceTarget) defines no choices". For now, delete the choiceTarget row by hovering over the choiceTarget line and choosing "X~~" ~~to delete it.~~
	# Hover over the outcomes line and click New Entry, then on the right side, click New Entry and select Description (the first entry) in the dropdown. This links the comic we will create, to this encounter.
	# '''This is the most common mistake, causing a mod to not work! New events are disabled by default'''~~. This is so that works in progress don't get accidentally selected. To enable the event, click the plus sign next to the ability section near the middle to open it; and under that~~, ~~find the~~ encounterEnabled ~~line which reads "false". Click the value~~ to ~~change it, and check the checkbox. (The graphics make this a little hard to read.) Then it should read "encounterEnabled:~~ true".
	~~# Now is a good time to save, using the button at the top of the window.~~
	~~# The target section of your encounter window should now look like this:~~
	~~[[File:ModdingEncounterEffect.PNG]]~~

	~~==Starting the first comic panel==~~
	~~# At the top of the screen, select "comics" to open the comic editor. If it is not already selected, select the name of your encounter.~~
	~~# Designing each panel requires quite a number of steps. We will go through creating one panel and then test it in-game.~~
	# We will have one NPC with dialog. At the upper left, click the button "New NPC". Your screen should look like this; in particular note the targets section includes hero, volunteer2 and volunteer3, and the generated targets section includes npc. If you do not see those, please review the earlier steps.
	~~[[File:EncounterFirstComic.PNG]]~~

	==~~Finishing~~ the ~~first comic panel~~==		==Adding the choice in the effect==
	# ~~We want a full width panel containing~~ the ~~hero character~~, the ~~npc~~, and ~~one line of dialog for each. If you find the right side panel becomes blank,~~ click on the "~~Outcome 1~~" ~~box on the left so it turns bright blue~~. ~~This causes~~ the ~~right side to refresh.~~		# Expand the choiceTarget line (click the plus sign to its left), hover over the options line, and click the "new target" button. In the "New Choice" dialog, you will see Choice Tag one, Outcome type simple. Leave these choices for now and just click "create". Create a second new choice, which will be filled in with Choice Tag two. Additional elements in the outcomes list are automatically added. The effect panel should look similar to this.
	~~# On the right side, under~~ "~~panel~~", ~~click on "bg"~~, ~~and scroll through the~~ choices ~~of all the backgrounds to find comicBG_hillsYellow~~		[[File:ModdingChoiceEffect.PNG]]
	~~# On the right side, click on "size"~~ and ~~select "full"~~
	~~# On the right side, near the middle under actorSlots,~~ click "~~add actor~~". ~~This adds the hero~~, which ~~was the currently selected value~~ in ~~the dropdown, onto the panel.~~
	# The hero drawing has a bunch of small icons that allow you to move and resize the drawing. Resize so the hero is near the middle of the screen, facing right, vertically filling the panel. (You can also edit values such as scale and position by clicking on the text on the right side. ~~For example, it may be easier to change facing by clicking facing on the right and selecting from the dropdown)~~
	~~# Under actorSlots, select "npc"~~ in the ~~dropdown, add the npc facing left at the right side of the panel. Select "nameTag" and choose "bottom right" to position their nametag.~~
	~~# Once the actors~~ are ~~positioned, click the small green "dialog balloon" icon on each actor to add some simple text, For the npc, write "Hail travelers! Will you help our village?"~~. ~~For the hero, write "Of course we will help".~~
	~~# Your screen~~ should ~~now~~ look ~~pretty close~~ to this:
	[[File:~~ModdingEncounterFirstComicDone~~.PNG]]

			==Filling in the comic panels==
	==Seeing the effect in game==		==Seeing the effect in game==
	<ol><li>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.		<ol><li>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.