Data Format Overview - Revision history

Pbelanger: Adjusted Scenarios descriptions

2021-10-12T17:26:28Z

Adjusted Scenarios descriptions

← Older revision		Revision as of 17:26, 12 October 2021
Line 7:		Line 7:
	* '''[[Aspect]]s''' describe what an entity (hero, site, scenery, etc.) is and can do. Aspects can contain '''effects''' and '''stats'''.		* '''[[Aspect]]s''' describe what an entity (hero, site, scenery, etc.) is and can do. Aspects can contain '''effects''' and '''stats'''.
	* '''[[History]]''' stores "permanent" changes to an entity. This can include a text description, is used to permanently add or removes aspects (and therefore abilities and stats).		* '''[[History]]''' stores "permanent" changes to an entity. This can include a text description, is used to permanently add or removes aspects (and therefore abilities and stats).
	* '''[[Scenario]]s''' are ~~used to test out missions~~ from the menu ~~(via Tools > New Battle) without needing to start a full campaign~~.		* '''[[Scenario]]s''' are how Campaigns or standalone Missions are started from the main menu.
	* '''[[Plot]]s''' control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!		* '''[[Plot]]s''' control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!

Line 45:		Line 45:

	==Scenarios==		==Scenarios==
	[[Scenario]]s are used to test out missions from the menu (via Tools > New Battle) without needing to start a full campaign.		[[Scenario]]s are how Campaigns or standalone Missions are started from the main menu. '''Campaign''' scenarios are the main scenarios players will use, accessed from the New Game button. '''Mission''' scenarios are used to test out missions from the menu (via Tools > New Battle) without needing to start a full campaign, and are generally more for developer use, though players can also access them.

	==Plots==		==Plots==

Ruarch at 16:03, 4 February 2020

2020-02-04T16:03:14Z

← Older revision		Revision as of 16:03, 4 February 2020
Line 6:		Line 6:
	* '''[[Outcomes]]''' make things happen in the game. They are generally triggered by '''effects'''.		* '''[[Outcomes]]''' make things happen in the game. They are generally triggered by '''effects'''.
	* '''[[Aspect]]s''' describe what an entity (hero, site, scenery, etc.) is and can do. Aspects can contain '''effects''' and '''stats'''.		* '''[[Aspect]]s''' describe what an entity (hero, site, scenery, etc.) is and can do. Aspects can contain '''effects''' and '''stats'''.
	* '''[[History]]''' stores "permanent" changes to an entity. This can be a text description, ~~and can also include '''required~~ or ~~forbidden~~ aspects~~'''~~.		* '''[[History]]''' stores "permanent" changes to an entity. This can include a text description, is used to permanently add or removes aspects (and therefore abilities and stats).
	* '''[[Scenario]]s''' are used to test out missions from the menu (via Tools > New Battle) without needing to start a full campaign.		* '''[[Scenario]]s''' are used to test out missions from the menu (via Tools > New Battle) without needing to start a full campaign.
	* '''[[Plot]]s''' control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!		* '''[[Plot]]s''' control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!

Pbelanger: /* History */ Fixed broken AddHistory Outcome link

2019-12-13T21:38:50Z

History: Fixed broken AddHistory Outcome link

