Module Editor - Revision history

Darloth: Very basic explanation of module state.

2026-07-17T22:05:34Z

Very basic explanation of module state.

@@ Line 4: / Line 4: @@
 A player is always within exactly one active Beat, which itself can contain one or more Moments. Beats are like a room and Moments are like the things you can do in that room.
 == Beats ==
@@ Line 75: / Line 77: @@
 Currently, only .png filenames that begin with the text "banner_" will show up and be available for banners.

Olive at 00:42, 12 July 2026

2026-07-12T00:42:37Z

← Older revision		Revision as of 00:42, 12 July 2026
Line 1:		Line 1:
	~~DRAFT DRAFT DRAFT~~

	[[File:ModuleEditorBeats.png\|thumb]]		[[File:ModuleEditorBeats.png\|thumb]]

Olive at 00:41, 12 July 2026

2026-07-12T00:41:53Z

← Older revision		Revision as of 00:41, 12 July 2026
Line 35:		Line 35:
	: Immediately becomes the active Moment when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.		: Immediately becomes the active Moment when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.
	; Trigger		; Trigger
	: ~~runs~~ some number of effects (as long as its conditions are met) and proceeds to whatever it's connected to. The interface for defining trigger conditions and effects is the same as in the Combat Editor but the list of what effects are available is different.		: Runs some number of effects (as long as its conditions are met) and proceeds to whatever it's connected to. The interface for defining trigger conditions and effects is the same as in the Combat Editor but the list of what effects are available is different.

	== Media ==		== Media ==

Olive at 00:41, 12 July 2026

2026-07-12T00:41:26Z

← Older revision		Revision as of 00:41, 12 July 2026
Line 24:		Line 24:

	The current Moment types are:		The current Moment types are:

	; Combat Briefing		; Combat Briefing
	: Shows a preview of a combat with any available sitrep and map information. Players can press Launch to start the combat. There's also a checkbox to skip the briefing screen and jump straight into the combat as soon as this Moment becomes active.		: Shows a preview of a combat with any available sitrep and map information. Players can press Launch to start the combat. There's also a checkbox to skip the briefing screen and jump straight into the combat as soon as this Moment becomes active.

	; Exposition		; Exposition
	: A flexible text box, optional image media, and player choices.		: A flexible text box, optional image media, and player choices.

	; Dialogue		; Dialogue
	: Runs a cutscene of characters speaking to each other, defined in the Conversation tool.		: Runs a cutscene of characters speaking to each other, defined in the Conversation tool.

	; Branch		; Branch
	: Automatically proceeds to one of two connected Moments depending on whether its condition returns true/false.		: Automatically proceeds to one of two connected Moments depending on whether its condition returns true/false.

	; Signal receiver		; Signal receiver
	: Immediately becomes the active Moment when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.		: Immediately becomes the active Moment when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.

	; Trigger		; Trigger
	: runs some number of effects (as long as its conditions are met) and proceeds to whatever it's connected to. The interface for defining trigger conditions and effects is the same as in the Combat Editor but the list of what effects are available is different.		: runs some number of effects (as long as its conditions are met) and proceeds to whatever it's connected to. The interface for defining trigger conditions and effects is the same as in the Combat Editor but the list of what effects are available is different.
Line 48:		Line 42:

	The current Media types are:		The current Media types are:

	; PNG		; PNG
	: An arbitrary static image. Players can place .png files in the media/ folder within their module folder.		: An arbitrary static image. Players can place .png files in the media/ folder within their module folder.

	; Diorama		; Diorama
	: A miniature map, created in a feature-reduced version of the combat editor.		: A miniature map, created in a feature-reduced version of the combat editor.

	; Mech		; Mech
	: The image of a mech from a module origin character or NPC.		: The image of a mech from a module origin character or NPC.

	; Pilot		; Pilot
	: The image of one of the player's character portraits.		: The image of one of the player's character portraits.

	; NPC		; NPC
	: The image of one of the module NPC portraits.		: The image of one of the module NPC portraits.
