Wildermyth Wiki - User contributions [en]

Modding add equipment

2022-02-02T21:36:29Z

Ruarch: updating item format to remove outer [] since data format has changed.

This page walks through the process of adding a new item, a shield. 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.

==Getting started==
# 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; note that the directory is steam\steamapps\common\wildermyth\mods\user\<your mod name>. You will use this directory soon.
# Click the "save" button and then exit. Most of the work for this mod is done outside the in-game editor; the editor doesn't appear to support creating items yet.

==Modifying the files==
<ol>
<li>Using a file explorer, navigate to the game install directory: steam\steamapps\common\Wildermyth\assets. We need to copy (not move!) several files from there to your mod directory. For each file when it is mentioned below, create folders in your mod as needed and copy, and then modify. These files are program source code and proper syntax is very important.
<li>Add new aspects (effects). Copy and modify file data\aspects\items.json. This will contain the bonuses that your items give. You can search in the original file for ideas. For this project, delete all the text and paste the following lines. This adds two effects, +10 block and +1 armor.
<syntaxhighlight lang="json">
[
{
"id": "daveaShieldBlockBonus",
"stats": { "BLOCK": 10 }
},
{
"id": "daveaShieldArmorBonus",
"stats": { "ARMOR": 1 }
}
]</syntaxhighlight>

<li>'''It is very important to delete all the other lines in the file.''' Your declarations of these items will override what is in the original game files. This prevents the developers from fixing bugs! For example, suppose you leave behind the definition of an item; and the developers change that item to fix a bug or improve balancing. Your mod loads with higher priority than the game's original files. So your incorrect definition loads with higher priority than the developers' new and improved definition. Players using your mod will not see this bug fix, and it will be very confusing to debug!
<li>I also recommend that all the items and effects you add should start with a unique prefix. I have used "davea". This helps in keeping all your items together, filtering to find your items, and distinguishing items added by one mod versus another.
<li>Add the description for the aspects. Copy and modify file text\aspects\aspects.properties. Delete all the text and add these lines:
 <code>
<nowiki>#</nowiki>suppress inspection "UnusedProperty" for whole file
 daveaShieldBlockBonus.blurb=davea effect shield block blurb
 daveaShieldArmorBonus.blurb=davea effect shield armor blurb
</code>

<li>Add the new item. Copy and modify a file from data\items\ and name it "daveaShield1.json". You can search in the original files for ideas. For this project, delete all the text and paste the following lines. This adds a shield which uses an existing image from the game, but gives the new shield effects created above.
<syntaxhighlight lang="json">
{
"id": "daveaShield1",
"tier": 1,
"category": "offHand",
"slots": ["OFF_HAND"],
"ownerAspects": [
"daveaShield1",
"daveaShieldArmorBonus",
"daveaShieldBlockBonus"
],
"cost": ["1 ingot", "2 heartwood"],
"layers": [
{"name": "augment_shieldCaveA_tint1", "depth": 6100, "tint": "primary", "tintAmount": 1.0},
{"name": "augment_shieldCaveB_untinted", "depth": 6101}
]
}

</syntaxhighlight>
<li>Add the name and blurb for the item. Copy and modify file text\dynamic\dynamic.properties. Delete all the text and add these lines:
 <code>
<nowiki>#</nowiki>suppress inspection "UnusedProperty" for whole file
 item.daveaShield1=Davea's shield name
 itemSummary.daveaShield1=Davea's shield summary
</code>
</ol>

==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.
# Start a new one chapter story. Choose your mod in the mod picklist, and check "enable cheats". You don't need to select any of the sub-options under cheats for this project.
# When the game starts, click through the initial encounter to get to the first battle.
# Pick one of your characters, open the detail view, and click the gear tab. You will see a cheat menu that allows you to select any kind of item and add it. Select offhand, select your new item in the popup, and clock add item to add it. You will see the name at the top and the summary at the right. Try it out in combat!
[[File:ModdingItemPickMe.PNG]]

