The Muse - User contributions [en]

Modding Cookbook

2026-08-06T19:03:15Z

Darloth: /* Make your mod */ - thumbnail minimums

== Make your mod ==

# Get hands on the project source code, hopefully via the modkit download on itch.io or another channel from Wickworks.
# Open it in the Godot editor (4.7 currently)
# Go to Project Settings → Plugins and enable Mod Loader Dev Tool (it'll be the only thing that's unchecked)
# There's now a tab call "Mod Tool" at the top-center of the window. Press the "Create new Mod" button, fill out the fields, and press Create. Your mod will need to have at least 3 characters in both author and mod name, and it's best not to use any special characters aside from _ and -
## See [[Modding#Mod Types & Security|Mod Types]] for the difference between an Asset Pack, Content Pack, and Substantial mod. You can change what type it is later by adding scripts or toggling requires_restart. NOTE: If you wish to create an Asset Pack, there's currently a bug that will prevent it being created correctly unless you select a Content Pack first, then switch back to Asset Pack.
# Fill out any information you'd like to provide in manifest fields. The manifest should be automatically saved.
# In the FileSystem window, you should see folder with the name of your mod under unpacked/, with a manifest.json and a mod_main.gd file.
# (optional) Update thumbnail.png with the image you want to represent your mod. The thumbnail should be in 16:9 ratio, and has a minimum size of 640x360 pixels.

== Replace existing resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

# Navigate to the file you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the resource to your mod's folder under res/ + the original path.
# Modify the resource in your res/ folder as desired.

It will be automatically swapped in to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>.

Warning: If multiple mods replace the same resource, only the last one will take effect.

== Add new resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

Add them to your mod's res/ directory in a folder mirroring where they'd be in the base game data. For example, if you wanted to add a new available sprite for the napoleon at:
res://assets/frames/ha/mf_napoleon/

You'd add your image at:
res://unpacked/Mod-Name/res/assets/frames/ha/mf_napoleon/

It will be automatically added to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>. If you're making an asset pack, the default mod_main that will be used handles this instead.

Warning: If multiple mods add a new resource with the same path + name, only the last one will take effect.

== Remove existing resources ==
''(.png, .svg, .tres, .tscn, .json)''

TODO: some way to mark a resource as something to remove. An extra extension?

== Modify existing resource ==
''(.tres)''

# Navigate to the resource you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Resource Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tres_ext.gd
# Modify the scene through the generated script's modify_resource function, as desired.

For example, to add the Barbarossa as an alt frame of the Napoleon license, find and Create Resource Extension for the li_napoleon.tres. In the resulting li_napoleon.tres_ext.gd file, you would put:

func modify_resource(resource:Resource) -> Resource:
var license:UnlockTree = resource

var barb := load('res://content/frames/ha/mf_barbarossa/mf_barbarossa.tres')
license.rank_2.granted_frames.append(barb)

return license

Note: modify_resource is run after resources are moved in the virtual filesystem from your mod's res/ directory into their res:// locations, so I *believe* that if you load new resources from your mod you should use their res://content/... paths instead of the unpacked location.

To be safe, a function such as this can always return what should be the correct path:

func sload(file: String):
if(ResourceLoader.exists(file)):
return ResourceLoader.load(file)
else:
return ResourceLoader.load('res://'+file.split('/res/')[1])

Then use sload instead of load to load resource references.

This will work even if two different mods extend the same resource.

== Modify existing scenes ==
''(.tscn)''

# Navigate to the scene you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Scene Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tscn_ext.gd
# Modify the scene through the generated script's modify_scene function, as desired.

