Difference between revisions of "Modding encounter choice"

From Wildermyth Wiki
(Created page with "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 det...")
 
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.

Revision as of 16:03, 1 December 2019

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.

Prerequisite encounter

  1. 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 Adding a wilderness encounter
  2. Select "Tools" at the main game screen, then "Open Editor", then "Content and Comics Editor"
  3. At the upper left, click "Mods", click "Create New Mod" in the browser, and fill in the form.
  4. 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.
  5. On the targets line, add the default "hero" story role and a second story role "volunteer"
  6. This is the most common mistake, causing a mod to not work! New events are disabled by default. Under abilities, set encounterEnabled to true

Adding the choice in the effect

  1. 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.

ModdingChoiceEffect.PNG

Filling in the comic panels

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. 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. ModdingEncounterNewStoryDebug.PNG
  3. 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.
  4. 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": ModdingEncounterPickMe.PNG
Retrieved from "http://wildermyth.com/w/index.php?title=Modding_encounter_choice&oldid=13458"