← Older revision		Revision as of 21:38, 13 December 2019
Line 42:		Line 42:
	[[Hero]] History is generated at the start of the game with three lines: an Origin, and Anecdote, and a Motivation. These affect prime stats and personality stats, and also seed Hooks. History lines leave behind a number of Hooks, which are more specific character aspects and often take the form of a personality flaw or quirk.		[[Hero]] History is generated at the start of the game with three lines: an Origin, and Anecdote, and a Motivation. These affect prime stats and personality stats, and also seed Hooks. History lines leave behind a number of Hooks, which are more specific character aspects and often take the form of a personality flaw or quirk.

	During the campaign, history can be added to heroes using the [[~~Outcome~~#AddHistory\|AddHistory Outcome]]. These added history lines can just be some text that details what happened in a certain event ''(ex: encounter_heroesArriveAtSite_heroWorship adds history to the new recruit mentioning that it was the recruit's dream to join the company)'', or can also include '''required or forbidden aspects''' ''(ex: encounter_heroesArriveAtSite_fireball adds history with the associated '''aspect''' mysticSpecial_improvisedFireball, an aspect which has the '''effect''' mystic_improvisedFireball attached to it, thus allowing the mystic to use that ability in combat)''.		During the campaign, history can be added to heroes using the [[Outcomes#AddHistory\|AddHistory Outcome]]. These added history lines can just be some text that details what happened in a certain event ''(ex: encounter_heroesArriveAtSite_heroWorship adds history to the new recruit mentioning that it was the recruit's dream to join the company)'', or can also include '''required or forbidden aspects''' ''(ex: encounter_heroesArriveAtSite_fireball adds history with the associated '''aspect''' mysticSpecial_improvisedFireball, an aspect which has the '''effect''' mystic_improvisedFireball attached to it, thus allowing the mystic to use that ability in combat)''.

	==Scenarios==		==Scenarios==

Pbelanger: Added Outcomes section

2019-12-11T21:22:28Z

Added Outcomes section

← Older revision		Revision as of 21:22, 11 December 2019
Line 3:		Line 3:
	==Overview==		==Overview==
	Here are all the pieces listed below and how they fit together, in as short terms as possible:		Here are all the pieces listed below and how they fit together, in as short terms as possible:
	* '''[[Effects]]''' are how things (events, abilities, etc.) happen.		* '''[[Effects]]''' are how things (events, abilities, etc.) happen, based on checking if certain criteria (targets) are met and then executing '''outcomes'''.
			* '''[[Outcomes]]''' make things happen in the game. They are generally triggered by '''effects'''.
	* '''[[Aspect]]s''' describe what an entity (hero, site, scenery, etc.) is and can do. Aspects can contain '''effects''' and '''stats'''.		* '''[[Aspect]]s''' describe what an entity (hero, site, scenery, etc.) is and can do. Aspects can contain '''effects''' and '''stats'''.
	* '''[[History]]''' stores "permanent" changes to an entity. This can be a text description, and can also include '''required or forbidden aspects'''.		* '''[[History]]''' stores "permanent" changes to an entity. This can be a text description, and can also include '''required or forbidden aspects'''.
Line 23:		Line 24:
	===Tidings===		===Tidings===
	[[Tidings]] are events that happen during the [[Interval]] after a chapter that show what heroes did during the years of peace. These are generally just comic stories, though they can also have other Outcomes (like granting resources) if desired. These are separated into several different categories, listed on the [[Tidings]] page (along with a guide on how to make one).		[[Tidings]] are events that happen during the [[Interval]] after a chapter that show what heroes did during the years of peace. These are generally just comic stories, though they can also have other Outcomes (like granting resources) if desired. These are separated into several different categories, listed on the [[Tidings]] page (along with a guide on how to make one).

			==Outcomes==
			[[Outcomes]] are things that happen! Generally, you'll be seeing these in the context of [[Effects]]. Outcomes can make a lot of things happen, usually via '''events''' and '''abilities'''. Event Outcomes usually include things like granting resources or relationship points, applying a [[Theme]] or [[Aspect]] to a hero, starting a [[Mission]], or causing another event to happen. Ability Outcomes generally include things like making an attack roll, dealing damage, moving, adjusting stats in some way, or modifying scenery on the map.

	==Aspects==		==Aspects==

Pbelanger: Added to Modding and Modding Reference categories

2019-12-11T20:37:45Z

Added to Modding and Modding Reference categories

← Older revision		Revision as of 20:37, 11 December 2019
Line 45:		Line 45:
	==Plots==		==Plots==
	[[Plot]]s control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!		[[Plot]]s control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!


			[[Category:Modding]]
			[[Category:Modding Reference]]

Pbelanger: /* Tidings */ Removed info on tiding types (that's in the Tidings page, and isn't super relevant for a brief overview)

2019-12-11T20:32:50Z

Tidings: Removed info on tiding types (that's in the Tidings page, and isn't super relevant for a brief overview)

← Older revision		Revision as of 20:32, 11 December 2019
Line 22:		Line 22:

	===Tidings===		===Tidings===
	[[Tidings]] are events that happen during the [[Interval]] after a chapter that show what heroes did during the years of peace. These are generally just comic stories, though they can also have other Outcomes (like granting resources) if desired. These are separated into several different categories, listed ~~below. (There are also some less-used categories, not listed here)~~		[[Tidings]] are events that happen during the [[Interval]] after a chapter that show what heroes did during the years of peace. These are generally just comic stories, though they can also have other Outcomes (like granting resources) if desired. These are separated into several different categories, listed on the [[Tidings]] page (along with a guide on how to make one).
	~~====Miscellaneous====~~
	~~(TIDING_MISC) Miscellaneous tidings that can generally happen to anyone~~
	~~====Followups====~~
	~~(FOLLOWUP_EVENT_OUTCOME) Tidings that have a specific followupId and are made possible via~~ the [[~~Outcomes#AllowFollowup\|AllowFollowup Outcome~~]]~~. These are often used~~ along with ~~events that should have some kind of repercussions. For example, an event that should only happen if~~ a ~~certain kind of station was built (see job_buildStation_forestShrine and how it can cause tiding_outcome_buildForestShrine1) or that follows up~~ on ~~an interesting event (see encounter_heroesArriveAtSite_asTheCrowFlies and~~ how ~~it can cause tiding_outcome_callOfTheCrow).~~
	~~====Retirement====~~
	~~(TIDING_RETIREMENT) Tidings that happen~~ to ~~retiring heroes.~~
	~~====Omens====~~
	~~(TIDING_YONDERING_OMENS) Tidings that show the return of threats to the lands. This is the final part of the interval between chapters, shown right before the new chapter starts.~~
	~~====Wrapup====~~
	~~(TIDING_WRAPUP~~) ~~Tidings that are shown during the credits~~. ~~Threats have been removed from the land, all is peaceful. (Miscellaneous and Followup tidings can also show up in the credits)~~

	==Aspects==		==Aspects==

Pbelanger: Added brief overview to top

2019-12-11T20:27:58Z

Added brief overview to top

← Older revision		Revision as of 20:27, 11 December 2019
Line 1:		Line 1:
	Wildermyth has a number of different types of moddable data (all stored as json files) that work together to make things happen in the game. This overview is intended to give a broad understanding of the different pieces you can edit (mainly by using the Content and Comics Editor) and how they fit together.		Wildermyth has a number of different types of moddable data (all stored as json files) that work together to make things happen in the game. This overview is intended to give a broad understanding of the different pieces you can edit (mainly by using the Content and Comics Editor) and how they fit together.

			==Overview==
			Here are all the pieces listed below and how they fit together, in as short terms as possible:
			* '''[[Effects]]''' are how things (events, abilities, etc.) happen.
			* '''[[Aspect]]s''' describe what an entity (hero, site, scenery, etc.) is and can do. Aspects can contain '''effects''' and '''stats'''.
			* '''[[History]]''' stores "permanent" changes to an entity. This can be a text description, and can also include '''required or forbidden aspects'''.
			* '''[[Scenario]]s''' are used to test out missions from the menu (via Tools > New Battle) without needing to start a full campaign.
			* '''[[Plot]]s''' control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!

	==Effects==		==Effects==

Pbelanger: /* Plots */ Added "or missions"

2019-12-11T20:15:59Z

Plots: Added "or missions"

← Older revision		Revision as of 20:15, 11 December 2019
Line 46:		Line 46:

	==Plots==		==Plots==
	[[Plot]]s control the steps and goals of campaigns; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!		[[Plot]]s control the steps and goals of campaigns or missions; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!

Pbelanger: Added information about History, Scenarios, and Plots

2019-12-11T20:12:01Z

Added information about History, Scenarios, and Plots

← Older revision		Revision as of 20:12, 11 December 2019
Line 2:		Line 2:

	==Effects==		==Effects==
	[[Effects]] are how things happen. An effect represents a trigger or ability that can have multiple targets and multiple outcomes. If all targets are present, the ability is valid and the outcomes are executed.		[[Effects]] are how things happen. An effect represents a trigger or ability that can have multiple targets and multiple outcomes. If all targets are present, the ability is valid and the outcomes are executed. Effects (especially abilities) are sometimes attached to entities via '''aspects'''.

	The main kinds of effects are:		The main kinds of effects are:
Line 10:		Line 10:
	===Abilities===		===Abilities===
	[[Ability\|Abilities]] are things heroes and monsters can choose to do during missions. This includes everything from moving, to attacking, to interfusing. All abilities use the special "ABILITY" type. They all have '''[[Outcomes]]''' that determine what the ability does, which generally includes things like making an attack roll, dealing damage, moving, adjusting stats in some way, or modifying scenery on the map. These generally don't include comic panels, though there are exceptions (see callDownVolleyOfArrows).		[[Ability\|Abilities]] are things heroes and monsters can choose to do during missions. This includes everything from moving, to attacking, to interfusing. All abilities use the special "ABILITY" type. They all have '''[[Outcomes]]''' that determine what the ability does, which generally includes things like making an attack roll, dealing damage, moving, adjusting stats in some way, or modifying scenery on the map. These generally don't include comic panels, though there are exceptions (see callDownVolleyOfArrows).

			Abilities are attached to entities via '''aspects'''. For example, if you look at the "human" aspect, you'll notice it has all the standard abilities humans have: run, openDoor, waitEndTurn, etc.

	===Tidings===		===Tidings===
	Tidings are events that happen during the [[Interval]] after a chapter that show what heroes did during the years of peace. These are generally just comic stories, though they can also have other Outcomes (like granting resources) if desired. These are separated into several different categories, listed below. (There are also some less-used categories, not listed here)		[[Tidings]] are events that happen during the [[Interval]] after a chapter that show what heroes did during the years of peace. These are generally just comic stories, though they can also have other Outcomes (like granting resources) if desired. These are separated into several different categories, listed below. (There are also some less-used categories, not listed here)
	====Miscellaneous====		====Miscellaneous====
	(TIDING_MISC) Miscellaneous tidings that can generally happen to anyone		(TIDING_MISC) Miscellaneous tidings that can generally happen to anyone
Line 22:		Line 24:
	(TIDING_YONDERING_OMENS) Tidings that show the return of threats to the lands. This is the final part of the interval between chapters, shown right before the new chapter starts.		(TIDING_YONDERING_OMENS) Tidings that show the return of threats to the lands. This is the final part of the interval between chapters, shown right before the new chapter starts.
	====Wrapup====		====Wrapup====
	(TIDING_WRAPUP) Tidings that are shown during the credits. Threats have been removed from the land, all is peaceful. (Miscellaneous~~, Followups,~~ and		(TIDING_WRAPUP) Tidings that are shown during the credits. Threats have been removed from the land, all is peaceful. (Miscellaneous and Followup tidings can also show up in the credits)

	==Aspects==		==Aspects==
Line 34:		Line 36:

	==History==		==History==
			[[History]], also called a History Line, is a line of player-facing text that tells a story about the [[entity]] it’s pinned to. This is generally the way that more "permanent" changes to an entity are made, like '''[[Theme]]s''' or '''permanent aspects'''. History coincides with [[aspect]]s, [[stat]]-increases, and [[hook]]s. Some is generated upon initialization, some is recorded in recognition of game-occurrences.

			[[Hero]] History is generated at the start of the game with three lines: an Origin, and Anecdote, and a Motivation. These affect prime stats and personality stats, and also seed Hooks. History lines leave behind a number of Hooks, which are more specific character aspects and often take the form of a personality flaw or quirk.

			During the campaign, history can be added to heroes using the [[Outcome#AddHistory\|AddHistory Outcome]]. These added history lines can just be some text that details what happened in a certain event ''(ex: encounter_heroesArriveAtSite_heroWorship adds history to the new recruit mentioning that it was the recruit's dream to join the company)'', or can also include '''required or forbidden aspects''' ''(ex: encounter_heroesArriveAtSite_fireball adds history with the associated '''aspect''' mysticSpecial_improvisedFireball, an aspect which has the '''effect''' mystic_improvisedFireball attached to it, thus allowing the mystic to use that ability in combat)''.

	==Scenarios==		==Scenarios==
			[[Scenario]]s are used to test out missions from the menu (via Tools > New Battle) without needing to start a full campaign.

	==Plots==		==Plots==
			[[Plot]]s control the steps and goals of campaigns; they determine what special plot events should happen, the goals of chapters, special missions and their goals, and more!

Pbelanger: Started working on Data Format Overview

2019-12-11T18:19:10Z

Started working on Data Format Overview

New page

Wildermyth has a number of different types of moddable data (all stored as json files) that work together to make things happen in the game. This overview is intended to give a broad understanding of the different pieces you can edit (mainly by using the Content and Comics Editor) and how they fit together.

==Effects==
[[Effects]] are how things happen. An effect represents a trigger or ability that can have multiple targets and multiple outcomes. If all targets are present, the ability is valid and the outcomes are executed.

The main kinds of effects are:
===Events===
[[Event Types|Events]] are encounters or stories that happen due to specific in-game triggers. These triggers include things like arriving at a hostile site (ENCOUNTER_HEROES_ARRIVE_HOSTILE_SITE), winning a mission (ENCOUNTER_MISSION_VICTORY), or a specific plot event (PLOT_ARRIVE). Events are generally used to tell a story of some kind, and thus are almost always accompanied by '''comics'''. Most of the work in creating comics can be done in the [[Comic Editor Reference|Comic Editor]]. Events also often make '''[[Outcomes]]''' happen, which can mean things like granting resources or relationship points, applying a [[Theme]] or [[Aspect]] to a hero, starting a [[Mission]], causing another event to happen, or a lot of other things.

===Abilities===
[[Ability|Abilities]] are things heroes and monsters can choose to do during missions. This includes everything from moving, to attacking, to interfusing. All abilities use the special "ABILITY" type. They all have '''[[Outcomes]]''' that determine what the ability does, which generally includes things like making an attack roll, dealing damage, moving, adjusting stats in some way, or modifying scenery on the map. These generally don't include comic panels, though there are exceptions (see callDownVolleyOfArrows).

===Tidings===
Tidings are events that happen during the [[Interval]] after a chapter that show what heroes did during the years of peace. These are generally just comic stories, though they can also have other Outcomes (like granting resources) if desired. These are separated into several different categories, listed below. (There are also some less-used categories, not listed here)
====Miscellaneous====
(TIDING_MISC) Miscellaneous tidings that can generally happen to anyone
====Followups====
(FOLLOWUP_EVENT_OUTCOME) Tidings that have a specific followupId and are made possible via the [[Outcomes#AllowFollowup|AllowFollowup Outcome]]. These are often used along with events that should have some kind of repercussions. For example, an event that should only happen if a certain kind of station was built (see job_buildStation_forestShrine and how it can cause tiding_outcome_buildForestShrine1) or that follows up on an interesting event (see encounter_heroesArriveAtSite_asTheCrowFlies and how it can cause tiding_outcome_callOfTheCrow).
====Retirement====
(TIDING_RETIREMENT) Tidings that happen to retiring heroes.
====Omens====
(TIDING_YONDERING_OMENS) Tidings that show the return of threats to the lands. This is the final part of the interval between chapters, shown right before the new chapter starts.
====Wrapup====
(TIDING_WRAPUP) Tidings that are shown during the credits. Threats have been removed from the land, all is peaceful. (Miscellaneous, Followups, and

==Aspects==
[[Aspect|Aspects]] are named markers tied to [[entity|entities]], usually reflecting their narrative state, that '''add stats''' or '''apply specific effects'''.

For [[hero]]es, aspects are just facts about the hero. Stuff like "human", "female", "attractedToMen", "hunter", "missingLeftArm". Aspects can carry stat modifiers and Effects. Aspects are the workhorse of the dynamic content in the game, almost everything you need to know about a hero, site, anything really, can be accessed as an aspect (other than stat values). Aspects can be queried to find out almost things about an entity (other than [[history]], but that applies aspects that can be queried).

Aspects can be temporary, like status effects (poisoned) or combat modifiers (combatModifier_buff_courage), or more permanent, like theme pieces (themePiece_fire_leftArm) or class upgrade abilities (hunterDeck_quellingmoss).

A special subcategory of aspects is [[hook]]s, which are usually designated when a hero is first generated, and are used to trigger hook quests.

==History==

==Scenarios==

==Plots==