Note: if you add new nodes to the modified scene, you MUST set the [https://docs.godotengine.org/en/stable/classes/class_node.html#class-node-property-owner owner] of that child to the scene after adding it as a child, e.g.

func modify_scene(scene:Node) -> Node:
# Modify an existing node.
var label: Label = scene_instance.get_node("Maybe/Some/NodeHere")
label.text += " modified"

# Add a new node.
var new_node: Node = Node.new()
scene_instance.add_child(new_node)
new_node.owner = scene # Must come after add_child for all added nodes.

return scene_instance

This will work even if two different mods extend the same scene.

== Extend existing scripts ==
https://wiki.godotmodding.com/guides/modding/script_extensions/

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Script Extension" from the context menu.
# This will create a new script to your mod's folder under res/ + the original path, extending the vanilla script, with the extension .gd_ext.gd
# Modify the extending script in your res/ folder as desired.

This will work even if two different mods extend the same script, via <code>add_overwrite_extend_mod_resources</code>, powered by <code>ModLoaderMod.install_script_extension</code>.

If you change an autoload, that autoload will be reloaded after all mods are applied.

If you find that the autoload's functions do not run your extended code, you may need to manually refresh the script of an autoload after your mod's mod_main._init() function. Example code that does this for the UnitRelation autoload is provided below, you'll need to adjust it to the specific autoloads that you're affecting.
<pre>
func _init() -> void:
ModLoaderLog.info("Activating.", MOD_ID)

LancerTacticsMod.add_translations(MOD_ID)

LancerTacticsMod.add_overwrite_extend_mod_resources(MOD_ID)
# other things might be here
# ...
call_deferred(&"fix_scripts")

func fix_scripts():
#print("fix UnitRelation")
UnitRelation.set_script(load("res://engine/character/unit/service/unit_relation.gd"))
</pre>

WARNING: Due to unknown reasons, if a static function on an autoload calls other static functions on the same autoload more than two function calls deep, it reverts to the original code rather than the extended code. So far no workaround has been discovered.

WARNING: Due to a bug in Godot, we can't extend scripts with a class_name. See [[Modding#Hooks and class name scripts|Hooks and class name scripts]] for details.

== Replace existing scripts ==

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the script to your mod's folder under res/ + the original path.
# Modify the replacing script in your res/ folder as desired.

This will likely conflict with any other mods that also attempt to replace or extend this script. However, this is the only way to change static vars. Godot appears to cache consts at a script-path level, so as far as I can tell there's no way to change a const on an object/script after it's been declared, even by completely replacing the script.

You should very probably include definitions for everything the original script did, or you'll crash as soon as something asks for a now-missing value (unless this replacement is also extending something that covers those functions).

If you change an autoload, that autoload will be reloaded after all mods are applied.

== Localizations & text ==

Generating a mod from a template will create a localization/localizations.csv file in your mod folder. These key/value pairs are used to figure out what text to show in the game for kits/frames/everything. You can see the shipped assets/localization/localizations.csv file for examples of all the base game text.

You can add your own keys in a likewise format in your own file — I recommend an external spreadsheet editor over godot's text editor to automatically handle internal commas and quotation marks. Alternatively, there is a second tab next to the Manifest Editor in the Mod Tool section called "Localization Editor". I haven't thoroughly tested it, but it gives some basic controls for adding new key/values in the expected format and a button to regenerate localizations (possibly necessary to see the changes show up).

== Add custom sound fx ==

https://www.fmod.com/docs/2.01/studio/supporting-downloadable-and-user-generated-content.html

I haven't actually tested it, but if you open the Lancer Tactics FMOD project and export your own bank as described above, you should be able to add your .bank file anywhere in your mod's res/ directory and it'll be automatically picked up and loaded in (and subsequently unloaded if the mod is disabled).

New banks must be named by either prefixing or suffixing the bank they're adding onto. For example, if I'm making a new music bank, since the baseline bank is called "music.bank" mine has to look like "my_music.bank" or "music_thunderdome.bank". This is because the FMOD addon crashes if we ever try to play an event not in the banks so we have to cache what events are available for each category.

If you feel motivated to test this, let me know how it goes!

== Modify how COMP/CON imports pilots ==

Lancer Tactics is strict about what sorts of prefixes it looks for in resources. If you're working with a more loosey-goosey ID that was made for COMP/CON (such as the practice of adding prefixes based on the supplement), you can make a mod that tells LT how to map the C/C ID.

# Extend the compcon_importer script: <code>res://ui/page/pilot_roster/compcon_importer.gd</code>
# Extend the get_compcon_id_remap function.
# Call super.get_compcon_id_remap() within it, then add whatever C/C -> LT IDs to the dictionary that you'd like.

== Player configuration ==
https://wiki.godotmodding.com/guides/modding/config_json/

You can allow the player to configure your mod through inputs in the mod manager, ie, toggle booleans, pick from dropdowns, and enter text+numbers that your mod can then consume.

Define the config as described in the above documentation inside of your manifest.json file, and get the player's current values with <code>ModLoaderConfig.get_current_config("your_mod_id")</code>.

Lancer Tactics currently only supports numbers, strings, and boolean inputs. Let me know if you need more than that!

== Dependencies ==
https://wiki.godotmodding.com/guides/modding/using_other_mods/#dependencies-and-load-order

If your mod requires another mod to function, you need to do two things:

# Add the other mod's folder ID (in the Namespace-ModName format) in the "Dependencies" section of your manifest. This will tell the mod loader to load their mod first.
# Tell mod.io about the dependency by going to <code>mod.io/g/lancer-tactics/m/[YOUR MOD SLUG HERE]/admin/settings#dependencies</code> and selecting the other mod from the search bar.

== Export + upload your mod to share ==

Mods are loaded by player's games by looking for .zip files in their user mods/ folder. In order to get them set up with the mod, we need to create that zip and get it into their folder. There are three options:

=== Manually ===
In the bottom-center of the Mod Tool tab, there's an "Export as .zip" button. Pressing it will pack the current mod into a zip file at the designated location.

You can drag the zipped mod to your own user data mods/ folder, or send it to your friends so they can do so for their own games. No need to get a third party involved.

=== Mod.io, via the Mod Tool ===
In the bottom-right of the Mod Tool tab, there's a "Upload" section.

# Authenticate with mod.io from the Omninet page in the running game, if you haven't already. This will save a token to your settings.cfg
# Verify that it shows you as logged in as the appropriate email, and press "Check status" button to verify your connection to mod.io.
# Press "Upload to mod.io" and confirm.

You should now be able to see and manage your mod online at https://mod.io/content#mods

=== Mod.io, via the browser ===
You can upload a mod from outside the Mod Tool by uploading the exported .zip file you made in the manual option above. Mod.io's flow for doing so is fairly intuitive, but to be loaded by the game you must include this json in the Metadata section for the mod, filling in values as appropriate:
{
"game_version":"X.X.X",
"mod_id":"YourNamespace-YourMod",
"revision":1,
"version":"1.0.0"
}
* game_version: The version of Lancer Tactics you expect this mod to work on.
* mod_id: The ID of your mod, in the Namespace-Modname format (matches its folder when unpacked)
* revision: Doesn't matter too much; just for information. Incremented by the game each time it uploads something new.
* version: The [https://semver.org/ semantic versioning] of your mod.

Modding Cookbook

2026-08-06T19:02:12Z

Darloth: /* Make your mod */ - advice on mod name, no more save manifest button

== Make your mod ==

# Get hands on the project source code, hopefully via the modkit download on itch.io or another channel from Wickworks.
# Open it in the Godot editor (4.7 currently)
# Go to Project Settings → Plugins and enable Mod Loader Dev Tool (it'll be the only thing that's unchecked)
# There's now a tab call "Mod Tool" at the top-center of the window. Press the "Create new Mod" button, fill out the fields, and press Create. Your mod will need to have at least 3 characters in both author and mod name, and it's best not to use any special characters aside from _ and -
## See [[Modding#Mod Types & Security|Mod Types]] for the difference between an Asset Pack, Content Pack, and Substantial mod. You can change what type it is later by adding scripts or toggling requires_restart. NOTE: If you wish to create an Asset Pack, there's currently a bug that will prevent it being created correctly unless you select a Content Pack first, then switch back to Asset Pack.
# Fill out any information you'd like to provide in manifest fields. The manifest should be automatically saved.
# In the FileSystem window, you should see folder with the name of your mod under unpacked/, with a manifest.json and a mod_main.gd file.
# (optional) Update thumbnail.png with the image you want to represent your mod.

== Replace existing resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

# Navigate to the file you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the resource to your mod's folder under res/ + the original path.
# Modify the resource in your res/ folder as desired.

It will be automatically swapped in to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>.

Warning: If multiple mods replace the same resource, only the last one will take effect.

== Add new resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

Add them to your mod's res/ directory in a folder mirroring where they'd be in the base game data. For example, if you wanted to add a new available sprite for the napoleon at:
res://assets/frames/ha/mf_napoleon/

You'd add your image at:
res://unpacked/Mod-Name/res/assets/frames/ha/mf_napoleon/

It will be automatically added to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>. If you're making an asset pack, the default mod_main that will be used handles this instead.

Warning: If multiple mods add a new resource with the same path + name, only the last one will take effect.

== Remove existing resources ==
''(.png, .svg, .tres, .tscn, .json)''

TODO: some way to mark a resource as something to remove. An extra extension?

== Modify existing resource ==
''(.tres)''

# Navigate to the resource you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Resource Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tres_ext.gd
# Modify the scene through the generated script's modify_resource function, as desired.

For example, to add the Barbarossa as an alt frame of the Napoleon license, find and Create Resource Extension for the li_napoleon.tres. In the resulting li_napoleon.tres_ext.gd file, you would put:

func modify_resource(resource:Resource) -> Resource:
var license:UnlockTree = resource

var barb := load('res://content/frames/ha/mf_barbarossa/mf_barbarossa.tres')
license.rank_2.granted_frames.append(barb)

return license

Note: modify_resource is run after resources are moved in the virtual filesystem from your mod's res/ directory into their res:// locations, so I *believe* that if you load new resources from your mod you should use their res://content/... paths instead of the unpacked location.

To be safe, a function such as this can always return what should be the correct path:

func sload(file: String):
if(ResourceLoader.exists(file)):
return ResourceLoader.load(file)
else:
return ResourceLoader.load('res://'+file.split('/res/')[1])

Then use sload instead of load to load resource references.

This will work even if two different mods extend the same resource.

== Modify existing scenes ==
''(.tscn)''

# Navigate to the scene you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Scene Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tscn_ext.gd
# Modify the scene through the generated script's modify_scene function, as desired.

Note: if you add new nodes to the modified scene, you MUST set the [https://docs.godotengine.org/en/stable/classes/class_node.html#class-node-property-owner owner] of that child to the scene after adding it as a child, e.g.

func modify_scene(scene:Node) -> Node:
# Modify an existing node.
var label: Label = scene_instance.get_node("Maybe/Some/NodeHere")
label.text += " modified"

# Add a new node.
var new_node: Node = Node.new()
scene_instance.add_child(new_node)
new_node.owner = scene # Must come after add_child for all added nodes.

return scene_instance

This will work even if two different mods extend the same scene.

== Extend existing scripts ==
https://wiki.godotmodding.com/guides/modding/script_extensions/

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Script Extension" from the context menu.
# This will create a new script to your mod's folder under res/ + the original path, extending the vanilla script, with the extension .gd_ext.gd
# Modify the extending script in your res/ folder as desired.

This will work even if two different mods extend the same script, via <code>add_overwrite_extend_mod_resources</code>, powered by <code>ModLoaderMod.install_script_extension</code>.

If you change an autoload, that autoload will be reloaded after all mods are applied.

If you find that the autoload's functions do not run your extended code, you may need to manually refresh the script of an autoload after your mod's mod_main._init() function. Example code that does this for the UnitRelation autoload is provided below, you'll need to adjust it to the specific autoloads that you're affecting.
<pre>
func _init() -> void:
ModLoaderLog.info("Activating.", MOD_ID)

LancerTacticsMod.add_translations(MOD_ID)

LancerTacticsMod.add_overwrite_extend_mod_resources(MOD_ID)
# other things might be here
# ...
call_deferred(&"fix_scripts")

func fix_scripts():
#print("fix UnitRelation")
UnitRelation.set_script(load("res://engine/character/unit/service/unit_relation.gd"))
</pre>

WARNING: Due to unknown reasons, if a static function on an autoload calls other static functions on the same autoload more than two function calls deep, it reverts to the original code rather than the extended code. So far no workaround has been discovered.

WARNING: Due to a bug in Godot, we can't extend scripts with a class_name. See [[Modding#Hooks and class name scripts|Hooks and class name scripts]] for details.

== Replace existing scripts ==

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the script to your mod's folder under res/ + the original path.
# Modify the replacing script in your res/ folder as desired.

This will likely conflict with any other mods that also attempt to replace or extend this script. However, this is the only way to change static vars. Godot appears to cache consts at a script-path level, so as far as I can tell there's no way to change a const on an object/script after it's been declared, even by completely replacing the script.

You should very probably include definitions for everything the original script did, or you'll crash as soon as something asks for a now-missing value (unless this replacement is also extending something that covers those functions).

If you change an autoload, that autoload will be reloaded after all mods are applied.

== Localizations & text ==

Generating a mod from a template will create a localization/localizations.csv file in your mod folder. These key/value pairs are used to figure out what text to show in the game for kits/frames/everything. You can see the shipped assets/localization/localizations.csv file for examples of all the base game text.

You can add your own keys in a likewise format in your own file — I recommend an external spreadsheet editor over godot's text editor to automatically handle internal commas and quotation marks. Alternatively, there is a second tab next to the Manifest Editor in the Mod Tool section called "Localization Editor". I haven't thoroughly tested it, but it gives some basic controls for adding new key/values in the expected format and a button to regenerate localizations (possibly necessary to see the changes show up).

== Add custom sound fx ==

https://www.fmod.com/docs/2.01/studio/supporting-downloadable-and-user-generated-content.html

I haven't actually tested it, but if you open the Lancer Tactics FMOD project and export your own bank as described above, you should be able to add your .bank file anywhere in your mod's res/ directory and it'll be automatically picked up and loaded in (and subsequently unloaded if the mod is disabled).

New banks must be named by either prefixing or suffixing the bank they're adding onto. For example, if I'm making a new music bank, since the baseline bank is called "music.bank" mine has to look like "my_music.bank" or "music_thunderdome.bank". This is because the FMOD addon crashes if we ever try to play an event not in the banks so we have to cache what events are available for each category.

If you feel motivated to test this, let me know how it goes!

== Modify how COMP/CON imports pilots ==

Lancer Tactics is strict about what sorts of prefixes it looks for in resources. If you're working with a more loosey-goosey ID that was made for COMP/CON (such as the practice of adding prefixes based on the supplement), you can make a mod that tells LT how to map the C/C ID.

# Extend the compcon_importer script: <code>res://ui/page/pilot_roster/compcon_importer.gd</code>
# Extend the get_compcon_id_remap function.
# Call super.get_compcon_id_remap() within it, then add whatever C/C -> LT IDs to the dictionary that you'd like.

== Player configuration ==
https://wiki.godotmodding.com/guides/modding/config_json/

You can allow the player to configure your mod through inputs in the mod manager, ie, toggle booleans, pick from dropdowns, and enter text+numbers that your mod can then consume.

Define the config as described in the above documentation inside of your manifest.json file, and get the player's current values with <code>ModLoaderConfig.get_current_config("your_mod_id")</code>.

Lancer Tactics currently only supports numbers, strings, and boolean inputs. Let me know if you need more than that!

== Dependencies ==
https://wiki.godotmodding.com/guides/modding/using_other_mods/#dependencies-and-load-order

If your mod requires another mod to function, you need to do two things:

# Add the other mod's folder ID (in the Namespace-ModName format) in the "Dependencies" section of your manifest. This will tell the mod loader to load their mod first.
# Tell mod.io about the dependency by going to <code>mod.io/g/lancer-tactics/m/[YOUR MOD SLUG HERE]/admin/settings#dependencies</code> and selecting the other mod from the search bar.

== Export + upload your mod to share ==

Mods are loaded by player's games by looking for .zip files in their user mods/ folder. In order to get them set up with the mod, we need to create that zip and get it into their folder. There are three options:

=== Manually ===
In the bottom-center of the Mod Tool tab, there's an "Export as .zip" button. Pressing it will pack the current mod into a zip file at the designated location.

You can drag the zipped mod to your own user data mods/ folder, or send it to your friends so they can do so for their own games. No need to get a third party involved.

=== Mod.io, via the Mod Tool ===
In the bottom-right of the Mod Tool tab, there's a "Upload" section.

# Authenticate with mod.io from the Omninet page in the running game, if you haven't already. This will save a token to your settings.cfg
# Verify that it shows you as logged in as the appropriate email, and press "Check status" button to verify your connection to mod.io.
# Press "Upload to mod.io" and confirm.

You should now be able to see and manage your mod online at https://mod.io/content#mods

=== Mod.io, via the browser ===
You can upload a mod from outside the Mod Tool by uploading the exported .zip file you made in the manual option above. Mod.io's flow for doing so is fairly intuitive, but to be loaded by the game you must include this json in the Metadata section for the mod, filling in values as appropriate:
{
"game_version":"X.X.X",
"mod_id":"YourNamespace-YourMod",
"revision":1,
"version":"1.0.0"
}
* game_version: The version of Lancer Tactics you expect this mod to work on.
* mod_id: The ID of your mod, in the Namespace-Modname format (matches its folder when unpacked)
* revision: Doesn't matter too much; just for information. Incremented by the game each time it uploads something new.
* version: The [https://semver.org/ semantic versioning] of your mod.

Modding Cookbook

2026-08-03T21:57:00Z

Darloth: /* Make your mod */ - asset pack issue and workaround

== Make your mod ==

# Get hands on the project source code, hopefully via the modkit download on itch.io or another channel from Wickworks.
# Open it in the Godot editor (4.7 currently)
# Go to Project Settings → Plugins and enable Mod Loader Dev Tool (it'll be the only thing that's unchecked)
# There's now a tab call "Mod Tool" at the top-center of the window. Press the "Create new Mod" button, fill out the fields, and press Create.
## See [[Modding#Mod Types & Security|Mod Types]] for the difference between an Asset Pack, Content Pack, and Substantial mod. You can change what type it is later by adding scripts or toggling requires_restart. NOTE: If you wish to create an Asset Pack, there's currently a bug that will prevent it being created correctly unless you select a Content Pack first, then switch back to Asset Pack.
# Fill out any information you'd like to provide in manifest fields, and press "Save to manifest.json" in the top-right.
# In the FileSystem window, you should see folder with the name of your mod under unpacked/, with a manifest.json and a mod_main.gd file.
# (optional) Update thumbnail.png with the image you want to represent your mod.

== Replace existing resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

# Navigate to the file you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the resource to your mod's folder under res/ + the original path.
# Modify the resource in your res/ folder as desired.

It will be automatically swapped in to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>.

Warning: If multiple mods replace the same resource, only the last one will take effect.

== Add new resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

Add them to your mod's res/ directory in a folder mirroring where they'd be in the base game data. For example, if you wanted to add a new available sprite for the napoleon at:
res://assets/frames/ha/mf_napoleon/

You'd add your image at:
res://unpacked/Mod-Name/res/assets/frames/ha/mf_napoleon/

It will be automatically added to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>. If you're making an asset pack, the default mod_main that will be used handles this instead.

Warning: If multiple mods add a new resource with the same path + name, only the last one will take effect.

== Remove existing resources ==
''(.png, .svg, .tres, .tscn, .json)''

TODO: some way to mark a resource as something to remove. An extra extension?

== Modify existing resource ==
''(.tres)''

# Navigate to the resource you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Resource Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tres_ext.gd
# Modify the scene through the generated script's modify_resource function, as desired.

For example, to add the Barbarossa as an alt frame of the Napoleon license, find and Create Resource Extension for the li_napoleon.tres. In the resulting li_napoleon.tres_ext.gd file, you would put:

func modify_resource(resource:Resource) -> Resource:
var license:UnlockTree = resource

var barb := load('res://content/frames/ha/mf_barbarossa/mf_barbarossa.tres')
license.rank_2.granted_frames.append(barb)

return license

Note: modify_resource is run after resources are moved in the virtual filesystem from your mod's res/ directory into their res:// locations, so I *believe* that if you load new resources from your mod you should use their res://content/... paths instead of the unpacked location.

To be safe, a function such as this can always return what should be the correct path:

func sload(file: String):
if(ResourceLoader.exists(file)):
return ResourceLoader.load(file)
else:
return ResourceLoader.load('res://'+file.split('/res/')[1])

Then use sload instead of load to load resource references.

This will work even if two different mods extend the same resource.

== Modify existing scenes ==
''(.tscn)''

# Navigate to the scene you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Scene Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tscn_ext.gd
# Modify the scene through the generated script's modify_scene function, as desired.

Note: if you add new nodes to the modified scene, you MUST set the [https://docs.godotengine.org/en/stable/classes/class_node.html#class-node-property-owner owner] of that child to the scene after adding it as a child, e.g.

func modify_scene(scene:Node) -> Node:
# Modify an existing node.
var label: Label = scene_instance.get_node("Maybe/Some/NodeHere")
label.text += " modified"

# Add a new node.
var new_node: Node = Node.new()
scene_instance.add_child(new_node)
new_node.owner = scene # Must come after add_child for all added nodes.

return scene_instance

This will work even if two different mods extend the same scene.

== Extend existing scripts ==
https://wiki.godotmodding.com/guides/modding/script_extensions/

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Script Extension" from the context menu.
# This will create a new script to your mod's folder under res/ + the original path, extending the vanilla script, with the extension .gd_ext.gd
# Modify the extending script in your res/ folder as desired.

This will work even if two different mods extend the same script, via <code>add_overwrite_extend_mod_resources</code>, powered by <code>ModLoaderMod.install_script_extension</code>.

If you change an autoload, that autoload will be reloaded after all mods are applied.

If you find that the autoload's functions do not run your extended code, you may need to manually refresh the script of an autoload after your mod's mod_main._init() function. Example code that does this for the UnitRelation autoload is provided below, you'll need to adjust it to the specific autoloads that you're affecting.
<pre>
func _init() -> void:
ModLoaderLog.info("Activating.", MOD_ID)

LancerTacticsMod.add_translations(MOD_ID)

LancerTacticsMod.add_overwrite_extend_mod_resources(MOD_ID)
# other things might be here
# ...
call_deferred(&"fix_scripts")

func fix_scripts():
#print("fix UnitRelation")
UnitRelation.set_script(load("res://engine/character/unit/service/unit_relation.gd"))
</pre>

WARNING: Due to unknown reasons, if a static function on an autoload calls other static functions on the same autoload more than two function calls deep, it reverts to the original code rather than the extended code. So far no workaround has been discovered.

WARNING: Due to a bug in Godot, we can't extend scripts with a class_name. See [[Modding#Hooks and class name scripts|Hooks and class name scripts]] for details.

== Replace existing scripts ==

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the script to your mod's folder under res/ + the original path.
# Modify the replacing script in your res/ folder as desired.

This will likely conflict with any other mods that also attempt to replace or extend this script. However, this is the only way to change static vars. Godot appears to cache consts at a script-path level, so as far as I can tell there's no way to change a const on an object/script after it's been declared, even by completely replacing the script.

You should very probably include definitions for everything the original script did, or you'll crash as soon as something asks for a now-missing value (unless this replacement is also extending something that covers those functions).

If you change an autoload, that autoload will be reloaded after all mods are applied.

== Localizations & text ==

Generating a mod from a template will create a localization/localizations.csv file in your mod folder. These key/value pairs are used to figure out what text to show in the game for kits/frames/everything. You can see the shipped assets/localization/localizations.csv file for examples of all the base game text.

You can add your own keys in a likewise format in your own file — I recommend an external spreadsheet editor over godot's text editor to automatically handle internal commas and quotation marks. Alternatively, there is a second tab next to the Manifest Editor in the Mod Tool section called "Localization Editor". I haven't thoroughly tested it, but it gives some basic controls for adding new key/values in the expected format and a button to regenerate localizations (possibly necessary to see the changes show up).

== Add custom sound fx ==

https://www.fmod.com/docs/2.01/studio/supporting-downloadable-and-user-generated-content.html

I haven't actually tested it, but if you open the Lancer Tactics FMOD project and export your own bank as described above, you should be able to add your .bank file anywhere in your mod's res/ directory and it'll be automatically picked up and loaded in (and subsequently unloaded if the mod is disabled).

New banks must be named by either prefixing or suffixing the bank they're adding onto. For example, if I'm making a new music bank, since the baseline bank is called "music.bank" mine has to look like "my_music.bank" or "music_thunderdome.bank". This is because the FMOD addon crashes if we ever try to play an event not in the banks so we have to cache what events are available for each category.

If you feel motivated to test this, let me know how it goes!

== Modify how COMP/CON imports pilots ==

Lancer Tactics is strict about what sorts of prefixes it looks for in resources. If you're working with a more loosey-goosey ID that was made for COMP/CON (such as the practice of adding prefixes based on the supplement), you can make a mod that tells LT how to map the C/C ID.

# Extend the compcon_importer script: <code>res://ui/page/pilot_roster/compcon_importer.gd</code>
# Extend the get_compcon_id_remap function.
# Call super.get_compcon_id_remap() within it, then add whatever C/C -> LT IDs to the dictionary that you'd like.

== Player configuration ==
https://wiki.godotmodding.com/guides/modding/config_json/

You can allow the player to configure your mod through inputs in the mod manager, ie, toggle booleans, pick from dropdowns, and enter text+numbers that your mod can then consume.

Define the config as described in the above documentation inside of your manifest.json file, and get the player's current values with <code>ModLoaderConfig.get_current_config("your_mod_id")</code>.

Lancer Tactics currently only supports numbers, strings, and boolean inputs. Let me know if you need more than that!

== Dependencies ==
https://wiki.godotmodding.com/guides/modding/using_other_mods/#dependencies-and-load-order

If your mod requires another mod to function, you need to do two things:

# Add the other mod's folder ID (in the Namespace-ModName format) in the "Dependencies" section of your manifest. This will tell the mod loader to load their mod first.
# Tell mod.io about the dependency by going to <code>mod.io/g/lancer-tactics/m/[YOUR MOD SLUG HERE]/admin/settings#dependencies</code> and selecting the other mod from the search bar.

== Export + upload your mod to share ==

Mods are loaded by player's games by looking for .zip files in their user mods/ folder. In order to get them set up with the mod, we need to create that zip and get it into their folder. There are three options:

=== Manually ===
In the bottom-center of the Mod Tool tab, there's an "Export as .zip" button. Pressing it will pack the current mod into a zip file at the designated location.

You can drag the zipped mod to your own user data mods/ folder, or send it to your friends so they can do so for their own games. No need to get a third party involved.

=== Mod.io, via the Mod Tool ===
In the bottom-right of the Mod Tool tab, there's a "Upload" section.

# Authenticate with mod.io from the Omninet page in the running game, if you haven't already. This will save a token to your settings.cfg
# Verify that it shows you as logged in as the appropriate email, and press "Check status" button to verify your connection to mod.io.
# Press "Upload to mod.io" and confirm.

You should now be able to see and manage your mod online at https://mod.io/content#mods

=== Mod.io, via the browser ===
You can upload a mod from outside the Mod Tool by uploading the exported .zip file you made in the manual option above. Mod.io's flow for doing so is fairly intuitive, but to be loaded by the game you must include this json in the Metadata section for the mod, filling in values as appropriate:
{
"game_version":"X.X.X",
"mod_id":"YourNamespace-YourMod",
"revision":1,
"version":"1.0.0"
}
* game_version: The version of Lancer Tactics you expect this mod to work on.
* mod_id: The ID of your mod, in the Namespace-Modname format (matches its folder when unpacked)
* revision: Doesn't matter too much; just for information. Incremented by the game each time it uploads something new.
* version: The [https://semver.org/ semantic versioning] of your mod.

Modding Cookbook

2026-08-03T21:09:10Z

Darloth: /* Extend existing scripts */ - explaining fix for autoloads that don't get modified properly when you modify them

== Make your mod ==

# Get hands on the project source code, hopefully via the modkit download on itch.io or another channel from Wickworks.
# Open it in the Godot editor (4.7 currently)
# Go to Project Settings → Plugins and enable Mod Loader Dev Tool (it'll be the only thing that's unchecked)
# There's now a tab call "Mod Tool" at the top-center of the window. Press the "Create new Mod" button, fill out the fields, and press Create.
## See [[Modding#Mod Types & Security|Mod Types]] for the difference between an Asset Pack, Content Pack, and Substantial mod. You can change what type it is later by adding scripts or toggling requires_restart.
# Fill out any information you'd like to provide in manifest fields, and press "Save to manifest.json" in the top-right.
# In the FileSystem window, you should see folder with the name of your mod under unpacked/, with a manifest.json and a mod_main.gd file.
# (optional) Update thumbnail.png with the image you want to represent your mod.

== Replace existing resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

# Navigate to the file you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the resource to your mod's folder under res/ + the original path.
# Modify the resource in your res/ folder as desired.

It will be automatically swapped in to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>.

Warning: If multiple mods replace the same resource, only the last one will take effect.

== Add new resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

Add them to your mod's res/ directory in a folder mirroring where they'd be in the base game data. For example, if you wanted to add a new available sprite for the napoleon at:
res://assets/frames/ha/mf_napoleon/

You'd add your image at:
res://unpacked/Mod-Name/res/assets/frames/ha/mf_napoleon/

It will be automatically added to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>. If you're making an asset pack, the default mod_main that will be used handles this instead.

Warning: If multiple mods add a new resource with the same path + name, only the last one will take effect.

== Remove existing resources ==
''(.png, .svg, .tres, .tscn, .json)''

TODO: some way to mark a resource as something to remove. An extra extension?

== Modify existing resource ==
''(.tres)''

# Navigate to the resource you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Resource Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tres_ext.gd
# Modify the scene through the generated script's modify_resource function, as desired.

For example, to add the Barbarossa as an alt frame of the Napoleon license, find and Create Resource Extension for the li_napoleon.tres. In the resulting li_napoleon.tres_ext.gd file, you would put:

func modify_resource(resource:Resource) -> Resource:
var license:UnlockTree = resource

var barb := load('res://content/frames/ha/mf_barbarossa/mf_barbarossa.tres')
license.rank_2.granted_frames.append(barb)

return license

Note: modify_resource is run after resources are moved in the virtual filesystem from your mod's res/ directory into their res:// locations, so I *believe* that if you load new resources from your mod you should use their res://content/... paths instead of the unpacked location.

To be safe, a function such as this can always return what should be the correct path:

func sload(file: String):
if(ResourceLoader.exists(file)):
return ResourceLoader.load(file)
else:
return ResourceLoader.load('res://'+file.split('/res/')[1])

Then use sload instead of load to load resource references.

This will work even if two different mods extend the same resource.

== Modify existing scenes ==
''(.tscn)''

# Navigate to the scene you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Scene Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tscn_ext.gd
# Modify the scene through the generated script's modify_scene function, as desired.

Note: if you add new nodes to the modified scene, you MUST set the [https://docs.godotengine.org/en/stable/classes/class_node.html#class-node-property-owner owner] of that child to the scene after adding it as a child, e.g.

func modify_scene(scene:Node) -> Node:
# Modify an existing node.
var label: Label = scene_instance.get_node("Maybe/Some/NodeHere")
label.text += " modified"

# Add a new node.
var new_node: Node = Node.new()
scene_instance.add_child(new_node)
new_node.owner = scene # Must come after add_child for all added nodes.

return scene_instance

This will work even if two different mods extend the same scene.

== Extend existing scripts ==
https://wiki.godotmodding.com/guides/modding/script_extensions/

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Script Extension" from the context menu.
# This will create a new script to your mod's folder under res/ + the original path, extending the vanilla script, with the extension .gd_ext.gd
# Modify the extending script in your res/ folder as desired.

This will work even if two different mods extend the same script, via <code>add_overwrite_extend_mod_resources</code>, powered by <code>ModLoaderMod.install_script_extension</code>.

If you change an autoload, that autoload will be reloaded after all mods are applied.

If you find that the autoload's functions do not run your extended code, you may need to manually refresh the script of an autoload after your mod's mod_main._init() function. Example code that does this for the UnitRelation autoload is provided below, you'll need to adjust it to the specific autoloads that you're affecting.
<pre>
func _init() -> void:
ModLoaderLog.info("Activating.", MOD_ID)

LancerTacticsMod.add_translations(MOD_ID)

LancerTacticsMod.add_overwrite_extend_mod_resources(MOD_ID)
# other things might be here
# ...
call_deferred(&"fix_scripts")

func fix_scripts():
#print("fix UnitRelation")
UnitRelation.set_script(load("res://engine/character/unit/service/unit_relation.gd"))
</pre>

WARNING: Due to unknown reasons, if a static function on an autoload calls other static functions on the same autoload more than two function calls deep, it reverts to the original code rather than the extended code. So far no workaround has been discovered.

WARNING: Due to a bug in Godot, we can't extend scripts with a class_name. See [[Modding#Hooks and class name scripts|Hooks and class name scripts]] for details.

== Replace existing scripts ==

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the script to your mod's folder under res/ + the original path.
# Modify the replacing script in your res/ folder as desired.

This will likely conflict with any other mods that also attempt to replace or extend this script. However, this is the only way to change static vars. Godot appears to cache consts at a script-path level, so as far as I can tell there's no way to change a const on an object/script after it's been declared, even by completely replacing the script.

You should very probably include definitions for everything the original script did, or you'll crash as soon as something asks for a now-missing value (unless this replacement is also extending something that covers those functions).

If you change an autoload, that autoload will be reloaded after all mods are applied.

== Localizations & text ==

Generating a mod from a template will create a localization/localizations.csv file in your mod folder. These key/value pairs are used to figure out what text to show in the game for kits/frames/everything. You can see the shipped assets/localization/localizations.csv file for examples of all the base game text.

You can add your own keys in a likewise format in your own file — I recommend an external spreadsheet editor over godot's text editor to automatically handle internal commas and quotation marks. Alternatively, there is a second tab next to the Manifest Editor in the Mod Tool section called "Localization Editor". I haven't thoroughly tested it, but it gives some basic controls for adding new key/values in the expected format and a button to regenerate localizations (possibly necessary to see the changes show up).

== Add custom sound fx ==

https://www.fmod.com/docs/2.01/studio/supporting-downloadable-and-user-generated-content.html

I haven't actually tested it, but if you open the Lancer Tactics FMOD project and export your own bank as described above, you should be able to add your .bank file anywhere in your mod's res/ directory and it'll be automatically picked up and loaded in (and subsequently unloaded if the mod is disabled).

New banks must be named by either prefixing or suffixing the bank they're adding onto. For example, if I'm making a new music bank, since the baseline bank is called "music.bank" mine has to look like "my_music.bank" or "music_thunderdome.bank". This is because the FMOD addon crashes if we ever try to play an event not in the banks so we have to cache what events are available for each category.

If you feel motivated to test this, let me know how it goes!

== Modify how COMP/CON imports pilots ==

Lancer Tactics is strict about what sorts of prefixes it looks for in resources. If you're working with a more loosey-goosey ID that was made for COMP/CON (such as the practice of adding prefixes based on the supplement), you can make a mod that tells LT how to map the C/C ID.

# Extend the compcon_importer script: <code>res://ui/page/pilot_roster/compcon_importer.gd</code>
# Extend the get_compcon_id_remap function.
# Call super.get_compcon_id_remap() within it, then add whatever C/C -> LT IDs to the dictionary that you'd like.

== Player configuration ==
https://wiki.godotmodding.com/guides/modding/config_json/

You can allow the player to configure your mod through inputs in the mod manager, ie, toggle booleans, pick from dropdowns, and enter text+numbers that your mod can then consume.

Define the config as described in the above documentation inside of your manifest.json file, and get the player's current values with <code>ModLoaderConfig.get_current_config("your_mod_id")</code>.

Lancer Tactics currently only supports numbers, strings, and boolean inputs. Let me know if you need more than that!

== Dependencies ==
https://wiki.godotmodding.com/guides/modding/using_other_mods/#dependencies-and-load-order

If your mod requires another mod to function, you need to do two things:

# Add the other mod's folder ID (in the Namespace-ModName format) in the "Dependencies" section of your manifest. This will tell the mod loader to load their mod first.
# Tell mod.io about the dependency by going to <code>mod.io/g/lancer-tactics/m/[YOUR MOD SLUG HERE]/admin/settings#dependencies</code> and selecting the other mod from the search bar.

== Export + upload your mod to share ==

Mods are loaded by player's games by looking for .zip files in their user mods/ folder. In order to get them set up with the mod, we need to create that zip and get it into their folder. There are three options:

=== Manually ===
In the bottom-center of the Mod Tool tab, there's an "Export as .zip" button. Pressing it will pack the current mod into a zip file at the designated location.

You can drag the zipped mod to your own user data mods/ folder, or send it to your friends so they can do so for their own games. No need to get a third party involved.

=== Mod.io, via the Mod Tool ===
In the bottom-right of the Mod Tool tab, there's a "Upload" section.

# Authenticate with mod.io from the Omninet page in the running game, if you haven't already. This will save a token to your settings.cfg
# Verify that it shows you as logged in as the appropriate email, and press "Check status" button to verify your connection to mod.io.
# Press "Upload to mod.io" and confirm.

You should now be able to see and manage your mod online at https://mod.io/content#mods

=== Mod.io, via the browser ===
You can upload a mod from outside the Mod Tool by uploading the exported .zip file you made in the manual option above. Mod.io's flow for doing so is fairly intuitive, but to be loaded by the game you must include this json in the Metadata section for the mod, filling in values as appropriate:
{
"game_version":"X.X.X",
"mod_id":"YourNamespace-YourMod",
"revision":1,
"version":"1.0.0"
}
* game_version: The version of Lancer Tactics you expect this mod to work on.
* mod_id: The ID of your mod, in the Namespace-Modname format (matches its folder when unpacked)
* revision: Doesn't matter too much; just for information. Incremented by the game each time it uploads something new.
* version: The [https://semver.org/ semantic versioning] of your mod.

Modding Cookbook

2026-08-03T20:26:14Z

Darloth: /* Modify existing resource */ More detail

== Make your mod ==

# Get hands on the project source code, hopefully via the modkit download on itch.io or another channel from Wickworks.
# Open it in the Godot editor (4.7 currently)
# Go to Project Settings → Plugins and enable Mod Loader Dev Tool (it'll be the only thing that's unchecked)
# There's now a tab call "Mod Tool" at the top-center of the window. Press the "Create new Mod" button, fill out the fields, and press Create.
## See [[Modding#Mod Types & Security|Mod Types]] for the difference between an Asset Pack, Content Pack, and Substantial mod. You can change what type it is later by adding scripts or toggling requires_restart.
# Fill out any information you'd like to provide in manifest fields, and press "Save to manifest.json" in the top-right.
# In the FileSystem window, you should see folder with the name of your mod under unpacked/, with a manifest.json and a mod_main.gd file.
# (optional) Update thumbnail.png with the image you want to represent your mod.

== Replace existing resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

# Navigate to the file you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the resource to your mod's folder under res/ + the original path.
# Modify the resource in your res/ folder as desired.

It will be automatically swapped in to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>.

Warning: If multiple mods replace the same resource, only the last one will take effect.

== Add new resources and scenes ==
''(.png, .svg, .tres, .tscn, .json)''

Add them to your mod's res/ directory in a folder mirroring where they'd be in the base game data. For example, if you wanted to add a new available sprite for the napoleon at:
res://assets/frames/ha/mf_napoleon/

You'd add your image at:
res://unpacked/Mod-Name/res/assets/frames/ha/mf_napoleon/

It will be automatically added to the game's virtual filesystem at the vanilla path when the mod is activated by your mod_main.gd's <code>add_overwrite_extend_mod_resources</code>, powered by <code>Resource.take_over_path</code>. If you're making an asset pack, the default mod_main that will be used handles this instead.

Warning: If multiple mods add a new resource with the same path + name, only the last one will take effect.

== Remove existing resources ==
''(.png, .svg, .tres, .tscn, .json)''

TODO: some way to mark a resource as something to remove. An extra extension?

== Modify existing resource ==
''(.tres)''

# Navigate to the resource you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Resource Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tres_ext.gd
# Modify the scene through the generated script's modify_resource function, as desired.

For example, to add the Barbarossa as an alt frame of the Napoleon license, find and Create Resource Extension for the li_napoleon.tres. In the resulting li_napoleon.tres_ext.gd file, you would put:

func modify_resource(resource:Resource) -> Resource:
var license:UnlockTree = resource

var barb := load('res://content/frames/ha/mf_barbarossa/mf_barbarossa.tres')
license.rank_2.granted_frames.append(barb)

return license

Note: modify_resource is run after resources are moved in the virtual filesystem from your mod's res/ directory into their res:// locations, so I *believe* that if you load new resources from your mod you should use their res://content/... paths instead of the unpacked location.

To be safe, a function such as this can always return what should be the correct path:

func sload(file: String):
if(ResourceLoader.exists(file)):
return ResourceLoader.load(file)
else:
return ResourceLoader.load('res://'+file.split('/res/')[1])

Then use sload instead of load to load resource references.

This will work even if two different mods extend the same resource.

== Modify existing scenes ==
''(.tscn)''

# Navigate to the scene you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Scene Extension" from the context menu.
# This will create a new script in your mod's folder under res/ + the original path, with the extension .tscn_ext.gd
# Modify the scene through the generated script's modify_scene function, as desired.

Note: if you add new nodes to the modified scene, you MUST set the [https://docs.godotengine.org/en/stable/classes/class_node.html#class-node-property-owner owner] of that child to the scene after adding it as a child, e.g.

func modify_scene(scene:Node) -> Node:
# Modify an existing node.
var label: Label = scene_instance.get_node("Maybe/Some/NodeHere")
label.text += " modified"

# Add a new node.
var new_node: Node = Node.new()
scene_instance.add_child(new_node)
new_node.owner = scene # Must come after add_child for all added nodes.

return scene_instance

This will work even if two different mods extend the same scene.

== Extend existing scripts ==
https://wiki.godotmodding.com/guides/modding/script_extensions/

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Script Extension" from the context menu.
# This will create a new script to your mod's folder under res/ + the original path, extending the vanilla script, with the extension .gd_ext.gd
# Modify the extending script in your res/ folder as desired.

This will work even if two different mods extend the same script, via <code>add_overwrite_extend_mod_resources</code>, powered by <code>ModLoaderMod.install_script_extension</code>.

If you change an autoload, that autoload will be reloaded after all mods are applied.

WARNING: Due to a bug in Godot, we can't extend scripts with a class_name. See [[Modding#Hooks and class name scripts|Hooks and class name scripts]] for details.

== Replace existing scripts ==

# Navigate to the script you want to replace in the FileSystem window.
# Right-click it and select "ModTool: Create Asset Override" from the context menu.
# This will copy the script to your mod's folder under res/ + the original path.
# Modify the replacing script in your res/ folder as desired.

This will likely conflict with any other mods that also attempt to replace or extend this script. However, this is the only way to change static vars. Godot appears to cache consts at a script-path level, so as far as I can tell there's no way to change a const on an object/script after it's been declared, even by completely replacing the script.

You should very probably include definitions for everything the original script did, or you'll crash as soon as something asks for a now-missing value (unless this replacement is also extending something that covers those functions).

If you change an autoload, that autoload will be reloaded after all mods are applied.

== Localizations & text ==

Generating a mod from a template will create a localization/localizations.csv file in your mod folder. These key/value pairs are used to figure out what text to show in the game for kits/frames/everything. You can see the shipped assets/localization/localizations.csv file for examples of all the base game text.

You can add your own keys in a likewise format in your own file — I recommend an external spreadsheet editor over godot's text editor to automatically handle internal commas and quotation marks. Alternatively, there is a second tab next to the Manifest Editor in the Mod Tool section called "Localization Editor". I haven't thoroughly tested it, but it gives some basic controls for adding new key/values in the expected format and a button to regenerate localizations (possibly necessary to see the changes show up).

== Add custom sound fx ==

https://www.fmod.com/docs/2.01/studio/supporting-downloadable-and-user-generated-content.html

I haven't actually tested it, but if you open the Lancer Tactics FMOD project and export your own bank as described above, you should be able to add your .bank file anywhere in your mod's res/ directory and it'll be automatically picked up and loaded in (and subsequently unloaded if the mod is disabled).

New banks must be named by either prefixing or suffixing the bank they're adding onto. For example, if I'm making a new music bank, since the baseline bank is called "music.bank" mine has to look like "my_music.bank" or "music_thunderdome.bank". This is because the FMOD addon crashes if we ever try to play an event not in the banks so we have to cache what events are available for each category.

If you feel motivated to test this, let me know how it goes!

== Modify how COMP/CON imports pilots ==

Lancer Tactics is strict about what sorts of prefixes it looks for in resources. If you're working with a more loosey-goosey ID that was made for COMP/CON (such as the practice of adding prefixes based on the supplement), you can make a mod that tells LT how to map the C/C ID.

# Extend the compcon_importer script: <code>res://ui/page/pilot_roster/compcon_importer.gd</code>
# Extend the get_compcon_id_remap function.
# Call super.get_compcon_id_remap() within it, then add whatever C/C -> LT IDs to the dictionary that you'd like.

== Player configuration ==
https://wiki.godotmodding.com/guides/modding/config_json/

You can allow the player to configure your mod through inputs in the mod manager, ie, toggle booleans, pick from dropdowns, and enter text+numbers that your mod can then consume.

Define the config as described in the above documentation inside of your manifest.json file, and get the player's current values with <code>ModLoaderConfig.get_current_config("your_mod_id")</code>.

Lancer Tactics currently only supports numbers, strings, and boolean inputs. Let me know if you need more than that!

== Dependencies ==
https://wiki.godotmodding.com/guides/modding/using_other_mods/#dependencies-and-load-order

If your mod requires another mod to function, you need to do two things:

# Add the other mod's folder ID (in the Namespace-ModName format) in the "Dependencies" section of your manifest. This will tell the mod loader to load their mod first.
# Tell mod.io about the dependency by going to <code>mod.io/g/lancer-tactics/m/[YOUR MOD SLUG HERE]/admin/settings#dependencies</code> and selecting the other mod from the search bar.

== Export + upload your mod to share ==

Mods are loaded by player's games by looking for .zip files in their user mods/ folder. In order to get them set up with the mod, we need to create that zip and get it into their folder. There are three options:

=== Manually ===
In the bottom-center of the Mod Tool tab, there's an "Export as .zip" button. Pressing it will pack the current mod into a zip file at the designated location.

You can drag the zipped mod to your own user data mods/ folder, or send it to your friends so they can do so for their own games. No need to get a third party involved.

=== Mod.io, via the Mod Tool ===
In the bottom-right of the Mod Tool tab, there's a "Upload" section.

# Authenticate with mod.io from the Omninet page in the running game, if you haven't already. This will save a token to your settings.cfg
# Verify that it shows you as logged in as the appropriate email, and press "Check status" button to verify your connection to mod.io.
# Press "Upload to mod.io" and confirm.

You should now be able to see and manage your mod online at https://mod.io/content#mods

=== Mod.io, via the browser ===
You can upload a mod from outside the Mod Tool by uploading the exported .zip file you made in the manual option above. Mod.io's flow for doing so is fairly intuitive, but to be loaded by the game you must include this json in the Metadata section for the mod, filling in values as appropriate:
{
"game_version":"X.X.X",
"mod_id":"YourNamespace-YourMod",
"revision":1,
"version":"1.0.0"
}
* game_version: The version of Lancer Tactics you expect this mod to work on.
* mod_id: The ID of your mod, in the Namespace-Modname format (matches its folder when unpacked)
* revision: Doesn't matter too much; just for information. Incremented by the game each time it uploads something new.
* version: The [https://semver.org/ semantic versioning] of your mod.

The Muse

2026-07-31T17:07:42Z

Darloth: /* Editors */ - link to basics of module creation guide

The Muse (aka the Lancer Tactics Wiki) is a compilation of editor documentation and guides for [https://lancertactics.com/ Lancer Tactics], a video game adaptation of the [https://massifpress.com/lancer Lancer TTRPG] by Tom Bloom and Miguel Lopez-Hall. The in-universe concept of the Muse is from the [https://vexwerewolf.itch.io/in-golden-flame-act-1 In Golden Flame] module by Vex Werewolf.

== Modding ==
* [[Modding EULA]]
* [[Modding|Introduction to modding]]
* [[Modding Cookbook]]
* [[Basic Troubleshooting]]
* [[Fx Groups]]
* [[Localization and Text Highlighting]]
* [[Pixel Art]]
* [[Adding a new License]]

== Editors ==
* [[Module Editor]]
** [[Basics of Module Creation]]
* [[Combat Editor Cookbook]]
* [[Editor Triggers|Editor Triggers List]]
* [[Playtesting|Playtesting tips]]

== Other ==
* [[Changes from the TTRPG]]

== External Links & Resources ==
* [https://wick.works/devlog/category/lancer-tactics Devlog at wick.works]
* [https://discord.com/invite/2t7Efg2Fbj Lancer Tactics Discord]
* [https://wick.itch.io/lancer-tactics/community itch.io forums]
* [https://wick.itch.io/lancer-tactics itch.io store page]
* [https://store.steampowered.com/app/4049810/Lancer_Tactics/ Wishlist on Steam]
* [https://mod.io/g/lancer-tactics Lancer Tactics on mod.io]
* [https://compcon.app/ COMP/CON]

''Lancer Tactics is not an official Lancer product; it is a third party work, and is not affiliated with Massif Press. Lancer Tactics is published via the Lancer Third Party License. Lancer is copyright Massif Press.''

Adding a new License

2026-07-22T22:53:21Z

Darloth: Added content section, link to Take your Balor to work day.

Possibly one of the most common things a piece of Lancer content will do is define a new license players can take ranks in, and so here is a quick summary of the typical tasks necessary to make a mod that does just that.

This won't cover specifics of how to implement any particular license, but will lay out the steps necessary for any and every license.

Before you begin, it's a good idea to read through the [[Modding|Introduction to Modding]] if you haven't already, as that covers all the basic concepts of using Godot as a modding environment and the mod tool that Lancer Tactics has in support of that.

== Requirements ==

For a license to show up in the game, it requires at least the main li_[licensename].tres file, and usually several other things:

* An UnlockTree Resource for the license itself, saved as a file following the naming convention li_[licensename].tres, usually placed in the res/content/licenses/[manufacturer]/ subfolder.
** An icon for that UnlockTree - an Everest icon will be substituted here if there is no icon, but that makes it confusing to use. Typically the icon here is the same as the granted frame for the license, though this isn't a hard requirement. This is the icon that will show up in the license wheel.
** an UnlockRank Resource for each of the three ranks of the license. These are usually defined inline in the inspector, without being saved as separate files.
*** Two pieces of gear in the GrantedGear array of each UnlockRank. The game will load and display the license without them, but it will have obviously missing data, and will not seem finished.
*** An icon for each rank is nice, though the defaults do work
*** A frame at rank 2, in the GrantedFrames array. In theory this could be inline, but in practice a mf_[framename].tres file is selected or drag-dropped into here to specify the link to the frame.

If your license is within any of the existing big-4 manufacturer folders or the gms folder, it should be automatically picked up by the resource group addon and loaded as a license for that manufacturer by the mod support code.

On the other hand, if you're adding your own manufacturer, that will require additional files:

* A man_[manufacturername].tres Manufacturer Resource file saved in the res/content/manufacturers/ folder.
** An icon for that manufacturer, which will be used for the selection button for it.
** A link to the ResourceGroup file which tells the game how to find content for that manufacturer, see below
* A ResourceGroup file in the same location as the Manufacturer resource. This is a special type of file that the Resource Group addon edits every time the project is run, and collects all resource files within a certain set of subdirectories usually specified via a search string. For example, the resgrp_man_horus.tres file has the filter <code>**/horus/**.tres</code> which picks up every resource file (they have the .tres extension) under any directory path including a /horus/ directory, such as /res/content/licenses/'''horus'''/li_goblin.tres and many others. Whenever the game is started, it builds a list of these resource files and adds it to the set of paths stored in the resource group, and those are associated with the manufacturer. There's also an exclude list, typically excluding files starting with <code>buff_</code> or <code>action_</code>, as those are not items that belong to the manufacturer and could be found in menus, but used by the game to make things happen.

== Content ==

Actual content that goes in the license is usually distributed over a variety of locations - frames go in the frames folder, gear has its own folder, each with subfolders for individual frames or frame powers or gear items and so on. The most generic of these will not require any custom scripting, just making a new Kit resource, saving it to the right location with the right naming convention, and adjusting numbers and adding inline subresources, but most interesting abilities will also require .gd script files to modify the behaviour of the game to follow whatever specific rules the content item has.

Olive's [https://wick.works/devlog/take-your-balor-to-work-day Take your Balor to work day] is a great example of the process of adding and developing the Balor license, and reading that is probably a good start to help making your own.

Adding a new License

2026-07-22T22:32:09Z

Darloth: Forgot how to do link formatting it seems, fixed.

Adding a new License

2026-07-22T22:30:04Z

Darloth: Bold looks better than italic, actually.

Possibly one of the most common things a piece of Lancer content will do is define a new license players can take ranks in, and so here is a quick summary of the typical tasks necessary to make a mod that does just that.

This won't cover specifics of how to implement any particular license, but will lay out the steps necessary for any and every license.

Before you begin, it's a good idea to read through the [[Modding/Introduction to Modding]] if you haven't already, as that covers all the basic concepts of using Godot as a modding environment and the mod tool that Lancer Tactics has in support of that.

== Requirements ==

For a license to show up in the game, it requires at least the main li_[licensename].tres file, and usually several other things:

* An UnlockTree Resource for the license itself, saved as a file following the naming convention li_[licensename].tres, usually placed in the res/content/licenses/[manufacturer]/ subfolder.
** An icon for that UnlockTree - an Everest icon will be substituted here if there is no icon, but that makes it confusing to use. Typically the icon here is the same as the granted frame for the license, though this isn't a hard requirement. This is the icon that will show up in the license wheel.
** an UnlockRank Resource for each of the three ranks of the license. These are usually defined inline in the inspector, without being saved as separate files.
*** Two pieces of gear in the GrantedGear array of each UnlockRank. The game will load and display the license without them, but it will have obviously missing data, and will not seem finished.
*** An icon for each rank is nice, though the defaults do work
*** A frame at rank 2, in the GrantedFrames array. In theory this could be inline, but in practice a mf_[framename].tres file is selected or drag-dropped into here to specify the link to the frame.

If your license is within any of the existing big-4 manufacturer folders or the gms folder, it should be automatically picked up by the resource group addon and loaded as a license for that manufacturer by the mod support code.

On the other hand, if you're adding your own manufacturer, that will require additional files:

* A man_[manufacturername].tres Manufacturer Resource file saved in the res/content/manufacturers/ folder.
** An icon for that manufacturer, which will be used for the selection button for it.
** A link to the ResourceGroup file which tells the game how to find content for that manufacturer, see below
* A ResourceGroup file in the same location as the Manufacturer resource. This is a special type of file that the Resource Group addon edits every time the project is run, and collects all resource files within a certain set of subdirectories usually specified via a search string. For example, the resgrp_man_horus.tres file has the filter <code>**/horus/**.tres</code> which picks up every resource file (they have the .tres extension) under any directory path including a /horus/ directory, such as /res/content/licenses/'''horus'''/li_goblin.tres and many others. Whenever the game is started, it builds a list of these resource files and adds it to the set of paths stored in the resource group, and those are associated with the manufacturer. There's also an exclude list, typically excluding files starting with <code>buff_</code> or <code>action_</code>, as those are not items that belong to the manufacturer and could be found in menus, but used by the game to make things happen.

Adding a new License

2026-07-22T22:29:43Z

Darloth: Better formatting

Possibly one of the most common things a piece of Lancer content will do is define a new license players can take ranks in, and so here is a quick summary of the typical tasks necessary to make a mod that does just that.

This won't cover specifics of how to implement any particular license, but will lay out the steps necessary for any and every license.

Before you begin, it's a good idea to read through the [[Modding/Introduction to Modding]] if you haven't already, as that covers all the basic concepts of using Godot as a modding environment and the mod tool that Lancer Tactics has in support of that.

== Requirements ==

For a license to show up in the game, it requires at least the main li_[licensename].tres file, and usually several other things:

* An UnlockTree Resource for the license itself, saved as a file following the naming convention li_[licensename].tres, usually placed in the res/content/licenses/[manufacturer]/ subfolder.
** An icon for that UnlockTree - an Everest icon will be substituted here if there is no icon, but that makes it confusing to use. Typically the icon here is the same as the granted frame for the license, though this isn't a hard requirement. This is the icon that will show up in the license wheel.
** an UnlockRank Resource for each of the three ranks of the license. These are usually defined inline in the inspector, without being saved as separate files.
*** Two pieces of gear in the GrantedGear array of each UnlockRank. The game will load and display the license without them, but it will have obviously missing data, and will not seem finished.
*** An icon for each rank is nice, though the defaults do work
*** A frame at rank 2, in the GrantedFrames array. In theory this could be inline, but in practice a mf_[framename].tres file is selected or drag-dropped into here to specify the link to the frame.

If your license is within any of the existing big-4 manufacturer folders or the gms folder, it should be automatically picked up by the resource group addon and loaded as a license for that manufacturer by the mod support code.

On the other hand, if you're adding your own manufacturer, that will require additional files:

* A man_[manufacturername].tres Manufacturer Resource file saved in the res/content/manufacturers/ folder.
** An icon for that manufacturer, which will be used for the selection button for it.
** A link to the ResourceGroup file which tells the game how to find content for that manufacturer, see below
* A ResourceGroup file in the same location as the Manufacturer resource. This is a special type of file that the Resource Group addon edits every time the project is run, and collects all resource files within a certain set of subdirectories usually specified via a search string. For example, the resgrp_man_horus.tres file has the filter <code>**/horus/**.tres</code> which picks up every resource file (they have the .tres extension) under any directory path including a /horus/ directory, such as /res/content/licenses/''horus''/li_goblin.tres and many others. Whenever the game is started, it builds a list of these resource files and adds it to the set of paths stored in the resource group, and those are associated with the manufacturer. There's also an exclude list, typically excluding files starting with <code>buff_</code> or <code>action_</code>, as those are not items that belong to the manufacturer and could be found in menus, but used by the game to make things happen.

Adding a new License

2026-07-22T22:27:15Z

Darloth: Added basic summary of what's needed

Possibly one of the most common things a piece of Lancer content will do is define a new license players can take ranks in, and so here is a quick summary of the typical tasks necessary to make a mod that does just that.

This won't cover specifics of how to implement any particular license, but will lay out the steps necessary for any and every license.

Before you begin, it's a good idea to read through the [[Modding/Introduction to Modding]] if you haven't already, as that covers all the basic concepts of using Godot as a modding environment and the mod tool that Lancer Tactics has in support of that.

== Requirements ==

For a license to show up in the game, it requires at least the main li_[licensename].tres file, and usually several other things:

* An UnlockTree Resource for the license itself, saved as a file following the naming convention li_[licensename].tres, usually placed in the res/content/licenses/[manufacturer]/ subfolder.
** An icon for that UnlockTree - an Everest icon will be substituted here if there is no icon, but that makes it confusing to use. Typically the icon here is the same as the granted frame for the license, though this isn't a hard requirement. This is the icon that will show up in the license wheel.
** an UnlockRank Resource for each of the three ranks of the license. These are usually defined inline in the inspector, without being saved as separate files.
*** Two pieces of gear in the GrantedGear array of each UnlockRank. The game will load and display the license without them, but it will have obviously missing data, and will not seem finished.
*** An icon for each rank is nice, though the defaults do work
*** A frame at rank 2, in the GrantedFrames array. In theory this could be inline, but in practice a mf_[framename].tres file is selected or drag-dropped into here to specify the link to the frame.

If your license is within any of the existing big-4 manufacturer folders or the gms folder, it should be automatically picked up by the resource group addon and loaded as a license for that manufacturer by the mod support code.

On the other hand, if you're adding your own manufacturer, that will require additional files:

* A man_[manufacturername].tres Manufacturer Resource file saved in the res/content/manufacturers/ folder.
** An icon for that manufacturer, which will be used for the selection button for it.
** A link to the ResourceGroup file which tells the game how to find content for that manufacturer, see below
* A ResourceGroup file in the same location as the Manufacturer resource. This is a special type of file that the Resource Group addon edits every time the project is run, and collects all resource files within a certain set of subdirectories usually specified via a search string. For example, the resgrp_man_horus.tres file has the filter <code>**/horus/**.tres</code> which picks up every resource file (they have the .tres extension) under any directory path including a /horus/ directory, such as /res/content/licenses/*horus*/li_goblin.tres and many others. Whenever the game is started, it builds a list of these resource files and adds it to the set of paths stored in the resource group, and those are associated with the manufacturer. There's also an exclude list, typically excluding files starting with <code>buff_</code> or <code>action_</code>, as those are not items that belong to the manufacturer and could be found in menus, but used by the game to make things happen.

The Muse

2026-07-22T22:00:55Z

Darloth: /* Modding */ - link to Adding a new License page

The Muse (aka the Lancer Tactics Wiki) is a compilation of editor documentation and guides for [https://lancertactics.com/ Lancer Tactics], a video game adaptation of the [https://massifpress.com/lancer Lancer TTRPG] by Tom Bloom and Miguel Lopez-Hall. The in-universe concept of the Muse is from the [https://vexwerewolf.itch.io/in-golden-flame-act-1 In Golden Flame] module by Vex Werewolf.

== Modding ==
* [[Modding EULA]]
* [[Modding|Introduction to modding]]
* [[Adding a new License]]
* [[Modding Cookbook]]
* [[Basic Troubleshooting]]
* [[Pixel Art]]

== Editors ==
* [[Module Editor]]
* [[Combat Editor Cookbook]]

== Other ==
* [[Changes from the TTRPG]]

== External Links & Resources ==
* [https://wick.works/devlog/category/lancer-tactics Devlog at wick.works]
* [https://discord.com/invite/2t7Efg2Fbj Lancer Tactics Discord]
* [https://wick.itch.io/lancer-tactics/community itch.io forums]
* [https://wick.itch.io/lancer-tactics itch.io store page]
* [https://store.steampowered.com/app/4049810/Lancer_Tactics/ Wishlist on Steam]
* [https://mod.io/g/lancer-tactics Lancer Tactics on mod.io]
* [https://compcon.app/ COMP/CON]

''Lancer Tactics is not an official Lancer product; it is a third party work, and is not affiliated with Massif Press. Lancer Tactics is published via the Lancer Third Party License. Lancer is copyright Massif Press.''

Module Editor

2026-07-17T22:05:34Z

Darloth: Very basic explanation of module state.

[[File:ModuleEditorBeats.png|thumb]]

The Module Editor 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 Moments. Beats are like a room and Moments are like the things you can do in that room.

A module's State is also often relevant, serving as the memory of a module, accessed through variables which can also be updated or checked inside combats and preserved until needed.

== Beats ==

Beats determine what the player can do with the Lancers character-sheet-wise whenever another Moment 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.

== Moments ==

The current Moment 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 Moment 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 Moments depending on whether its condition returns true/false.
; Signal receiver
: Immediately becomes the active Moment 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.

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

=== 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

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

Currently, only .png filenames that begin with the text "banner_" will show up and be available for banners.

== State ==

Any variable names can be used to store state, and any variable can store any data type.

=== Example ===

A variable called Has_Player_Found_Secret_Pirate_Treasure could be assigned a boolean value of True during a combat (perhaps if they stand in a certain area and use a specific action) and then checked after that combat to give the player more rewards. Once set to True in this fashion it will remain True until altered again, and (while it is probably a bad idea to do so) nothing stops you setting this variable to the number 14, or the string "no" at any point.