Comic Editor Reference - Revision history

Pbelanger: /* Testing Options */ Updated options

2022-03-08T21:06:09Z

Testing Options: Updated options

← Older revision		Revision as of 21:06, 8 March 2022
Line 130:		Line 130:
	Many of these are only useful once you've added tags and dynamic text to your event (which we'll go over in the next section), but it feels correct to talk about it here first, so when you ''do'' start using tags, you'll know how to test that they're working.		Many of these are only useful once you've added tags and dynamic text to your event (which we'll go over in the next section), but it feels correct to talk about it here first, so when you ''do'' start using tags, you'll know how to test that they're working.

	* The comic editor is set to '''Scroll''' view by default, but you can change it to '''~~Clickthrough~~''' to see a more accurate representation of what your comic will look like in-game, including panels animating in.		* The comic editor is set to '''Scroll''' view by default, but you can change it to '''Click''' to see a more accurate representation of what your comic will look like in-game, including panels animating in.
	* '''Reroll''' will reroll all of the "fake" heroes it's matching with your targets, allowing you to see what it will look like if the player gets your event with a variety of heroes or at different sites. Note that by default, these fake heroes won't actually match the target requirements you've set for them; that will only happen in-game.		* '''Reroll''' will reroll all of the "fake" heroes it's matching with your targets, allowing you to see what it will look like if the player gets your event with a variety of heroes or at different sites. Note that by default, these fake heroes won't actually match the target requirements you've set for them; that will only happen in-game.
	* '''Settings...''' will bring up some options for testing all of the roles. You can choose whether or not to show optional roles, make roles always show up as a certain class, and give roles specific aspects. (Some of this can also be done with the inspect button, but those won't persist across multiple rerolls)		* '''Settings...''' will bring up some options for testing all of the roles. You can choose whether or not to show optional roles, make roles always show up as a certain class, and give roles specific aspects. (Some of this can also be done with the inspect button, but those won't persist across multiple rerolls)
	* '''Find''' can be used to search for words in the event. It's not a testing feature, but this was a sensible place for it.		* '''Find''' can be used to search for words in the event. It's not a testing feature, but this was a sensible place for it.
	* '''+RP''' will grant relationship points between all of the heroes. Useful for testing events that have differences based on relationship tiers.		* '''+RP''' will grant relationship points between all of the heroes. Useful for testing events that have differences based on relationship tiers.
	* '''~~friends~~/~~lovers~~/~~rivals~~/~~family~~''' will make everyone in the event friends/lovers/rivals/some kind of family. Useful for testing events with differences based on relationship or family types.		* ''':) / <3 / >:( / Fam''' will make everyone in the event friends/lovers/rivals/some kind of family. Useful for testing events with differences based on relationship or family types.
	* '''~~inspect~~''' will allow you to directly edit any of the "fake" matches for targets via their character sheets (as long as you have [[Testing\|devMode]] on), which can help you test specific scenarios.		* '''Inspect''' will allow you to directly edit any of the "fake" matches for targets via their character sheets (as long as you have [[Testing\|devMode]] on), which can help you test specific scenarios.
			* '''Auto-Match''': When enabled, the game will try to adjust comic hero aspects, personality, relationships, etc based on what splits your cursor is positioned within in the text editor, so the comic is more likely to show the text you're on without needing to manually adjust heroes. ''(Note that this may not work for every scenario, and sometimes you'll need to use Inspect or Settings... instead.)''

	===Dev Mode===		===Dev Mode===

Pbelanger: /* Choices */ Fixed bad image positioning (added newline)

2022-03-08T20:49:23Z

Choices: Fixed bad image positioning (added newline)

← Older revision		Revision as of 20:49, 8 March 2022
Line 71:		Line 71:
	===Choices===		===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. To add a choice, click the '''New Choice''' button		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. To add a choice, click the '''New Choice''' button

	[[File:ComicEditorNewChoiceDialog1.png]]		[[File:ComicEditorNewChoiceDialog1.png]]

Pbelanger: /* Testing your Event In-Game */ Fixed style issue

2021-01-24T21:31:37Z

Testing your Event In-Game: Fixed style issue

← Older revision		Revision as of 21:31, 24 January 2021
Line 222:		Line 222:

	==Testing your Event In-Game==		==Testing your Event In-Game==
	Great! You've made an event, and now you're ready to see it in action. The first thing you need to do is '''Enable it'', which you can do by pressing the '''Event Disabled''' button underneath the targets in the comics panel.		Great! You've made an event, and now you're ready to see it in action. The first thing you need to do is '''Enable it''', which you can do by pressing the '''Event Disabled''' button underneath the targets in the comics panel.

	There are a couple other things on the Effects tab you may want to change before testing. If you expand the '''ability''' line, cooldown, encounterScore, and encounterWeight may be useful.		There are a couple other things on the Effects tab you may want to change before testing. If you expand the '''ability''' line, cooldown, encounterScore, and encounterWeight may be useful.

Pbelanger: Added more sections about using comic tools and testing events

2021-01-21T02:28:56Z

Added more sections about using comic tools and testing events

← Older revision		Revision as of 02:28, 21 January 2021
Line 93:		Line 93:

	The little black boxes with '+' and '-' symbols can be used to expand/collapse more information about the actors and text. If you expand a target actor, you'll see that there are options for which role is being displayed, what direction they're facing, whether or not to show their weapons, their position, and more! Most of the time, you'll want to change position, rotation, and scale of actors and textboxes using the icons that appear around the images rather than adjusting the values manually.		The little black boxes with '+' and '-' symbols can be used to expand/collapse more information about the actors and text. If you expand a target actor, you'll see that there are options for which role is being displayed, what direction they're facing, whether or not to show their weapons, their position, and more! Most of the time, you'll want to change position, rotation, and scale of actors and textboxes using the icons that appear around the images rather than adjusting the values manually.

			==Adjusting Actors==
			Once you have some actors on a panel ("actor" meaning any object on the panel, whether it's a target hero, textbox, or an image), you're going to want to move them around! When you click a panel to select it, little icons will show up by all the actors, allowing you to adjust their position, rotation, and several other things. For heroes specifically, there are controls to
			* move the hero
			* rotate the hero
			* scale the hero
			* flip the hero horizontally
			* rotate the hero's head
			* flip the hero's head horizontally
			* change the hero's facial expression
			* add a text box for the hero
			* change whether the hero is holding their weapons
			* move the hero in front of/behind other actors

			[[File:ComicEditorActorHandles.PNG]]

			(The hero rotation icon is missing from the above image, because it's located down by the hero's feet, which is the pivot point for hero rotation)

			There are similar controls for images, text boxes, and pointers (the lines leading from heroes to their textboxes). For textboxes and pointers, you may need to click a '+' icon to show the other controls. You can also hold Control (Command on Mac) to hide all of the controls, in case you just want to look at the beautiful piece of art you've created.

			There are also a number of things you can do in the right-hand panel. These all have tooltips describing their function, but here are a couple of particular interest:
			* '''panel > animation:''' can be used to control the order and depth of panels appearing, which is useful if you want a comic to read from right to left (Yeah! Break the rules!)
			* '''actorSlots > focus:''' determine whether the face, middle, or foot of the hero is the "focus" point. Some heroes are taller than others, so you'll often want to use "face" if you're just showing a hero's head, to ensure the panel still looks good with different heroes, but you'll want to use "foot" if you're showing them standing on something
			* '''actorSlots > color/colorFilter:''' tint actors different colors! This can be particularly effective when very slightly tinting them the color of the environment or background, to make them feel more "grounded".
			* '''textSlots > allowDrawOverEdges:''' allows a textbox to go beyond the bounds of a panel, which can be visually interesting when having the text from one panel overlap the previous panel.

			==Testing your Event in the Editor==
			Your event is set up and things are looking good. But what if a taller hero goes out of frame? What if the heroes are at a different site? What if one of them has crow wings?

			===Testing Options===
			There are a number of ways to test your event from within the comic editor, most of which are on the top of the screen right above the comic.

			[[File:ComicEditorOptions.PNG]]

			Many of these are only useful once you've added tags and dynamic text to your event (which we'll go over in the next section), but it feels correct to talk about it here first, so when you ''do'' start using tags, you'll know how to test that they're working.

			* The comic editor is set to '''Scroll''' view by default, but you can change it to '''Clickthrough''' to see a more accurate representation of what your comic will look like in-game, including panels animating in.
			* '''Reroll''' will reroll all of the "fake" heroes it's matching with your targets, allowing you to see what it will look like if the player gets your event with a variety of heroes or at different sites. Note that by default, these fake heroes won't actually match the target requirements you've set for them; that will only happen in-game.
			* '''Settings...''' will bring up some options for testing all of the roles. You can choose whether or not to show optional roles, make roles always show up as a certain class, and give roles specific aspects. (Some of this can also be done with the inspect button, but those won't persist across multiple rerolls)
			* '''Find''' can be used to search for words in the event. It's not a testing feature, but this was a sensible place for it.
			* '''+RP''' will grant relationship points between all of the heroes. Useful for testing events that have differences based on relationship tiers.
			* '''friends/lovers/rivals/family''' will make everyone in the event friends/lovers/rivals/some kind of family. Useful for testing events with differences based on relationship or family types.
			* '''inspect''' will allow you to directly edit any of the "fake" matches for targets via their character sheets (as long as you have [[Testing\|devMode]] on), which can help you test specific scenarios.

			===Dev Mode===
			At this point, you may want to enable [[Testing\|devMode]]. You can do almost everything in this guide without it, but there are certain cheat-oriented hero things (adjusting character stats, abilities, gear, and relationships through their character sheets) and gameplay things (choosing which events to encounter, skipping objectives) that are very useful for testing, especially when you get to actual in-game testing.

	==Using Tags to Control Text==		==Using Tags to Control Text==
Line 152:		Line 198:
	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.		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.

	===[[Outcomes]]===		==[[Outcomes]]==
	So we know how to make comics now, but comics aren't very interesting if they don't impact the gameplay. '''[[Outcomes]]''' are used to make things happen in the game, like granting a weapon, applying a transformation theme, adding resources, or starting a mission.		So we know how to make comics now, but comics aren't very interesting if they don't impact the gameplay. '''[[Outcomes]]''' are used to make things happen in the game, like granting a weapon, applying a transformation theme, adding resources, or starting a mission.

Line 174:		Line 220:

	You can see a list of the outcomes and descriptions on the [[Outcomes]] page, but all of those descriptions are also in-game as tooltips (and more likely to be up-to-date)		You can see a list of the outcomes and descriptions on the [[Outcomes]] page, but all of those descriptions are also in-game as tooltips (and more likely to be up-to-date)

			==Testing your Event In-Game==
			Great! You've made an event, and now you're ready to see it in action. The first thing you need to do is '''Enable it'', which you can do by pressing the '''Event Disabled''' button underneath the targets in the comics panel.

			There are a couple other things on the Effects tab you may want to change before testing. If you expand the '''ability''' line, cooldown, encounterScore, and encounterWeight may be useful.
			* '''cooldown:''' How many times can this event happen per game? By default, this is once per game, but you can change it to make an event that happens multiple times per game.
			* '''encounterScore:''' Events with higher score will ''always'' happen instead of events with lower scores, if possible. If you want your event to ''definitely happen whenever it can'', change this to a higher number. (Most default events are set at 10, so setting it to 11 is a pretty safe bet)
			* '''encounterWeight:''' How likely is this event to be chosen, when compared with other events of the same encounterScore? For example, if you have an event you really want to happen, setting this to 5 would make it 5 times more likely to happen than a normal event.

			Now we're ''really'' ready to test it in-game.

			Return to the menu, and start a new game! (Probably a standard three or five chapter one, rather than a story campaign) In the Campaign Options, click the '''Pick Mods''' button, and select your mod. If you've enabled [[Testing\|dev mode]], you also probably want to '''Enable Cheats''' and check '''Pick Events''' and '''Objectives Cheat'''.

			If you have Pick Events turned on, it will ask you which ENCOUNTER_TUTORIAL_KICKOFF to pick. It doesn't matter, we just want to get to your event.

			Once you're in the mission, if you have Objectives Cheat turned on, you can click the "Kill all enemies" objective in the top left to automatically complete it. Easy win!

			(Comics and certain other things can be skipped by pressing Escape, which is useful when trying to get through events quickly while testing)

			Finally, once you're on the overland, scout a tile and assault a hostile site. You should see ENCOUNTER_HEROES_ARRIVE_HOSTILE_SITE and a list of possible events to trigger. If you don't see your event among the top possible choices, it's likely there wasn't a match for one of your event targets. If you scroll down, you should be able to find why your event failed.

			[[File:ArriveAtHostileSiteFailedEvent.PNG\|Failed event]]

			In the case of this image, none of my heroes had a BOOKISH personality stat of 80 or more. If I have [[Testing\|devMode]] enabled, I can open the character sheet of one of my heroes, increase their bookish stat above 80, and then assault another site. (Since I know the event I've been working on also requires the bookish hero to have a lover, I'll use cheats to give that hero a lover as well)

			If everything is correct, you should be able to choose your event!

			Those are the basics of making events for Wildermyth. Once you have an event or several events you'd like to share, you can [[Modding_Guide#How_to_publish_your_mod\|upload them to the Steam Workshop]], or share them elsewhere by uploading your mod folder. Go spin some tales!

			[[File:BookishAndLoverInLibrary.PNG]]

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

Pbelanger: /* Outcomes */ Outcomes section

2021-01-21T00:08:44Z

Outcomes: Outcomes section

← Older revision		Revision as of 00:08, 21 January 2021
Line 153:		Line 153:

	===[[Outcomes]]===		===[[Outcomes]]===
	~~TODO~~		So we know how to make comics now, but comics aren't very interesting if they don't impact the gameplay. '''[[Outcomes]]''' are used to make things happen in the game, like granting a weapon, applying a transformation theme, adding resources, or starting a mission.

			To add outcomes to your comic, you'll need to switch from the '''Comics''' tab (Ctrl+1) to the '''Effects''' tab (Ctrl+2). It may look overwhelming at first, but don't worry! Most of this is the stuff you just edited in the comics tab, just in text form. Partway down you can see a list of targets, which are the same targets for heroes that you were working with before.

			At the bottom, there's a list of outcomes. If your event has choices, you'll probably see something like "Chose <<one>>" and "Chose <<two>>", along with Description outcomes in both. The Description outcomes are how the choice comics are triggered. (If you switch back to the comics tab, you can see that the header above the choice outcomes says something like "Outcome 1 >> Chose one.1")

			[[File:ChoiceOutcomes.PNG]]

			If you click the '''"Add Outcome..."''' button under one of them, a New Outcome dialog will pop up:

			[[File:NewOutcomeDialog.PNG]]

			Across the top of the dialog are the most commonly required Outcomes, but you can scroll through all possible Outcomes in the left scroll panel. Each Outcome has its own set of options to get it to do exactly what you want.

			If you're creating an Arrive at Hostile Site event, you'll almost always want to add a '''Mission Outcome''' so that a battle will occur after the event is over. You can do this by clicking the Mission button, and then clicking '''Create'''. (If you made an Arrive at Hostile Site event without a player choice, the Mission Outcome will already be there for you)

			Once you've done this, you'll see a Mission outcome after the Description outcome. That will only fire a mission for that choice, so you'll want to add a Mission Outcome to the other choice as well. Having two separate Missions like this is helpful if you want to apply combat modifiers or have different victory events based on the choice that was made.

			If you want to have one mission that's the same regardless of the choice, you can hover over the '''"outcomes: <list>"''' line and click the '''New Entry''' button to create an Outcome ''after'' the choices.

			You can see a list of the outcomes and descriptions on the [[Outcomes]] page, but all of those descriptions are also in-game as tooltips (and more likely to be up-to-date)

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

Pbelanger: Added a lot of new information about new tools and features

2021-01-20T00:53:01Z

Added a lot of new information about new tools and features

Show changes

Ruarch: /* Comic Editor Basics */ remove obsolete text panel stuff

2020-03-21T14:58:36Z

Comic Editor Basics: remove obsolete text panel stuff

← Older revision		Revision as of 14:58, 21 March 2020
Line 73:		Line 73:
	==Comic Editor Basics==		==Comic Editor Basics==

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


	* Each box on the left holds text for a different section of the story: a prompt, a choice, or an outcome.		* 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!		* Press the save button!
	* Undo should work, but sometimes need to press it more than once.		* 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==		==Using Tags to Control Text==

Pbelanger: Added link to Text Styles

2020-02-27T18:46:58Z

Added link to Text Styles

← Older revision		Revision as of 18:46, 27 February 2020
Line 1:		Line 1:
	This is a collection of reference material that explains how to use the Comic Editor to tell stories.		This is a collection of reference material that explains how to use the Comic Editor to tell stories.

	''(Related links: Check out the [[Writer's Guide]] for a more top-level view of crafting stories. If you're wondering about tags, check the [[Tag Reference]].)''		''(Related links: Check out the [[Writer's Guide]] for a more top-level view of crafting stories. If you're wondering about tags, check the [[Tag Reference]]. If you want your text to look a certain way, check [[Text Styles]])''

	==Make a New Event==		==Make a New Event==

Rebashworth: /* Make a New Event */

2019-12-11T19:20:04Z

Make a New Event

← Older revision		Revision as of 19:20, 11 December 2019
Line 13:		Line 13:
	* Select the [[Event Types\|type of event]] you are creating, for example ''Arrive at Hostile Site'' or ''Mission Victory''.		* 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 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.		* 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.		* Edit the id and filename if you want.
	* Press '''Create'''!		* Press '''Create'''!

	Event is now ~~exist~~! Maybe save?		Event now exists! Maybe save?

	==Codestuff==		==Codestuff==

Croald at 05:19, 5 December 2019

2019-12-05T05:19:11Z

← Older revision		Revision as of 05:19, 5 December 2019
Line 146:		Line 146:

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