==Adding a user created image==
<ol>
<li>Now let's add a sword with a custom image. Copy and modify file figures\images\human\items\item_sword_night.png using your favorite photo editor. For example, I made a yellow version and named it item_sword_davea1.png.
<li>Add the following to your existing offHand.json. This is a copy of the definition of the nightshard sword with my image replaced. I don't know what the grip, etc fields mean but I suppose they relate the geometry of the sword to the geometry of the character's hand. The filename offHand.json doesn't matter, the game reads all the json files in your directory. It could be called "davea.json".
<syntaxhighlight lang="json">
{
"id": "daveaSword1",
"tier": 1,
"category": "sword",
"tracks": ["medium"],
"slots": ["MAIN_HAND"],
"aspects": ["weapon", "melee", "weaponDamage:7", "weaponWield:3", "weaponMaxRange:1.6", "swordAccuracyBonus|5"],
"ownerAspects": ["attackRange|0|1.6|melee", "weaponAttack_basicMelee", "voiceSword", "swordBlockBonus|10"],
"layers": [
{
"name": "item_sword_davea1",
"grip": "mainHand",
"inactiveGrip": "highBack",
"rigUsage": "rigGeneral",
"gripOffset": {"x": 57, "y": 147},
"scaleX": 0.5, "scaleY": 0.5
}
],
"canBeCrafted": false,
"generateName": false,
"onlySpawnById": true
}
</syntaxhighlight>
<li>Proper json syntax is important. If you have put this into the same file as the previous definition of the shield, you will need a comma in between the definitions, but no comma after the last definition. This is easier if you are using a text editor with language highlighting. I have not yet experimented with files having incorrect syntax, but it will probably result in the mod failing to load, possibly preventing the game from even starting.
<li>Add the name text into your existing file text\dynamic\dynamic.properties:
 <code>
item.daveaSword1=Davea's sword name
 itemSummary.daveaSword1=Davea's sword summary
</code>
<li>Test in-game as shown above.
</ol>
[[File:ModdingItemYellowSword.PNG]]

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

The Starseed Tree

2021-03-23T13:00:15Z

Ruarch:

{{Infobox event
| event = The Starseed Tree
| image = Thestarseedtree1.png
| author = Douglas Austin
| type = Arrive at hostile site
}}

The heroes encounter a tree upon which stars grow.

== Choices ==

''1. Pluck the little light within arm's reach.''
:{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
| Outcome
|-
| Gain the [[Starseed Ring]].
|}

''2. Climb to a nice-looking one in the middle.''
:{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
| Outcome
|-
| '''Success''': The mystic gains '''+3 stunt chance''' and gains a tier 2 [[Starseed Wand]]. '''Failure''': The mystic takes 5 damage (to a minimum of 4 hp) and gains '''+1 stunt chance'''.
|}

''3. Attempt to climb to the top.''
:{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
| Outcome
|-
| '''Success''': The mystic gains '''+6 stunt chance''' and gains a tier 3 [[Starseed Staff]]. '''Failure''': The mystic takes 8 damage (to a minimum of 1 hp) and gains '''+1 stunt chance'''.
|}
== Trivia ==

This event will not trigger if anyone in the party is [[celestial]].

[[Category:Event]]

2019-11-26T22:59:05Z

Ruarch: Adding links to resources for new players to the main page under a "learning" header

Wildermyth Official Wiki

[[File:WildermythWide 2400x775.jpg|700px]]

Wildermyth is a [[character]]-driven randomly generated tactical role-playing game.

You, the [[player]], develop [[hero]]es as the game progresses, by scouting the overland map, fighting any lurking threats, defending and improving the area over time, and taking part in quest opportunities that arise. Building [[Build_a_Bridge|bridges]] and passes opens up navigation across rivers and mountain ranges.

Collected resources can be used to craft better tiers of equipment. Leveling up your heroes offers you a choice of new random abilities. Your enemies also grow in strength through calamities that occur as time advances.

[[Legacy point]]s that you accrue can be used to recruit new heroes to your company, build new [[station]]s, dispel calamities, or avert enemy incursions.

Completing a campaign lets you use those legendary heroes in future campaigns as part of your [[legacy]].