Line 70:		Line 59:

	Currently, only .png filenames that begin with the text "bg_" will show up and be available for backgrounds. (This is likely to change.) Backgrounds are recommended to be at least 1280x720 or a lower multiple with the same ratio.		Currently, only .png filenames that begin with the text "bg_" will show up and be available for backgrounds. (This is likely to change.) Backgrounds are recommended to be at least 1280x720 or a lower multiple with the same ratio.



	~~TODO: EXAMPLE SCREENSHOT~~

	=== Handouts ===		=== Handouts ===
	[[File:ExpositionMedia.png\|thumb\|Example of an Exposition Moment screen with a Diorama provided as the Handout Media. ]]		[[File:ExpositionMedia.png\|thumb\|Example of an Exposition Moment screen with a Diorama provided as the Handout Media. ]]

	''Available media types: Any''		''Available media types: Any''

Line 82:		Line 68:

	Handout images will be rendered at a maximum of 512x512		Handout images will be rendered at a maximum of 512x512

	~~TODO: EXAMPLE SCREENSHOT~~

	=== Banner ===		=== Banner ===

Olive at 00:38, 12 July 2026

2026-07-12T00:38:07Z

← Older revision		Revision as of 00:38, 12 July 2026
Line 5:		Line 5:
	The <strong>Module Editor</strong> is a tool for adding downtime scenes between combats.		The <strong>Module Editor</strong> is a tool for adding downtime scenes between combats.

	A player is always within exactly one active Beat, which itself can contain one or more ~~Activities~~. Beats are like a room and ~~Activities~~ are like the things you can do in that room.		A player is always within exactly one active Beat, which itself can contain one or more Moments. Beats are like a room and Moments are like the things you can do in that room.

	== Beats ==		== Beats ==

	~~Unless an active Activity specifies otherwise, a Beat determines the current [[Module Editor#Backgrounds\|background]] that underlays whatever's going on in the UI.~~		Beats determine what the player can do with the Lancers character-sheet-wise whenever another Moment isn't currently active. The available values:

	Beats ~~also~~ determine what the player can do with the Lancers character-sheet-wise whenever another ~~Activity~~ isn't currently active. The available values:
	; Hidden		; Hidden
	: All Lancers are hidden. The player cannot open characters sheets or see who's in the current party.		: All Lancers are hidden. The player cannot open characters sheets or see who's in the current party.
Line 23:		Line 21:
	: On entering this beat for the first time, all Lancers increase in License Level. Otherwise acts as a full repair.		: On entering this beat for the first time, all Lancers increase in License Level. Otherwise acts as a full repair.

	== ~~Activities~~ ==		== Moments ==

	The current ~~Activity~~ types are:		The current Moment types are:

	; Combat Briefing		; Combat Briefing
	: Shows a preview of a combat with any available sitrep and map information. Players can press Launch to start the combat. There's also a checkbox to skip the briefing screen and jump straight into the combat as soon as this ~~Activity~~ becomes active.		: Shows a preview of a combat with any available sitrep and map information. Players can press Launch to start the combat. There's also a checkbox to skip the briefing screen and jump straight into the combat as soon as this Moment becomes active.

	; Exposition		; Exposition
Line 37:		Line 35:

	; Branch		; Branch
	: Automatically proceeds to one of two connected ~~Activities~~ depending on whether its condition returns true/false.		: Automatically proceeds to one of two connected Moments depending on whether its condition returns true/false.

	; Signal receiver		; Signal receiver
	: Immediately becomes the active ~~Activity~~ when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.		: Immediately becomes the active Moment when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.

	; Trigger		; Trigger
	: runs some number of effects (as long as its conditions are met) and proceeds to whatever it's connected to. The interface for defining trigger conditions and effects is the same as in the Combat Editor but the list of what effects are available is different.		: runs some number of effects (as long as its conditions are met) and proceeds to whatever it's connected to. The interface for defining trigger conditions and effects is the same as in the Combat Editor but the list of what effects are available is different.

	== Backgrounds ==		== Media ==

			When a UI element needs to display a player-defined image, it does so through a Media picker.

			The current Media types are:

			; PNG
			: An arbitrary static image. Players can place .png files in the media/ folder within their module folder.

			; Diorama
			: A miniature map, created in a feature-reduced version of the combat editor.

			; Mech
			: The image of a mech from a module origin character or NPC.

			; Pilot
			: The image of one of the player's character portraits.

			; NPC
			: The image of one of the module NPC portraits.

			=== Backgrounds ===
			''Available media types: PNG, Diorama, Combat''

			Beats and Moments can specify a Background Media, which underlays all the downtime UI and buttons. Unless an active Moment specifies otherwise, a Beat determines the current Background.

			Currently, only .png filenames that begin with the text "bg_" will show up and be available for backgrounds. (This is likely to change.) Backgrounds are recommended to be at least 1280x720 or a lower multiple with the same ratio.



			TODO: EXAMPLE SCREENSHOT

			=== Handouts ===
			[[File:ExpositionMedia.png\|thumb\|Example of an Exposition Moment screen with a Diorama provided as the Handout Media. ]]
			''Available media types: Any''

			Exposition moments can specify a Handout Media which shows up alongside the text.

			Handout images will be rendered at a maximum of 512x512

			TODO: EXAMPLE SCREENSHOT

			=== Banner ===
			[[File:Custom_Module_Banner.png\|thumb\|Example view of the screen where you pick what module to play, showing the description and banner. ]]

			''Available media types: PNG''

			Shown above your module description when picking what module to play. The required dimensions or format of module banners may change in the future.

	~~(something to do~~ with ~~media types)~~		Currently, only .png filenames that begin with the text "banner_" will show up and be available for banners.

Olive at 00:20, 11 July 2026

2026-07-11T00:20:26Z

← Older revision		Revision as of 00:20, 11 July 2026
Line 1:		Line 1:
	DRAFT DRAFT DRAFT		DRAFT DRAFT DRAFT

			[[File:ModuleEditorBeats.png\|thumb]]

	The <strong>Module Editor</strong> is a tool for adding downtime scenes between combats.		The <strong>Module Editor</strong> is a tool for adding downtime scenes between combats.

	== Beats ~~& Notes ==~~		A player is always within exactly one active Beat, which itself can contain one or more Activities. Beats are like a room and Activities are like the things you can do in that room.

	~~A player is always within exactly one active Beat, which itself can contain one or more Notes.~~ Beats ~~are like a room and Notes are like the things you can do in that room.~~		== Beats ==

	[[~~File:ModuleEditorBeats.png~~]]		Unless an active Activity specifies otherwise, a Beat determines the current [[Module Editor#Backgrounds\|background]] that underlays whatever's going on in the UI.

	~~Unless an~~ active ~~Note specifies~~ otherwise, ~~a Beat determines~~ the ~~current [[Module Editor#Backgrounds\|background]] that underlays whatever's going on~~ in ~~the UI~~.		Beats also determine what the player can do with the Lancers character-sheet-wise whenever another Activity isn't currently active. The available values:
			; Hidden
			: All Lancers are hidden. The player cannot open characters sheets or see who's in the current party.
			; None
			: The player can inspect character sheets, but not spend repairs or otherwise modify their Lancers.
			; Short repair
			: The player can spend repairs to restore Structure/Stress or destroyed systems and mechs, but not modify their current loadout.
			; Full repair
			: All stats are restored to full and the player is free to modify loadouts.
			; Level up
			: On entering this beat for the first time, all Lancers increase in License Level. Otherwise acts as a full repair.

	~~Beats also determine what the player can do with the Lancers character-sheet-wise whenever another Note isn't currently active. The available values:~~		== Activities ==
	** '''Hidden:''' All Lancers are hidden. The player cannot open characters sheets or see who's in the current party.
	** '''None:''' The player can inspect character sheets, but not spend repairs or otherwise modify their Lancers.
	** '''Short repair:''' The player can spend repairs to restore Structure/Stress or destroyed systems and mechs, but not modify their current loadout.
	** '''Full repair:''' All stats are restored to full and the player is free to modify loadouts.
	** '''Level up:''' On entering this beat for the first time, all Lancers increase in License Level. Otherwise acts as a full repair.

			The current Activity types are:
	The current ~~Note~~ types are:

	; Combat Briefing		; Combat Briefing
	: Shows a preview of a combat with any available sitrep and map information. Players can press Launch to start the combat. There's also a checkbox to skip the briefing screen and jump straight into the combat as soon as this ~~Note~~ becomes active.		: Shows a preview of a combat with any available sitrep and map information. Players can press Launch to start the combat. There's also a checkbox to skip the briefing screen and jump straight into the combat as soon as this Activity becomes active.

	; Exposition		; Exposition
Line 31:		Line 37:

	; Branch		; Branch
	: ~~automatically~~ proceeds to one of two connected ~~Notes~~ depending on whether its condition returns true/false.		: Automatically proceeds to one of two connected Activities depending on whether its condition returns true/false.

	; Signal receiver		; Signal receiver
	: Immediately becomes the active ~~Note~~ when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.		: Immediately becomes the active Activity when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.

	; Trigger		; Trigger
Line 40:		Line 46:

	== Backgrounds ==		== Backgrounds ==

			(something to do with media types)

Olive: Created page with "DRAFT DRAFT DRAFT The Module Editor is a tool for adding downtime scenes between combats. == Beats & Notes == A player is always within exactly one active Beat, which itself can contain one or more Notes. Beats are like a room and Notes are like the things you can do in that room. File:ModuleEditorBeats.png Unless an active Note specifies otherwise, a Beat determines the current background that underlays whatever's..."

2026-07-05T23:55:32Z

Created page with "DRAFT DRAFT DRAFT The <strong>Module Editor</strong> is a tool for adding downtime scenes between combats. == Beats & Notes == A player is always within exactly one active Beat, which itself can contain one or more Notes. Beats are like a room and Notes are like the things you can do in that room. File:ModuleEditorBeats.png Unless an active Note specifies otherwise, a Beat determines the current background that underlays whatever's..."

New page

DRAFT DRAFT DRAFT

The <strong>Module Editor</strong> is a tool for adding downtime scenes between combats.

== Beats & Notes ==

A player is always within exactly one active Beat, which itself can contain one or more Notes. Beats are like a room and Notes are like the things you can do in that room.

[[File:ModuleEditorBeats.png]]

Unless an active Note specifies otherwise, a Beat determines the current [[Module Editor#Backgrounds|background]] that underlays whatever's going on in the UI.

Beats also determine what the player can do with the Lancers character-sheet-wise whenever another Note isn't currently active. The available values:
** '''Hidden:''' All Lancers are hidden. The player cannot open characters sheets or see who's in the current party.
** '''None:''' The player can inspect character sheets, but not spend repairs or otherwise modify their Lancers.
** '''Short repair:''' The player can spend repairs to restore Structure/Stress or destroyed systems and mechs, but not modify their current loadout.
** '''Full repair:''' All stats are restored to full and the player is free to modify loadouts.
** '''Level up:''' On entering this beat for the first time, all Lancers increase in License Level. Otherwise acts as a full repair.

The current Note types are:

; Combat Briefing
: Shows a preview of a combat with any available sitrep and map information. Players can press Launch to start the combat. There's also a checkbox to skip the briefing screen and jump straight into the combat as soon as this Note becomes active.

; Exposition
: A flexible text box, optional image media, and player choices.

; Dialogue
: Runs a cutscene of characters speaking to each other, defined in the Conversation tool.

; Branch
: automatically proceeds to one of two connected Notes depending on whether its condition returns true/false.

; Signal receiver
: Immediately becomes the active Note when a Trigger emits a matching module signal effect and proceeds to whatever it's connected to.

; Trigger
: runs some number of effects (as long as its conditions are met) and proceeds to whatever it's connected to. The interface for defining trigger conditions and effects is the same as in the Combat Editor but the list of what effects are available is different.

== Backgrounds ==