The game is developed by [http://worldwalkergames.com/ Worldwalker Games LLC], and is currently in Early Access [[beta]]. This wiki is for players and developers. Please improve it! No need to ask permission, you just need to create an account (because spammers, otherwise).

=Learning=
* [[Guides]]
* [[Combat]]
* [[Overland Map]]
* [[Intervals]]
* [[Lore]]

=Support=
* [[Technical Difficulties]]
* [[Transfer your Legacy]]

=Developer, Storyteller, and Modder Resources=
* [[Writer's Guide]]: Want to write for the game? Here's what you need.
* [[Modding Guide]]: All about how to Mod Wildermyth.
* [[Effects]]: Used to create [[Event|events]], player actions, and oh so much more. A technical guide.
* [[Testing]] the game.

Technical Difficulties

2019-11-24T15:56:05Z

Ruarch: /* Game Won't Launch at All */

Comic Editor Reference

2019-11-18T19:37:34Z

Ruarch: removing outdated references to panel tags

This is a collection of reference material that explains how to use the Comic Editor to tell stories.

=Make a New Event=
* Open up [[Scratchpad]]
* go to the Content and Comics Editor
* Click on the [[Effects]] tab at the top or press Control+2
* Click the '''New...''' Button or press Control+N

[[File:ComicEditorNewEvent.png]]

* Select the [[Event Types|type of event]] you are creating, for example ''Arrive at Hostile Site'' or ''Mission Victory''.
* Enter your name if it's not there already. (The game remembers who wrote each event, and we may make this info visible to players. If you don't want to be associated with your events, or a particular one, we can work that out.)
* Enter a for the event name (in plain english, with spaces) for the event. The tool will create an ID and Filename automatically.
* Edit the id and filename if you want.
* Press '''Create'''!

Event is now exist! Maybe save?

=Codestuff=
Read this first: [[Story Inputs and Outputs]]

'''General Advice:''' Use the STUB fields to document intent, and leave notes about what SHOULD happen, especially if you don't know how to do something. It's totally fine to STUB out complicated effects or fiddly details that you're not sure how to handle. That's what programmers are ''for'' after all, right?

You ''CAN'' edit all this stuff, if you want to, but it's not necessarily recommended. If you're tempted, you can search for other effects that use the functionality you're interested in, and see if you can just do the same thing.

==Story Roles==
Now that you have an event, it's time to add targets for the important people, which is generally the heroes. The easy and right way to do this is to press the '''New Story Role''' button, which can be found on the same row as the '''targets''' header. You will need to mouse-over '''targets''' and the buttons will show up on the right. The ''New Story Role Dialog'' will pop up:

[[File:ComicEditorNewStoryRoleDialog1.png|holy moly]]

There's a lot here, but let's just look at the first dropdown box. Expand that down and you'll get a list of possible ''roles'' for this new target. The easiest and most common thing to do is to pick a personality stat, like greedy. This will automatically populate the dialog so that the greediest hero will be picked for this role, which is almost what you want, right?

[[File:ComicEditorNewStoryRoleDialog2.png|it will all makes sense some day]]

But the point of all this mess is to help you select the most appropriate hero for a particular story role. In the end it all boils down to a Score Function, which you can see by playing around with the controls and seeing how it changes.

A few other notes:
* If a '''Required Role''' is not present, the story won't happen. This is usually what you want. This way you can be sure that if the story is being told at all, the right characters are in place. Sometimes you have a role that's not too important, and you can make it optional.
* '''The Not Already Matched As''' checkbox is actually disabled if this is your first story role, but for number two and on, it makes sure that this person isn't the same person you selected for a previous role, because then it might seem like they were arguing with themselves, which is only ''sometimes'' what you want.
* Remember, targets are selected in order, and by the time you get to number three or four, it's unlikely that the Romantic is really an iconic romantic, so put your most important/iconic/identifiable roles first.

Create as many roles as you need. Usually that means one per speaking role, and remember there are never more than 5 heroes in a party, but there can be more than that in the company. So, it depends what kind of story you're telling.

==Other Targets==
In addition to Story Roles, you can create other targets. One useful template is LEGEND, which allows you to pick NPCs that have been generated at the start of the game, and/or maybe if we get around to it, pulled from the player's [[legacy]]. Use the legendId field to specify who you want.

TODO explain more.

==Choices==
Some events call for choices. In this case, there's generally a prompt, which is a set of comic panels, and then a choice, which is several panels, some of which might only be present under certain circumstances. Anyway to add a choice, do this:
# expand '''targets'''->'''choiceTarget...'''
# See '''options''' right after "prompt".
# Click on the '''New Option''' button
[[File:ComicEditorNewOptionsButton.png]]
# to bring up the ''New Option Dialog''
[[File:ComicEditorNewChoiceDialog1.png|Yeah this thing makes sense, right?]]

This lets you pick a tag (which is not too important except that the outcome will use the same tag). Then you can pick who will be speaking, and you can make the choice optional, so that if that character is not present, the choice won't show. Then you can choose if you want to add any branching, like a dice roll with a chance of multiple outcomes. Most commonly you will pick "simple" or "event roll."

TODO more explain.

==[[Outcomes]]==
Specify what should happen as a result of choices, or chance.

Details on how to do this can be found on the [[Outcomes]] page.

Use the STUB field as a place to write down what should happen without touching the code.

We need to add more functionality here, like, probably a lot. For now it is STUB City.

=Comic Editor Basics=

'''TODO rewrite this!!! panel tags and text splits don't exist anymore!! Document new Editor, Add Panel (Compose), and Split stuff.'''

* Each box on the left holds text for a different section of the story: a prompt, a choice, or an outcome.
* Plain text (none of those Microsoft Word special apostrophes and ellipses if you please...)
* Press the save button!
* Undo should work, but sometimes need to press it more than once.

==Making Panels==

Use '''<panel>''' tags to separate text into panels. It's pretty easy to specify panel sizes and add actors with facial expressions and basic functionality.
<pre><panel>Use panel tags to separate text.
<panel|bookish>if there's an actor, they will speak the line.
<panel|poet thinking>Or maybe you want them to think it instead.
<panel|goofball joke>Or make a funny face!
<panel sixth left|bookish grim size:1.75>
<panel half left|snark sad >Nobody actually likes your face.</pre>

[[File:ComicTool example1.png]]

Everything about a panel is stored as text, in the panel tag. These examples show how to use [[panel styles]] (left, sixth, half), how to add actors ( |rolename ), and how to add [[actor styles]] (thinking, joke, grim). Panel styles are convenient for quickly making panels, but panel tags can get cumbersome fast. Good thing is, we have a visual editor so you don't need to edit all this stuff by hand.

To open up the [[Panel Editor]], click on a panel in the Comic Editor display. You can use the visual panel editor to do almost everything, including adding actors, setting their facial expressions, really everything except creating new panels and modifying the text that goes in them.

:''Protip: Panel tags can be copied and pasted around as a quick way to duplicate a scene.''
==Using Tags to Control Text==

See : [[Tag Reference]]

Each event can specify a number of targets, which are often heroes, selected for a particular personality, relationship, etc.. These targets are assigned to [[Story Role|roles]]. Roles are easy-to-remember words like ''leader'', ''target'', ''hero'', ''hothead'', ''friend'', etc..

Once you have a target assigned to the role, you can insert the target into your text using a ''role tag'' like this.

<pre><leader> takes a long, appraising look at <hothead>.
<leader.mf:He/She> wipes a fleck of bluish ooze off <leader.mf:his/her> nose.</pre>
[[File:ComicEditor simpleTags1.png]]

This is a simple example but we can get a lot more sophisticated, and tags can be nested as well. The status bar at the bottom will tell you where the cursor is within a tag or nested tag. It's super handy for complex splits!

One of the key uses of tags is to give heroes different lines depending on their personalities. This works by embedding the stats you care about in the tag.
<pre><leader.goofball/bookish:
Surprise everyone! It's fightin' time!
/Ahem. Our foes appear to have arrived.></pre>
[[File:ComicEditor personalityTags.png]]

Tags can do a lot more! For a full list of available tags see : [[Tag Reference]].

==Style Markup==
See: [[Text Styles]]

Text in a comic panel gets a style automatically depending on if the TextBox is set up as narration, speech, thought, etc.. The Style can be modified using square brackets. Generally, text-style markup is similar to html markup, in that you have a starting and ending tag, BUT! our style format doesn't require the end tag to have anything in it.

It looks like this:
[bold]'''bold text''' [italic]'''''Bold italic text'''''[]'''bold again'''[] regular again.

'''TODO add some pictures of styled text here'''

You can set the size, color, and font of the text. See Main article on [[Text Styles]] for a full list of available fonts, styles, and colors.

==Tweaking Faces==
See: [[Face Tags]]

[face:sad]
[hero.face:dubious]
[loner.face:talking]

Sets the facial expression from text, overriding what the tool says. This is useful inside text splits, so you can tweak a panel without having to build a whole panel split.

==Other Details==
TODO document all the buttons!

2018-08-07T00:32:19Z

Ruarch:

There are a number of dev tools that make it easier to test the game. One of the challenges in a randomly generated game is that you need to be able to access the content in order to test it, and if it is surfaced randomly, that might be hard.

*enable dev mode by adding devMode.txt to your install folder.
*enable cheats when you start a new game.
*objective cheats allow you to skip large sections, but might be bug prone.
*See All and Overland Only are powerful
*Pick Events allows you to choose which (random?) events you get in each situation where a random event is selected. It can slow down play, but it's the best way to test particular events, e.g. when you are working on them.

Testing

2018-08-07T00:32:11Z

Ruarch:

Hero

2017-10-16T13:17:19Z

Ruarch: Created page with "Heroes are the . . . uh, heroes . . . of the game. Each hero has a personality, develops augments over time, and carries equipment. Heroes travel in a party...."

Heroes are the . . . uh, heroes . . . of the game. Each hero has a [[personality]], develops [[augments]] over time, and carries [[equipment]].

Heroes travel in a [[party]]. The party starts as a [[bunch of farmers]] and every hero develops over time. A farmer can become a [warrior], a [hunter], or a [mystic].

Main Page

2017-10-16T12:58:10Z

Ruarch: Wildermyth description

Wildermyth Official Wiki

Wildermyth is a character-based [[hero]]-development tactical role-playing game.