FetishQuest Wiki - User contributions [en]

Dungeon Sub Template (Asset)

2026-05-18T17:43:03Z

JasX:

Used to set conditions for rooms and encounters attached to a procedural dungeon.
{| class="wikitable"
|+
!Field
!Asset Type
!Type
!Default
!Description
|-
|Room/Encounter
|Any
|[[Room (Asset)|Room]] / [[Encounter (Asset)|Encounter]]
|
|Asset to add conditions to.
|-
|Conditions
|Any
|[[Condition (Asset)|Condition]]
|
|Conditions needed to validate to add the room. Often Z position conditions.
|-
|Min Z / Max Z
|Room
|
|
|Only available in room templates. Sets the min and max z coordinates where these rooms can be placed. '''Do not use Z level conditions in Room type subtemplates, it will fail to generate! Use Min Z / Max Z instead!'''
|-
|No Rot
|Room
|Boolean
|False
|Prevents the room from being rotated.
|-
|Is House
|Room
|Boolean
|False
|If checked, these rooms are treated as sub-dungeons instead, and added to the pool of flow node dungeons. Note. When this is checked, the conditions check against the parent room, not this one.
|-
|Required door tags
|Room
|[[Tag]]<nowiki/>s
|
|Requires parent room doors to have all these tags. Tags here support regex.
|}

Dungeon Sub Template (Asset)

2026-05-18T17:25:36Z

JasX:

Used to set conditions for rooms and encounters attached to a procedural dungeon.
{| class="wikitable"
|+
!Field
!Asset Type
!Type
!Default
!Description
|-
|Room/Encounter
|Any
|[[Room (Asset)|Room]] / [[Encounter (Asset)|Encounter]]
|
|Asset to add conditions to.
|-
|Conditions
|Any
|[[Condition (Asset)|Condition]]
|
|Conditions needed to validate to add the room. Often Z position conditions.
|-
|Min Z / Max Z
|Room
|
|
|Only available in room templates. Sets the min and max z coordinates where these rooms can be placed. '''Do not use Z level conditions in Room type subtemplates, it will fail to generate! Use Min Z / Max Z instead!'''
|-
|No Rot
|Room
|Boolean
|False
|Prevents the room from being rotated.
|-
|Is House
|Room
|Boolean
|False
|If checked, these rooms are treated as sub-dungeons instead, and added to the pool of flow node dungeons.
|-
|Required door tags
|Room
|[[Tag]]<nowiki/>s
|
|Requires parent room doors to have all these tags. Tags here support regex.
|}

Connecting an LLM Assistant

2026-04-17T19:41:29Z

JasX:

The devtools allow you to utilize a local or remote LLM (large language model) that follows the OpenAI API spec. For an example, [https://github.com/oobabooga/textgen Oobabooga text-generation webUI]. Please note that running your own LLM needs a ton of VRAM. I'd strongly suggest using at least an RTX3090 or better.

'''In this tutorial, I will assume that you have an LLM up and running already!'''

== Configuring ==

# In the mod tools top menu, click tools and LLM assistant.
# Enter your AI endpoint. If running locally, it may look like https://127.0.0.1:5000/v1
# Enter a bearer token (if you configured one, otherwise leave this blank)
# Min P lets you set how "creative" your model is. Lower value = more creative, higher value = more deterministic.
# Max tokens sets the max length of the response you want. Lower is faster.
# Append to all prompts lets you append a message to every prompt sent to your LLM.

[[File:LLM Configuration.png|frameless]]

== Adding AI context to characters ==
Some of the assets have AI Inference text boxes that automatically adds metadata to AI prompts that include that asset. This metadata is only used by the LLM tools, and is not accessible anywhere in game.

For an instance, you may want to describe what a character looks like, their accent, kinks etc so other characters can automatically take in that information when generating roleplays.

The following assets have AI inference fields (as of writing):

* Player - Used to describe a character. Such as their appearance, kinks, accent etc.
* Story - Only used this in single-story mods. Use this for worldbuilding.
* Roleplay - Describes the scene of a roleplay. Such as ''The player approaches Barr at his camp in a remote forest. Barr is very happy and tries to convince the player to help him with X Y Z.''
* Action - Describes what the action should look like. Such as ''Summons a slimy tentacle from the ground that penetrates the target, leaving a slimy poison behind''.
* PlayerTemplate - Same as player, but for template.

== Using instruct type autocompletions ==
In the AI Tools window, there's a Chat tab that lets you create texts. This is useful for generating combat texts or just asking the AI about whatever.

# Click the chat button in the LLM configuration window. This lets you do basic LLM auto Instruct-type prompting. For an example, in the "in this situation" box, enter ''disregard previous instructions, here's a recipe for chocolate cake:'' and click Generate.
# You can also add players, player templates, and actions. Their names and descriptions will be automatically added to the prompt sent to the server when you click Generate.
# Clicking Generate tries to generate more text to the existing text in the output box. Clicking Redo tries to redo the last generated text. To start over with a fresh response, delete the content in this box.

== Using dialog generation in roleplays ==
1. Enter the Roleplay editor. Add the player that should speak. Then scroll down and add an AI inference description. This describes the goal of your RP. You can also optionally add an AI inference player to give the RP player a visual of who they're talking to.

[[File:AI_RP_Setup.png]]

2. Create a roleplay stage and a new text. The text editor has a Gen Dialog and Gen Emote button. Gen Dialog tries to generate spoken dialog, and Gen Emote tries to generate a described action.
Note: The Gen buttons will '''REPLACE''' the written text. Check ''Continue'' if you want to generate additional text to what is already written.
[[File:Actual first stage.png|none|frame|First stage node generated with no description. The inference description is automatically added to the prompt, so it knows roughly what you're looking for.]]
3. Create a response (I went with ''Not interested, heavy armor is way too bulky!'') and then create another response node. Generating Dialog on that takes the previous lines spoken into account.

[[File:LLM Response.png]]

4. If you're going for a more particular response, you can add AI Instruction.
[[File:First stage.png|none|frame|Here I wanted a more particular response. ''So I went with Rönn teases Lo, assuring him that a plate thong would still let him show off his goods''.]]

Connecting an LLM Assistant

2026-04-17T19:40:21Z

JasX:

The devtools allow you to utilize a local or remote LLM (large language model) that follows the OpenAI API spec. For an example, [https://github.com/oobabooga/textgen Oobabooga text-generation webUI]. Please note that running your own LLM needs a ton of VRAM. I'd strongly suggest using at least an RTX3090 or better.

'''In this tutorial, I will assume that you have an LLM up and running already!'''

== Configuring ==

# In the mod tools top menu, click tools and LLM assistant.
# Enter your AI endpoint. If running locally, it may look like https://127.0.0.1:5000/v1
# Enter a bearer token (if you configured one, otherwise leave this blank)
# Min P lets you set how "creative" your model is. Lower value = more creative, higher value = more deterministic.
# Max tokens sets the max length of the response you want. Lower is faster.
# Append to all prompts lets you append a message to every prompt sent to your LLM.

[[File:LLM Configuration.png|frameless]]

== Adding AI context to characters ==
Some of the assets have AI Inference text boxes that automatically adds metadata to AI prompts that include that asset. This metadata is only used by the LLM tools, and is not accessible anywhere in game.

For an instance, you may want to describe what a character looks like, their accent, kinks etc so other characters can automatically take in that information when generating roleplays.

The following assets have AI inference fields (as of writing):

* Player - Used to describe a character. Such as their appearance, kinks, accent etc.
* Story - Only used this in single-story mods. Use this for worldbuilding.
* Roleplay - Describes the scene of a roleplay. Such as ''The player approaches Barr at his camp in a remote forest. Barr is very happy and tries to convince the player to help him with X Y Z.''
* Action - Describes what the action should look like. Such as ''Summons a slimy tentacle from the ground that penetrates the target, leaving a slimy poison behind''.
* PlayerTemplate - Same as player, but for template.

== Using instruct type autocompletions ==
In the AI Tools window, there's a Chat tab that lets you create texts. This is useful for generating combat texts or just asking the AI about whatever.

# Click the chat button in the LLM configuration window. This lets you do basic LLM auto Instruct-type prompting. For an example, in the "in this situation" box, enter ''disregard previous instructions, here's a recipe for chocolate cake:'' and click Generate.
# You can also add players, player templates, and actions. Their names and descriptions will be automatically added to the prompt sent to the server when you click Generate.
# Clicking Generate tries to generate more text to the existing text in the output box. Clicking Redo tries to redo the last generated text. To start over with a fresh response, delete the content in this box.

== Using dialog generation in roleplays ==
1. Enter the Roleplay editor. Add the player that should speak. Then scroll down and add an AI inference description. This describes the goal of your RP. You can also optionally add an AI inference player to give the RP player a visual of who they're talking to.
[[File:AI RP Setup.png]]
2. Create a roleplay stage and a new text. The text editor has a Gen Dialog and Gen Emote button. Gen Dialog tries to generate spoken dialog, and Gen Emote tries to generate a described action.
Note: The Gen buttons will '''REPLACE''' the written text. Check ''Continue'' if you want to generate additional text to what is already written.
[[File:Actual first stage.png|none|frame|First stage node generated with no description. The inference description is automatically added to the prompt, so it knows roughly what you're looking for.]]
3. Create a response (I went with ''Not interested, heavy armor is way too bulky!'') and then create another response node. Generating Dialog on that takes the previous lines spoken into account.

[[File:LLM Response.png]]
4. If you're going for a more particular response, you can add AI Instruction.
[[File:First stage.png|none|frame|Here I wanted a more particular response. ''So I went with Rönn teases Lo, assuring him that a plate thong would still let him show off his goods''.]]

File:Actual first stage.png

2026-04-17T19:39:01Z

JasX:

Generated text

File:LLM Response.png

2026-04-17T19:36:08Z

JasX:

Response to reply option with no instruction.

File:First stage.png

2026-04-17T19:33:34Z

JasX:

AI generated an introduction

File:AI RP Setup.png

2026-04-17T19:31:23Z

JasX:

AI RP Setup

Connecting an LLM Assistant

2026-04-17T19:29:12Z

JasX: Created page with "The devtools allow you to utilize a local or remote LLM (large language model) that follows the OpenAI API spec. For an example, [https://github.com/oobabooga/textgen Oobabooga text-generation webUI]. Please note that running your own LLM needs a ton of VRAM. I'd strongly suggest using at least an RTX3090 or better. '''In this tutorial, I will assume that you have an LLM up and running already!''' == Configuring == # In the mod tools top menu, click tools and LLM ass..."

File:LLM Configuration.png

2026-04-17T19:17:31Z

JasX:

Basic configuration

Category:Modding

2026-04-17T19:11:50Z

JasX:

Note: These pages generally reflect the dev branch. Note that mods created on the dev branch often don't work on the live branch until the live branch syncs with dev.

The best place to get information about specific asset types in the editor is to click the question mark on the window header. It's the most up to date information about what the asset is for and how to use the fields.

Basic controls in the editor:
{| class="wikitable"
|+ Caption text
|-
! Ctrl+click !! Unlink a linked asset, or delete an asset.
|-
! Alt+click !! Clone an asset.
|}

Suggested tutorials:

{| class="wikitable"
| [[Creating a Mod|Creating a mod]]|| How to create a new mod, and devtool basics. '''Start here!'''
|-
| [[Creating a Text]]|| Teaches you how to add a combat text for an existing action. '''Good for beginners!'''
|-
| [[Creating a Monster]]|| Goes through the process of making a monster, abilities for it, and attaching it to an encounter.
|-
| [[Creating a Dungeon]]|| How to create a dungeon and link it to the main mod.
|-
| [[Creating a Service NPC]]|| How to create an NPC that you can talk to, or offer services, and adding it to the world.
|-
| [[Creating an Action]]|| Creating an action and linking it to a player or NPC.
|-
| [[Creating an Armor Type]]|| Creating an armor/material that can be used in randomly generated equipment.
|-
| [[Creating a Roleplay]]|| How to create a dialog with an NPC.
|-
| [[Creating an Exploration Event]]|| How to create a random event that players may stumble upon in a dungeon (mainly exploration dungeons).
|-
| [[Creating an Enchant]]|| How to create an enchant and link it to the pool of random enchants available to generated equipment.
|-
| [[Creating an Exploration Dungeon]]|| How to create a procedurally generated dungeon template, and link it to the world.
|-
| [[Creating Advanced Art Layers]]|| How to create conditional art layers.
|-
| [[Sharing Your Mod]]|| Share your mod with others!
|-
|[[Connecting an LLM Assistant]]
|How to use a local AI model to add additional capabilities to the dev tools.
|}

== Common pitfalls ==

* Dungeon vars and RP vars may not have labels that end with _Set

Dungeon Flow Node (Asset)

2026-03-23T22:37:17Z

JasX:

A flow node is used to create a general layout for an advanced procedural dungeon. Each node can have multiple condition groups, but only one is ever picked. These condition groups decide which room templates should be available in that group. Such as cave tiles that also support forest tiles etc. These tiles must be specified in Room Templates, and the conditions of the room templates still apply.

===== Caveats: =====

* The first flow node used in a dungeon template MUST be able to start at coordinates 0,0,0. Because that's where the entrance room is placed.

{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Name
|String
|
|Optional, just used in the editor to remind you of the purpose of the flow node, such as "forest".
|-
|Optional
|Boolean
|False
|When checked, this flow node may be ignored at random.
|-
|Friendly
|Boolean
|False
|You can use the flowNodeFriendly condition type in the various conditions fields in your dungeon template.
|-
|Offer Quest
|Boolean
|False
|Can offer a quest in any of these rooms. You must setup quests in the [[Procedural Dungeon (Asset)|DungeonTemplate]] to use this.
|-
|Min Rooms
|Int
|1
|Minimum nr of rooms to generate. A minimum of 1 is enforced.
|-
|Max Rooms
|Int
| -1
|Maximum nr of rooms to generate. Anything below Min Rooms is clamped at Min Rooms.
|-
|Shape
|Constant
|Random
|Sets the dungeon shape. Random will place rooms at random. Linear will generate all rooms in a sequence. SemiLinear will generate a few side rooms.
|-
|Min Z
|Int
| -3
|Sets how far below the entrance on the Z axis we can go.
|-
|Max Z
|Int
|3
|Sets how far above the entrance on the Z axis we can go.
|-
|No Mimics
|Boolean
|False
|Disables mimics.
|-
|Random Encounters
|Boolean
|False
|Enables random encounters (exploration events).
|-
|Levers
|Boolean
|False
|Place levers.
|-
|Quest Items
|Boolean
|False
|If the picked quest has items to collect, you can place them in this room's cells. Recommended to only not do it on a flownode before the one that offers the quest.
|-
|Quest Encounters
|Boolean
|False
|If the picked quest has specific encounters, you can place them here.
|-
|Max Treasures
|Boolean
| -1
|Sets how many treasures can be placed in this flowNode. Note that this value will never override the grand total set in the [[Procedural Dungeon (Asset)|DungeonTemplate]].
|-
|Condition Groups
|[[Dungeon Sub Template (Asset)|Dungeon Sub Template]]
|
|When generated, these are shuffled, and only one of these are picked. At least one room must pass conditions and be valid to be used with the dungeon template quest. If none are supplied, a condition-free group is used.
|-
|Vaible Templates
|[[Dungeon (Asset)|Dungeon]]
|
|Allows the generator to link template dungeons in this node.
|-
|Entry Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions that need to be met for the door linking to this flow node to be treated as "unlocked". Do not use this on the first flowNode of your dungeon. To prevent the player from entering a quest objective area before accepting the quest, consider adding a questAccepted condition that isn't pointing to a quest.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the first room will get these encounters as its encounters.
|-
|Shuffle Start Encounters
|Boolean
|False
|When true, shuffles the order of encounters.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the last room generated will have its encounters set to this one. And one is picked at random.
|-
|Shuffle End Encounters
|Boolean
|False
|When true, shuffles the order of encounters.
|-
|Force End Chest GameAction
|[[Game Action (Asset)|GameAction]]
|
|When set, the dungeon generator will try to force the end room with a chest placeholder, and add one of the game actions as the chest game action. Useful for boss loot etc.
|}

Dungeon Flow Node (Asset)

2026-03-23T22:36:12Z

JasX:

Dungeon Flow Node (Asset)

2026-03-23T22:34:48Z

JasX:

Dungeon Flow Node (Asset)

2026-03-23T13:47:45Z

JasX:

A flow node is used to create a general layout for an advanced procedural dungeon. Each node can have multiple condition groups, but only one is ever picked. These condition groups decide which room templates should be available in that group. Such as cave tiles that also support forest tiles etc. These tiles must be specified in Room Templates, and the conditions of the room templates still apply.

===== Caveats: =====

* The first flow node used in a dungeon template MUST be able to start at coordinates 0,0,0. Because that's where the entrance room is placed.

{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Name
|String
|
|Optional, just used in the editor to remind you of the purpose of the flow node, such as "forest".
|-
|Optional
|Boolean
|False
|When checked, this flow node may be ignored at random.
|-
|Friendly
|Boolean
|False
|You can use the flowNodeFriendly condition type in the various conditions fields in your dungeon template.
|-
|Offer Quest
|Boolean
|False
|Can offer a quest in any of these rooms. You must setup quests in the [[Procedural Dungeon (Asset)|DungeonTemplate]] to use this.
|-
|Min Rooms
|Int
|1
|Minimum nr of rooms to generate. A minimum of 1 is enforced.
|-
|Max Rooms
|Int
| -1
|Maximum nr of rooms to generate. Anything below Min Rooms is clamped at Min Rooms.
|-
|Shape
|Constant
|Random
|Sets the dungeon shape. Random will place rooms at random. Linear will generate all rooms in a sequence. SemiLinear will generate a few side rooms.
|-
|Min Z
|Int
| -3
|Sets how far below the entrance on the Z axis we can go.
|-
|Max Z
|Int
|3
|Sets how far above the entrance on the Z axis we can go.
|-
|No Mimics
|Boolean
|False
|Disables mimics.
|-
|Random Encounters
|Boolean
|False
|Enables random encounters (exploration events).
|-
|Levers
|Boolean
|False
|Place levers.
|-
|Quest Items
|Boolean
|False
|If the picked quest has items to collect, you can place them in this room's cells. Recommended to only not do it on a flownode before the one that offers the quest.
|-
|Quest Encounters
|Boolean
|False
|If the picked quest has specific encounters, you can place them here.
|-
|Max Treasures
|Boolean
| -1
|Sets how many treasures can be placed in this flowNode. Note that this value will never override the grand total set in the [[Procedural Dungeon (Asset)|DungeonTemplate]].
|-
|Condition Groups
|[[Dungeon Sub Template (Asset)|Dungeon Sub Template]]
|
|When generated, these are shuffled, and only one of these are picked. At least one room must pass conditions and be valid to be used with the dungeon template quest. If none are supplied, a condition-free group is used.
|-
|Vaible Templates
|[[Dungeon (Asset)|Dungeon]]
|
|Allows the generator to link template dungeons in this node.
|-
|Entry Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions that need to be met for the door linking to this flow node to be treated as "unlocked". Do not use this on the first flowNode of your dungeon. To prevent the player from entering a quest objective area before accepting the quest, consider adding a questAccepted condition that isn't pointing to a quest.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the first room will get these encounters as its encounters, and one is picked at random.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the last room generated will have its encounters set to this one. And one is picked at random.
|}

Roleplay (Asset)

2025-11-18T12:34:53Z

JasX:

Roleplay is the dialog popup with multiple options you may encounter. In order to trigger a roleplay, you need to tie it to a [[Game Action (Asset)|game action]], generally a unique one inside of an [[Encounter (Asset)|encounter]].

This is the asset reference. If you want a tutorial, you can check out [[Creating a Roleplay]].

=== Definitely Use Outliner Mode ===
Click the Outliner button to enter outliner mode. This is a vastly superior mode of designing your roleplays. Right click to add a node, and then simply drag and drop to connect them. You can also right click a node or path to delete it. Some features are only availabe in the outliner.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your roleplay. '''Do not edit after setting up your roleplay.'''
|-
|Description
|String
|
|A description that's only visible in the editor. Helps you organize roleplays.
|-
|Portrait
|String
|
|URL to a portrait, or an [[Icon]]. Portrait can also be left empty to auto fetch from player. And it can be overridden in [[Roleplay Stage (Asset)|roleplay stages]].
|-
|Persistent
|Boolean
|True
|A persistent roleplay maintains its state. Otherwise the roleplay resets when you close it.
|-
|Once
|Boolean
|True
|Makes the roleplay only happen once. When closed, the roleplay cannot be reopened.
|-
|Auto Play
|Boolean
|True
|Automatically plays the roleplay when encountered.
|-
|Auto Play Once
|Boolean
|False
|Requires auto play. Makes the roleplay only auto play once.
|-
|No Attach
|Boolean
|False
|Allows the RP to auto play, but no speech interaction is added to the player, preventing them from picking it up after exiting.
|-
|rpVars Persistent
|Boolean
|False
|Makes roleplay variables persistent. Otherwise they reset when the roleplay is closed. Consider using dungeon vars if the outcome of a roleplay should affect something in the game outside of the roleplay.
|-
|Music
|[[Music (Asset)|Music]]
|
|If set, music is overridden with this track while the roleplay is open.
|-
|Player
|[[Player (Asset)|Player]]
|
|When set, this player is used for the portrait and speech bubbles.
|-
|Stages
|[[Roleplay Stage (Asset)|Roleplay Stage]]
|
|Stages attached to this roleplay. I strongly suggest using the outliner instead of manually creating stages.
|-
|Outliner
|
|
|Opens the RP outliner.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions needed to start the roleplay.
|-
|Player Conditoins
|[[Condition (Asset)|Condition]]
|
|By default, roleplays will use the player who triggered it as the roleplay player. Roleplay players can be accessed by %P, %P2 etc and the roleplay players can be modified inside of an RP. You can alternatively add player conditions, then all players who match these conditions will be added as RP players (Including NPCs, so consider using targetOnPlayerTeam). The order of this list is random.
|-
|NPC Gen Conditions
|[[Condition (Asset)|Condition]]
|
|When set: Used in the procedural generator when linking a roleplay to an NPC. You can set it to a condition that always validates to true if you want to link it to an NPC without using any proper conditions.
|-
|Min Players
|Int
|1
|Minimum players that need to pass player conditions in order to start the RP. Setting to -1 means all players on the player team must match.
|-
|Max Players
|Int
|1
|Maximum players that should be stored as RP targets. The roleplay can still start if exceeded, but the RP Players will be capped to this amount.
|-
|Game Actions
|[[Game Action (Asset)|Game Action]]
|
|Game actions to trigger when the RP is started.
|-
|Close Actions
|[[Game Action (Asset)|Game Action]]
|
|Game actions to trigger when the RP ends.
|}

== Using the outliner ==

* You can click and drag the header of all assets to move it.
* Clicking the middle of an asset will open an editor window for that asset.
* Right click the background to add a new asset. You can also use Pan To Root to go back to the root roleplay node.
* Be careful with purge positions as it resets all asset positions back to default.
* Drag the little round connectors from the right edge of one asset to the left edge of another. The colors must match.

{| class="wikitable"
|+Outliner Assets
!Asset
!Connections
!Description
|-
|Roleplay
|[[Roleplay Stage (Asset)|Stage]]
|This is the root roleplay node. All roleplays have exactly one.
|-
|Stage
|[[Roleplay Option (Asset)|Reply]], [[Roleplay Stage (Asset)|Stage]]
|Stage is a text that the NPC will say (or may be silent). When connected directly to another stage, a [Continue] reply is automatically added pointing to said stage. If no reply or stage is connected, a [Leave] option is automatically added.
|-
|Reply
|[[Roleplay Goto (Asset)|Goto]], [[Roleplay Stage (Asset)|Stage]]
|A reply is an option that the player can click. Goto connections are checked first against their conditions. A stage connection is always last.
|-
|Goto
|[[Roleplay Stage (Asset)|Stage]]
|A goto option is an invisible flow control block. You use them to take the conversation to a different stage based on the goto conditoins.
|}

Action (Asset)

2025-10-18T22:20:41Z

JasX:

This is the Action asset reference. If you want a tutorial, check out [[Creating an Action]].

Spells and attacks are all actions. To link an action to a player, trainer, or NPC template, use the [[Player Action (Asset)|Player Action]] asset type.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|Set to a unique label for your action. '''Do not edit after setting up your action!'''
|-
|Name
|String
|
|Name your action, doesn't have to be unique.
|-
|Icon
|[[Icon]]
|
|Icon for your action.
|-
|M.Off/Def/Uti
|Int
|0
|Momentum cost.
|-
|Cooldown
|Int
|1
|Cooldown in turns.
|-
|Init Cooldown
|Int
|0
|Start the battle with the ability on cooldown for this amount of turns. Usually used for boss mechanics.
|-
|Hit Chance
|Int
|90
|Hit chance in percent. Use 9001 for guaranteed hit. Not needed for beneficial actions.
|-
|Override disable lv
|Int
|0
|Overrides disable effects if above the disable effect's priority.
|-
|Cast time
|Int
|0
|Nr of turns needed to finish this action.
|-
|Allow while charging
|Boolean
|False
|When checked, this action may be used while the player is readying an action with a cast time.
|-
|Taunt Override Charge
|Boolean
|False
|If charged, taunt will override the cast target.
|-
|Ripostable
|Boolean
|False
|Allows the action to be riposted on miss. If the action missed, the action is run in reverse against the caster with the target as the new caster.
|-
|Group
|String
|
|Lets you group spells in the action bar. Mainly used for potions.
|-
|Charges
|Int
|1
|Max charges of the action that can be used. Each cooldown period adds 1 charge.
|-
|Start Charges
|Int
| -1
|Set to -1 to start combat with max charges. Otherwise you can edit the nr of charges you start with.
|-
|Min Targets
|Int
|1
|Minimum targets to use this action.
|-
|Max Targets
|Int
|1
|Maximum targets that you can use this action on.
|-
|Target
|String
|target
|Overrides the target of the action.
|-
|Detrimental
|String
|yes
|Sets if the action is detrimental. Team makes it detrimental to players not on your team, and beneficial to players on your team.
|-
|Allow detrimental self cast
|Boolean
|False
|When true, it lets you use the action on yourself even if it's detrimental.
|-
|Type
|String
|physical
|Damage type
|-
|Range
|String
|
|Melee is affected by knockdown, ranged by silence, none by neither.
|-
|Standard
|Boolean
|False
|If set to standard, ALL players receive this action on game start.
|-
|Hidden
|Boolean
|False
|The only action that uses hidden is "end turn" which is technically an action.
|-
|Semi hidden
|Boolean
|False
|Hides the action in player inspect. Punishments use this.
|-
|Hide from action selector
|Boolean
|False
|Legacy option. Was used in repair kits.
|-
|Do not generate text
|Boolean
|False
|Prevents the game from trying to find a combat log text when using the action.
|-
|No interrupt
|Boolean
|False
|Prevents interrupt effects from interrupting this action (requires cast time).
|-
|Permanent Charges
|Boolean
|False
|Prevents cooldown from triggering. Can be used if you want to create an action with a finite amount of charges per battle.
|-
|Reset Interrupt
|Boolean
|False
|By default, having an ability interrupted causes it to go on cooldown. Checking Reset Interrupt finishes that cooldown immediately.
|-
|Hide if no viable targets
|Boolean
|False
|Hides the action from the action bar if no viable targets exist.
|-
|Cast if no viable wrapper
|Boolean
|False
|By default, actions can't be used if it doesn't have at least one wrapper that passes condition checks. This will bypass that.
|-
|Can crit
|Boolean
|False
|Can critically hit.
|-
|No clairvoyance
|Boolean
|False
|Doesn't show up when you use clairvoyance on the target.
|-
|Max wrappers
|Int
|0
|Max nr of wrappers to apply to each target. Use 0 for no limit.
|-
|NPC Priority
|Int
|0
|Priority when cast by a bot (NPC). Higher number gets cast first.
|-
|Description
|String
|
|Describe your action. See below for variables that can be used here.
|-
|Target Description
|String
|
|Allows you to have a separate description while hovering the arrow above a target.
|-
|Wrappers
|[[Wrapper (Asset)|Wrapper]]
|
|Wrappers to apply. At least one wrapper must apply to a target to consider it castable unless ''Cast if no viable wrapper'' is checked.
|-
|Wrapper Mods
|[[Wrapper Mod (Asset)|Wrapper Mod]]
|
|Lets you modify wrapper values and reuse the same wrapper in multiple actions.
|-
|Riposte Wrappers
|[[Wrapper (Asset)|Wrapper]]
|
|Requires Riposte checked. Wrappers to apply back to the user if successfully riposted.
|-
|Riposte Wrapper Mods
|[[Wrapper Mod (Asset)|Wrapper Mod]]
|
|
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Lets you grant the user passives while the action is slotted.
|-
|Interrupt Wrappers
|[[Wrapper (Asset)|Wrapper]]
|
|Requires a cast time. Lets you run wrappers on the caster if the action is interrupted.
|-
|Interrupt Wrapper Mods
|[[Wrapper Mod (Asset)|Wrapper Mod]]
|
|
|-
|Cast Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Passives that will affect the caster while they're charging this action. Requires a cast time.
|-
|Tags
|[[Tag]]
|
|Tags to add to the player while the action is slotted.
|-
|Aliases
|String
|
|Lets you add aliases to other action labels to share their texts.
|-
|Alternate Crit Formula
|String
|
|A [[math]] formula that overrides the default critical hit chance modifier. Should result in a number between 0 and 1. Requires Can Crit to be checked.
|-
|Hit modifier formula
|String
|
|A [[math]] formula that's multiplied against the default hit chance.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to use the action. Note that wrapper conditions are also checked, and if no wrappers match any targets, then it will also be considered to be unusable. Conditions must be match on both cast start and cast end (for charged actions).
|-
|Show Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to show this action in the action bar. A commonly used condition is ''inCombat.''
|-
|Cast Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to start a cast (needs a cast time), but not required to complete a cast.
|-
|Finish Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to finish a cast (needs a cast time), but not required to start it.
|}

== Common action tags ==
You should tag your actions, primarily to help NPCs decide how to use them. You'll want to use tags starting with ''ac_.''
{| class="wikitable"
|+
!Tag
!Description
|-
|ac_buff
|Action is a buff
|-
|ac_debuff
|Action is a debuff
|-
|ac_heal
|Action has a healing component
|-
|ac_npc_important
|Action will be prioritized by NPCs and always used by NPCs whenever they can
|-
|ac_npc_first
|Use this first unless an important action is castable. Can be combined with ac_npc important to further increase ranking.
|-
|ac_npc_important_last
|Only works consistently for actions that don't require momentum. If no other actions can be used, then this will be used.
|-
|ac_interrupt
|Action has an interrupt component.
|-
|ac_item
|Action is tied to an item.
|-
|ac_mana_heal
|Action has a momentum restore component.
|-
|ac_self_heal
|Action has a self heal component.
|-
|ac_taunt
|Action has a taunt component.
|-
|ac_mana_damage
|Action has a momentum damage component.
|-
|ac_npc_ignore_aggro
|The NPC caster should ignore the aggro system and pick targets at random.
|}

== Description variables ==
You can set a description and/or name to exactly: %P% when the action is tied to an [[Asset (Asset)|Asset]]. Then it will use the asset description/name.

You can also use a special variable like below to automatically show the amount of damage/healing etc the action does based on your current stats, such as damage done effects. These variables also work in [[Wrapper (Asset)|wrapper]] descriptions.

''Note: Target Description/wrapper descriptions will also take target effects into consideration when calculating the number, such as damage taken reduction effects.''
{| class="wikitable"
|+
!Variable
!Example
!Explanation
|-
|$
|$2
|2 multiplied by nr of stacks.
|-
|$D
|$D10
|10 multiplied by damage done effects.
|-
|$H
|$H10
|10 multiplied by healing done effects.
|-
|$N
|$DN10
|''Wrapper effects only.'' Don't multiply the other variables by the stacks of the wrapper that has this variable.
|-
|$B
|$B10
|10 multiplied by block done effects.
|-
|$A
|$A10
|10 multiplied by arousal done effects.
|}
You can also freely combine the variables. Just make sure all the letters come before the number. Ex: $DH10 multiplies 10 by both healing and damage done.

Instead of supplying a number you can also supply a [[math]] formula wrapped in {}. These also need to come after the letters.

Ex: $D{ceil(se_Block/2)} = Damage done multiplier times half the sender's block value.

Player (Asset)

2025-10-18T16:42:45Z

JasX:

A player is an NPC or player character with fixed settings. Useful for NPCs or playable characters linked in [[Gallery (Asset)|Gallery]]. If you want to create random NPCs for random encounters, use a [[Player Template (Asset)|Player Template]] instead.

If you want an NPC to offer a service, check out the [[Creating a Service NPC|Creating a Service]] tutorial.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique ID for your player. '''Do not edit after creation!'''
|-
|Name
|String
|
|Name of your character. Not unique.
|-
|Species Article
|String
|
|A/An. Automatically inferred unless your species doesn't follow the "an" before a vowel, such as unicorn.
|-
|Species
|String
|
|Species of your character.
|-
|Voice
|String
|
|Lets you bind combat grunts. Not currently used in the official game.
|-
|Pronoun he
|String
|
|he/she/it pronoun. Auto inferred for male/female.
|-
|Pronoun him
|String
|
|him/her/it pronoun. Auto inferred for male/female.
|-
|Pronoun his
|String
|
|his/her/its. Auto inferred for male/female.
|-
|Image dressed
|String
|
|URL to fully dressed state. Leave blank if using advanced art layers.
|-
|Image upper body armor
|String
|
|URL to character wearing only upper body armor. Leave blank if using advanced art layers.
|-
|Image lower body armor
|String
|
|URL to character wearing only lower body armor. Leave blank if using advanced art layers.
|-
|Image nude
|String
|
|URL to character wearing no clothes, or to art if character has only one art layer. Should always be used.
|-
|Image base path
|String
|
|Gets prepended to all images (even advanced art layers). Saves some typing. You can use the domain here, such as https://imagehost.com/
|-
|No Proxy
|Boolean
|false
|In order for CORS to work, images hosted at an external domain will use the FQ proxy service. However, if you know for sure that your image is hosted at a place with proper CORS headers, checking no proxy will make the image load faster.
|-
|Portrait XYWH
|Vector
|0,0,0
|Sets the portrait icon. Click select, then drag a box over the character's face. Right click when done.
|-
|Team
|Int
|0
|Team of player, decides how the NPC behaves in combat. Use 0 for players. Use 1 for enemies and NPCs.
|-
|Size
|Float
|5
|Used mainly in texts. Where 5 = average human, 0 = insect, 10 = dragon. Use a range between 4-6 for most humanoids.
|-
|Level
|Int
|1
|Default level. Note that level is set to 1 for all player characters on game start.
|-
|Level is offset from party
|Boolean
|False
|Check this for combat NPCs. When checked, the level field becomes an offset from the average player level. Setting the level field to 0 will then equal to same as player average level, and setting it to 1 means average player level plus 1.
|-
|Power
|Float
|1
|Lets you make a player more or less powerful. Multiplying their stats.
|-
|HP Multiplier
|Float
|1
|Lets you increase or decrease the character's max HP by this.
|-
|Armor
|Int
|0
|Used mainly for beasts. Percentage damage reduction from all attacks unless they bypass armor. 0 = no damage reduction, 100 = full.
|-
|Talkative
|Float
|0.3
|Multiplier used to check if an NPC should use Chat type texts in response to an event. Higher value = more talkative.
|-
|Sadistic
|Float
|0.5
|Used mainly for flavor in roleplays.
|-
|Dominant
|Float
|0.8
|Used mainly for flavor in roleplays.
|-
|Hetero
|Float
|0.5
|Determines sexual preference. Where 0.5 = bisexual. Used in NPCs to slightly modify who they are more likely to attack.
|-
|Emotive
|Float
|0.5
|Chance to use audio triggers. Not used in the main game.
|-
|Intelligence
|Float
|0.6
|Slightly affects AI decisions and used for flavor in RP. 0.6 is average human intelligence. 0.4-0.5 a dumb human. 0.1-0.2 for most beasts.
|-
|Ignore spell slots
|Boolean
|True
|When used on NPCs they can use ALL abilities available to them, rather than just slotted ones. Uncheck for players, and leave checked for NPCs.
|-
|PC Chat Reactions
|Boolean
|False
|By default, only players not controlled by a human are allowed to use chat type texts. Checking this allows the player to use these texts regardless of if it's controlled or not.
|-
|Remove on death
|Boolean
|False
|When dying, immediately remove this player from the game. Useful for summoned NPCs.
|-
|Placement Label
|String
|
|Lets you change the player label when they are placed in world.
|-
|Play Order
|Int
|10
|Sets the order that NPCs will play in. Lower value goes first. If multiple NPCs have the same order, their order will be shuffled after each action.
|-
|Stats
|Integers
|
|Hard codes player stats. Only recommended for NPCs.
|-
|Description
|String
|
|Describes your player in the gallery selector, and when inspecting them.
|-
|Secret information
|String
|
|Secret information to show when using clairvoyance on the player.
|-
|Jiggles
|[[Player Jiggle (Asset)|Player Jiggle]]
|
|Player jiggle assets.
|-
|Advanced Icon States
|[[Player Icon State (Asset)|Player Icon State]]
|
|See [[Creating Advanced Art Layers|creating advanced art layers]]. You can shift click these to toggle them in the preview. Also works in the jiggle previews, but you will have to manually refresh them by clicking the refresh button at the top of the window.
|-
|Player Class
|[[Player Class (Asset)|Player Class]]
|
|Sets player class.
|-
|Tags
|Tags
|
|Sets player tags. Unlike editing tags within the game itself, you must prefix these with the pl_ prefix.
|-
|Actions
|[[Action (Asset)|Action]]
|
|Adds actions to the player.
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Adds passive wrappers to the player.
|-
|Follower RP
|[[Roleplay (Asset)|Roleplay]]
|
|Marks the player as a follower, and adds a roleplay when talking to the follower.
|-
|Preview
|N/A
|
|Preview of what the player will look like.
|}

Roleplay Goto (Asset)

2025-10-16T20:04:21Z

JasX:

Lets you select a [[Roleplay Stage (Asset)|stage]] that the [[Roleplay Option (Asset)|reply]] should go to, that way you can use [[Condition (Asset)|conditions]] to have the same response take you to different stage.

In conditions, target is the player who selected the response, and sender is the player attached to the roleplay stage the reply is attached to. If no sender is present, it uses the same as target.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Go to
|[[Roleplay Stage (Asset)|Roleplay Stage]]
| - END RP -
|Sets where the option should take the player.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions needed for the goto to trigger.
|-
|Return to parent RP
|Boolean
|false
|When checked, and this is linked to from a parent RP using [[Roleplay Jump (Asset)|Jump]], it will return to where we triggered the jump
|-
|Add Roll Success
|
|
|Automatically adds conditions for a roll success (requires a roll in the parent reply object).
|-
|Add Roll Fail
|
|
|Automatically adds conditions for a roll failed (requires a roll in the parent reply object).
|}

Roleplay Jump (Asset)

2025-10-16T20:03:39Z

JasX: Created page with "Jumps are used to link smaller roleplays to a bigger one. Jumps are appended to a roleplay in game on trigger, so they save memory and make it easier to structure very large roleplays. Caveats: * Jumps currently won't work correctly when persistent the jumps are appended when encountered, and not saved. * The roleplay stage output will be automatically linked to from any Roleplay Stage in the sub-roleplay that doesn't have any options or direct links. * There is also a..."

Jumps are used to link smaller roleplays to a bigger one. Jumps are appended to a roleplay in game on trigger, so they save memory and make it easier to structure very large roleplays.

Caveats:

* Jumps currently won't work correctly when persistent the jumps are appended when encountered, and not saved.
* The roleplay stage output will be automatically linked to from any Roleplay Stage in the sub-roleplay that doesn't have any options or direct links.
* There is also a checkbox in [[Roleplay Goto (Asset)|RoleplayGoto]] that lets you force return to the parent roleplay.

{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Target Roleplay
|[[Roleplay (Asset)|Roleplay]]
|
|Roleplay that you want to link to from this node.
|-
|Stage
|[[Roleplay Stage (Asset)|RoleplayStage]]
|1st
|The roleplay stage we should link to in the target roleplay.
|-
|Return
|[[Roleplay Stage (Asset)|RoleplayStage]]
|
|Optional. Where to go once we return from the sub roleplay.
|}

Roleplay Goto (Asset)

2025-10-16T19:58:58Z

JasX:

Lets you select a [[Roleplay Stage (Asset)|stage]] that the [[Roleplay Option (Asset)|reply]] should go to, that way you can use [[Condition (Asset)|conditions]] to have the same response take you to different stage.

In conditions, target is the player who selected the response, and sender is the player attached to the roleplay stage the reply is attached to. If no sender is present, it uses the same as target.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Go to
|[[Roleplay Stage (Asset)|Roleplay Stage]]
| - END RP -
|Sets where the option should take the player.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions needed for the goto to trigger.
|-
|Return to parent RP
|Boolean
|false
|When checked, and this is linked to from a parent RP using Jump, it will return to where we triggered the jump
|-
|Add Roll Success
|
|
|Automatically adds conditions for a roll success (requires a roll in the parent reply object).
|-
|Add Roll Fail
|
|
|Automatically adds conditions for a roll failed (requires a roll in the parent reply object).
|}

Player (Asset)

2025-10-12T20:43:46Z

JasX:

A player is an NPC or player character with fixed settings. Useful for NPCs or playable characters linked in [[Gallery (Asset)|Gallery]]. If you want to create random NPCs for random encounters, use a [[Player Template (Asset)|Player Template]] instead.

If you want an NPC to offer a service, check out the [[Creating a Service NPC|Creating a Service]] tutorial.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique ID for your player. '''Do not edit after creation!'''
|-
|Name
|String
|
|Name of your character. Not unique.
|-
|Species Article
|String
|
|A/An. Automatically inferred unless your species doesn't follow the "an" before a vowel, such as unicorn.
|-
|Species
|String
|
|Species of your character.
|-
|Voice
|String
|
|Lets you bind combat grunts. Not currently used in the official game.
|-
|Pronoun he
|String
|
|he/she/it pronoun. Auto inferred for male/female.
|-
|Pronoun him
|String
|
|him/her/it pronoun. Auto inferred for male/female.
|-
|Pronoun his
|String
|
|his/her/its. Auto inferred for male/female.
|-
|Image dressed
|String
|
|URL to fully dressed state. Leave blank if using advanced art layers.
|-
|Image upper body armor
|String
|
|URL to character wearing only upper body armor. Leave blank if using advanced art layers.
|-
|Image lower body armor
|String
|
|URL to character wearing only lower body armor. Leave blank if using advanced art layers.
|-
|Image nude
|String
|
|URL to character wearing no clothes, or to art if character has only one art layer. Should always be used.
|-
|Image base path
|String
|
|Gets prepended to all images (even advanced art layers). Saves some typing. You can use the domain here, such as https://imagehost.com/
|-
|No Proxy
|Boolean
|false
|In order for CORS to work, images hosted at an external domain will use the FQ proxy service. However, if you know for sure that your image is hosted at a place with proper CORS headers, checking no proxy will make the image load faster.
|-
|Portrait XYWH
|Vector
|0,0,0
|Sets the portrait icon. Click select, then drag a box over the character's face. Right click when done.
|-
|Team
|Int
|0
|Team of player, decides how the NPC behaves in combat. Use 0 for players. Use 1 for enemies and NPCs.
|-
|Size
|Float
|5
|Used mainly in texts. Where 5 = average human, 0 = insect, 10 = dragon. Use a range between 4-6 for most humanoids.
|-
|Level
|Int
|1
|Default level. Note that level is set to 1 for all player characters on game start.
|-
|Level is offset from party
|Boolean
|False
|Check this for combat NPCs. When checked, the level field becomes an offset from the average player level. Setting the level field to 0 will then equal to same as player average level, and setting it to 1 means average player level plus 1.
|-
|Power
|Float
|1
|Lets you make a player more or less powerful. Multiplying their stats.
|-
|HP Multiplier
|Float
|1
|Lets you increase or decrease the character's max HP by this.
|-
|Armor
|Int
|0
|Used mainly for beasts. Percentage damage reduction from all attacks unless they bypass armor. 0 = no damage reduction, 100 = full.
|-
|Talkative
|Float
|0.3
|Multiplier used to check if an NPC should use Chat type texts in response to an event. Higher value = more talkative.
|-
|Sadistic
|Float
|0.5
|Used mainly for flavor in roleplays.
|-
|Dominant
|Float
|0.8
|Used mainly for flavor in roleplays.
|-
|Hetero
|Float
|0.5
|Determines sexual preference. Where 0.5 = bisexual. Used in NPCs to slightly modify who they are more likely to attack.
|-
|Emotive
|Float
|0.5
|Chance to use audio triggers. Not used in the main game.
|-
|Intelligence
|Float
|0.6
|Slightly affects AI decisions and used for flavor in RP. 0.6 is average human intelligence. 0.4-0.5 a dumb human. 0.1-0.2 for most beasts.
|-
|Ignore spell slots
|Boolean
|True
|When used on NPCs they can use ALL abilities available to them, rather than just slotted ones. Uncheck for players, and leave checked for NPCs.
|-
|Remove on death
|Boolean
|False
|When dying, immediately remove this player from the game. Useful for summoned NPCs.
|-
|Placement Label
|String
|
|Lets you change the player label when they are placed in world.
|-
|Play Order
|Int
|10
|Sets the order that NPCs will play in. Lower value goes first. If multiple NPCs have the same order, their order will be shuffled after each action.
|-
|Stats
|Integers
|
|Hard codes player stats. Only recommended for NPCs.
|-
|Description
|String
|
|Describes your player in the gallery selector, and when inspecting them.
|-
|Secret information
|String
|
|Secret information to show when using clairvoyance on the player.
|-
|Jiggles
|[[Player Jiggle (Asset)|Player Jiggle]]
|
|Player jiggle assets.
|-
|Advanced Icon States
|[[Player Icon State (Asset)|Player Icon State]]
|
|See [[Creating Advanced Art Layers|creating advanced art layers]]. You can shift click these to toggle them in the preview. Also works in the jiggle previews, but you will have to manually refresh them by clicking the refresh button at the top of the window.
|-
|Player Class
|[[Player Class (Asset)|Player Class]]
|
|Sets player class.
|-
|Tags
|Tags
|
|Sets player tags. Unlike editing tags within the game itself, you must prefix these with the pl_ prefix.
|-
|Actions
|[[Action (Asset)|Action]]
|
|Adds actions to the player.
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Adds passive wrappers to the player.
|-
|Follower RP
|[[Roleplay (Asset)|Roleplay]]
|
|Marks the player as a follower, and adds a roleplay when talking to the follower.
|-
|Preview
|N/A
|
|Preview of what the player will look like.
|}

Player (Asset)

2025-10-12T20:43:34Z

JasX:

A player is an NPC or player character with fixed settings. Useful for NPCs or playable characters linked in [[Gallery (Asset)|Gallery]]. If you want to create random NPCs for random encounters, use a [[Player Template (Asset)|Player Template]] instead.

If you want an NPC to offer a service, check out the [[Creating a Service NPC|Creating a Service]] tutorial.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique ID for your player. '''Do not edit after creation!'''
|-
|Name
|String
|
|Name of your character. Not unique.
|-
|Species Article
|String
|
|A/An. Automatically inferred unless your species doesn't follow the "an" before a vowel, such as unicorn.
|-
|Species
|String
|
|Species of your character.
|-
|Voice
|String
|
|Lets you bind combat grunts. Not currently used in the official game.
|-
|Pronoun he
|String
|
|he/she/it pronoun. Auto inferred for male/female.
|-
|Pronoun him
|String
|
|him/her/it pronoun. Auto inferred for male/female.
|-
|Pronoun his
|String
|
|his/her/its. Auto inferred for male/female.
|-
|Image dressed
|String
|
|URL to fully dressed state. Leave blank if using advanced art layers.
|-
|Image upper body armor
|String
|
|URL to character wearing only upper body armor. Leave blank if using advanced art layers.
|-
|Image lower body armor
|String
|
|URL to character wearing only lower body armor. Leave blank if using advanced art layers.
|-
|Image nude
|String
|
|URL to character wearing no clothes, or to art if character has only one art layer. Should always be used.
|-
|Image base path
|String
|
|Gets prepended to all images (even advanced art layers). Saves some typing. You can use the domain here, such as https://imagehost.com/
|-
|No Proxy
|Boolean
|false
|In order for CORS to work, images hosted at an external domain will use the FQ proxy service. However, if you know for sure that your image is hosted at a place with proper CORS headers, checking no proxy will make the image load faster.
|-
|Portrait XYWH
|Vector
|0,0,0
|Sets the portrait icon. Click select, then drag a box over the character's face. Right click when done.
|-
|Team
|Int
|0
|Team of player, decides how the NPC behaves in combat. Use 0 for players. Use 1 for enemies and NPCs.
|-
|Size
|Float
|5
|Used mainly in texts. Where 5 = average human, 0 = insect, 10 = dragon. Use a range between 4-6 for most humanoids.
|-
|Level
|Int
|1
|Default level. Note that level is set to 1 for all player characters on game start.
|-
|Level is offset from party
|Boolean
|False
|Check this for combat NPCs. When checked, the level field becomes an offset from the average player level. Setting the level field to 0 will then equal to same as player average level, and setting it to 1 means average player level plus 1.
|-
|Power
|Float
|1
|Lets you make a player more or less powerful. Multiplying their stats.
|-
|HP Multiplier
|Float
|1
|Lets you increase or decrease the character's max HP by this.
|-
|Armor
|Int
|0
|Used mainly for beasts. Percentage damage reduction from all attacks unless they bypass armor. 0 = no damage reduction, 100 = full.
|-
|Talkative
|Float
|0.3
|Multiplier used to check if an NPC should use Chat type texts in response to an event. Higher value = more talkative.
|-
|Sadistic
|Float
|0.5
|Used mainly for flavor in roleplays.
|-
|Dominant
|Float
|0.8
|Used mainly for flavor in roleplays.
|-
|Hetero
|Float
|0.5
|Determines sexual preference. Where 0.5 = bisexual. Used in NPCs to slightly modify who they are more likely to attack.
|-
|Emotive
|Float
|0.5
|Chance to use audio triggers. Not used in the main game.
|-
|Intelligence
|Float
|0.6
|Slightly affects AI decisions and used for flavor in RP. 0.6 is average human intelligence. 0.4-0.5 a dumb human. 0.1-0.2 for most beasts.
|-
|Ignore spell slots
|Boolean
|True
|When used on NPCs they can use ALL abilities available to them, rather than just slotted ones. Uncheck for players, and leave checked for NPCs.
|-
|Remove on death
|Boolean
|False
|When dying, immediately remove this player from the game. Useful for summoned NPCs.
|-
|Placement Label
|String
|
|Lets you change the player label when they are placed in world.
|-
|Play Order
|Int
|10
|Sets the order that NPCs will play in. Lower value goes first. If multiple NPCs have the same order, the order will be shuffled after each action.
|-
|Stats
|Integers
|
|Hard codes player stats. Only recommended for NPCs.
|-
|Description
|String
|
|Describes your player in the gallery selector, and when inspecting them.
|-
|Secret information
|String
|
|Secret information to show when using clairvoyance on the player.
|-
|Jiggles
|[[Player Jiggle (Asset)|Player Jiggle]]
|
|Player jiggle assets.
|-
|Advanced Icon States
|[[Player Icon State (Asset)|Player Icon State]]
|
|See [[Creating Advanced Art Layers|creating advanced art layers]]. You can shift click these to toggle them in the preview. Also works in the jiggle previews, but you will have to manually refresh them by clicking the refresh button at the top of the window.
|-
|Player Class
|[[Player Class (Asset)|Player Class]]
|
|Sets player class.
|-
|Tags
|Tags
|
|Sets player tags. Unlike editing tags within the game itself, you must prefix these with the pl_ prefix.
|-
|Actions
|[[Action (Asset)|Action]]
|
|Adds actions to the player.
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Adds passive wrappers to the player.
|-
|Follower RP
|[[Roleplay (Asset)|Roleplay]]
|
|Marks the player as a follower, and adds a roleplay when talking to the follower.
|-
|Preview
|N/A
|
|Preview of what the player will look like.
|}

Encounter (Asset)

2025-10-02T22:18:50Z

JasX:

Encounters are used to add enemies, NPCs, and custom rules to [[Room (Asset)|dungeon rooms]].

If you want help creating a random exploration event, check out [[Creating an Exploration Event]].
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your encounter. '''Do not change a label after creation'''.
|-
|Description
|String
|
|A description to help you locate your encounter later. The description is only used in the ditor.
|-
|Friendly
|Boolean
|False
|If not marked as friendly, combat will start when the encounter starts.
|-
|Proc Event
|Boolean
|False
|Marks the encounter as a procedural event, used when you mark a [[Room (Asset)|room]] as having a procedural event. Note that if you specify procedural events in a [[Story (Asset)|Story]], then only those will be included.
|-
|Once
|Boolean
|False
|Only used in procedural events. When checked, the event will only trigger once per game.
|-
|Evt Weight
|Float
|1
|Only used in procedural events. Increases or decreases the event's chance of being discovered.
|-
|Override game over
|Boolean
|False
|When checked, prevents the players from being send back to the start of the dungeon and regenerated if they are defeated.
|-
|Start Text
|String
|
|Legacy. Outputs a string into the combat log when the encounter starts.
|-
|Respawn Time
|Int
|0
|Used mainly for combat encounters that should respawn, such as beasts out in the field. Time is in game hours in seconds.
|-
|Difficulty Adjust
|Int
|0
|Lets you adjust the difficulty. 1 = 100% more difficult, -0.5 = half as difficult.
|-
|Max players
|Int
|0
|Max [[Player Template (Asset)|NPC templates]] to generate (minus [[Player (Asset)|Player NPCs]]). Use 0 for auto.
|-
|Gen Extendable
|Boolean
|False
|Allow the procedural generator to add additional friendly NPCs to this encounter.
|-
|Ambient Music
|[[Music (Asset)|Music]]
|
|Sets ambient music. If left empty, dungeon room or dungeon music is used.
|-
|Combat Music
|[[Music (Asset)|Music]]
|
|Sets combat music. If left empty, dungeon room or dungeon music is used.
|-
|Players
|[[Player (Asset)|Player]]
|
|Adds NPCs.
|-
|Player Templates
|[[Player Template (Asset)|Player Template]]
|
|Adds player templates that can be generated when the encounter starts.
|-
|Wrappers
|[[Wrapper (Asset)|Wrapper]]
|
|Adds wrappers to apply to players when the encounter starts.
|-
|Wrapper Mods
|[[Wrapper Mod (Asset)|Wrapper Mod]]
|
|Lets you modify the wrappers you apply. Such as number of stacks.
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Wrappers that affect all players that match wrapper conditions while the encounter is active.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions for this encounter to start.
|-
|Start/Passive game actions
|[[Game Action (Asset)|Game Action]]
|
|Game actions to run when the encounter starts, and passives. Commonly used to link [[Roleplay (Asset)|roleplays]] to encounters.
|-
|Event Bindings
|[[Encounter Event (Asset)|Encounter Event]]
|
|Lets you trigger [[Game Action (Asset)|game actions]] based on [[Event|events]].
|-
|Finish Game Actions
|[[Game Action (Asset)|Game Action]]
|
|Lets you trigger a [[Game Action (Asset)|game action]] when the encounter is finished (combat is won).
|-
|Player Conditions
|[[Condition (Asset)|Condition]]
|
|Lets you add conditions for certain players to show up.
|}

Quest (Asset)

2025-09-29T21:22:40Z

JasX:

Quests are tasks for the players to do that show up in the quest log.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your quest. '''Do not edit after setting up your quest!'''
|-
|Name
|String
|
|Name of your quest. Doesn't have to be unique.
|-
|Exp Multiplier
|Float
|1
|Lets you raise or lower the exp reward. Raise it for longer quests and lower it for shorter ones. Use your own discretion. Exp is by default multiplied by nr of objectives.
|-
|Hide Rewards
|Boolean
|False
|Hides quest rewards in the quest log.
|-
|Multiply Money
|Boolen
|True
|Scales any money rewards by nr of players.
|-
|Multiply Reward
|Boolean
|False
|Gives every player the item reward, otherwise a random player will receive the reward.
|-
|Description
|String
|
|Describe your quest. You can add additional descriptions show up in the quest log as the players complete objectives.
|-
|Rewards
|[[Quest Reward (Asset)|Quest Reward]]
|
|Rewards.
|-
|Objectives
|[[Quest Objective (Asset)|Quest Objective]]
|
|Objectives for the player to complete.
|-
|Completion Objectives
|
|
|Legacy. Do not use. Use a [[Roleplay (Asset)|Roleplay]] to finish your quest instead.
|-
|Completion Game Actions
|[[Game Action (Asset)|GameAction]]
|
|Actions to run. Do not rely on target, as it will be the first player on the player team. Use gameAction playerconds to target specific players.
|-
|Quest Giver RP
|[[Roleplay (Asset)|Roleplay]]
|
|Note: This is only used when linking this quest to a [[Procedural Dungeon (Asset)|procedural dungeon]]. The conditions in said RP will be used to map the quest to the world.
|}

=== Buttons ===
{| class="wikitable"
|+
!Button
!Description
|-
|Auto Create Quest Conditions
|Auto Creates quest/objective completed/accepted/not_completed conditions in your conditions DB.
|-
|Create and link quest conditions
|Automatically creates and links objective conditions, setting each objective to require the previous objective completed before showing the next.
|-
|
|
|}

Action (Asset)

2025-09-29T18:12:35Z

JasX:

This is the Action asset reference. If you want a tutorial, check out [[Creating an Action]].

Spells and attacks are all actions. To link an action to a player, trainer, or NPC template, use the [[Player Action (Asset)|Player Action]] asset type.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|Set to a unique label for your action. '''Do not edit after setting up your action!'''
|-
|Name
|String
|
|Name your action, doesn't have to be unique.
|-
|Icon
|[[Icon]]
|
|Icon for your action.
|-
|M.Off/Def/Uti
|Int
|0
|Momentum cost.
|-
|Cooldown
|Int
|1
|Cooldown in turns.
|-
|Init Cooldown
|Int
|0
|Start the battle with the ability on cooldown for this amount of turns. Usually used for boss mechanics.
|-
|Hit Chance
|Int
|90
|Hit chance in percent. Use 9001 for guaranteed hit. Not needed for beneficial actions.
|-
|Override disable lv
|Int
|0
|Overrides disable effects if above the disable effect's priority.
|-
|Cast time
|Int
|0
|Nr of turns needed to finish this action.
|-
|Allow while charging
|Boolean
|False
|When checked, this action may be used while the player is readying an action with a cast time.
|-
|Taunt Override Charge
|Boolean
|False
|If charged, taunt will override the cast target.
|-
|Ripostable
|Boolean
|False
|Allows the action to be riposted on miss. If the action missed, the action is run in reverse against the caster with the target as the new caster.
|-
|Group
|String
|
|Lets you group spells in the action bar. Mainly used for potions.
|-
|Charges
|Int
|1
|Max charges of the action that can be used. Each cooldown period adds 1 charge.
|-
|Start Charges
|Int
| -1
|Set to -1 to start combat with max charges. Otherwise you can edit the nr of charges you start with.
|-
|Min Targets
|Int
|1
|Minimum targets to use this action.
|-
|Max Targets
|Int
|1
|Maximum targets that you can use this action on.
|-
|Target
|String
|target
|Overrides the target of the action.
|-
|Detrimental
|String
|yes
|Sets if the action is detrimental. Team makes it detrimental to players not on your team, and beneficial to players on your team.
|-
|Allow detrimental self cast
|Boolean
|False
|When true, it lets you use the action on yourself even if it's detrimental.
|-
|Type
|String
|physical
|Damage type
|-
|Range
|String
|
|Melee is affected by knockdown, ranged by silence, none by neither.
|-
|Standard
|Boolean
|False
|If set to standard, ALL players receive this action on game start.
|-
|Hidden
|Boolean
|False
|The only action that uses hidden is "end turn" which is technically an action.
|-
|Semi hidden
|Boolean
|False
|Hides the action in player inspect. Punishments use this.
|-
|Hide from action selector
|Boolean
|False
|Legacy option. Was used in repair kits.
|-
|Do not generate text
|Boolean
|False
|Prevents the game from trying to find a combat log text when using the action.
|-
|No interrupt
|Boolean
|False
|Prevents interrupt effects from interrupting this action (requires cast time).
|-
|Permanent Charges
|Boolean
|False
|Prevents cooldown from triggering. Can be used if you want to create an action with a finite amount of charges per battle.
|-
|Reset Interrupt
|Boolean
|False
|By default, having an ability interrupted causes it to go on cooldown. Checking Reset Interrupt finishes that cooldown immediately.
|-
|Hide if no viable targets
|Boolean
|False
|Hides the action from the action bar if no viable targets exist.
|-
|Cast if no viable wrapper
|Boolean
|False
|By default, actions can't be used if it doesn't have at least one wrapper that passes condition checks. This will bypass that.
|-
|Can crit
|Boolean
|False
|Can critically hit.
|-
|No clairvoyance
|Boolean
|False
|Doesn't show up when you use clairvoyance on the target.
|-
|Max wrappers
|Int
|0
|Max nr of wrappers to apply to each target. Use 0 for no limit.
|-
|Description
|String
|
|Describe your action. See below for variables that can be used here.
|-
|Target Description
|String
|
|Allows you to have a separate description while hovering the arrow above a target.
|-
|Wrappers
|[[Wrapper (Asset)|Wrapper]]
|
|Wrappers to apply. At least one wrapper must apply to a target to consider it castable unless ''Cast if no viable wrapper'' is checked.
|-
|Wrapper Mods
|[[Wrapper Mod (Asset)|Wrapper Mod]]
|
|Lets you modify wrapper values and reuse the same wrapper in multiple actions.
|-
|Riposte Wrappers
|[[Wrapper (Asset)|Wrapper]]
|
|Requires Riposte checked. Wrappers to apply back to the user if successfully riposted.
|-
|Riposte Wrapper Mods
|[[Wrapper Mod (Asset)|Wrapper Mod]]
|
|
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Lets you grant the user passives while the action is slotted.
|-
|Interrupt Wrappers
|[[Wrapper (Asset)|Wrapper]]
|
|Requires a cast time. Lets you run wrappers on the caster if the action is interrupted.
|-
|Interrupt Wrapper Mods
|[[Wrapper Mod (Asset)|Wrapper Mod]]
|
|
|-
|Cast Passives
|[[Wrapper (Asset)|Wrapper]]
|
|Passives that will affect the caster while they're charging this action. Requires a cast time.
|-
|Tags
|[[Tag]]
|
|Tags to add to the player while the action is slotted.
|-
|Aliases
|String
|
|Lets you add aliases to other action labels to share their texts.
|-
|Alternate Crit Formula
|String
|
|A [[math]] formula that overrides the default critical hit chance modifier. Should result in a number between 0 and 1. Requires Can Crit to be checked.
|-
|Hit modifier formula
|String
|
|A [[math]] formula that's multiplied against the default hit chance.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to use the action. Note that wrapper conditions are also checked, and if no wrappers match any targets, then it will also be considered to be unusable. Conditions must be match on both cast start and cast end (for charged actions).
|-
|Show Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to show this action in the action bar. A commonly used condition is ''inCombat.''
|-
|Cast Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to start a cast (needs a cast time), but not required to complete a cast.
|-
|Finish Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to finish a cast (needs a cast time), but not required to start it.
|}

== Common action tags ==
You should tag your actions, primarily to help NPCs decide how to use them. You'll want to use tags starting with ''ac_.''
{| class="wikitable"
|+
!Tag
!Description
|-
|ac_buff
|Action is a buff
|-
|ac_debuff
|Action is a debuff
|-
|ac_heal
|Action has a healing component
|-
|ac_npc_important
|Action will be prioritized by NPCs and always used by NPCs whenever they can
|-
|ac_npc_first
|Use this first unless an important action is castable. Can be combined with ac_npc important to further increase ranking.
|-
|ac_npc_important_last
|Only works consistently for actions that don't require momentum. If no other actions can be used, then this will be used.
|-
|ac_interrupt
|Action has an interrupt component.
|-
|ac_item
|Action is tied to an item.
|-
|ac_mana_heal
|Action has a momentum restore component.
|-
|ac_self_heal
|Action has a self heal component.
|-
|ac_taunt
|Action has a taunt component.
|-
|ac_mana_damage
|Action has a momentum damage component.
|-
|ac_npc_ignore_aggro
|The NPC caster should ignore the aggro system and pick targets at random.
|}

== Description variables ==
You can set a description and/or name to exactly: %P% when the action is tied to an [[Asset (Asset)|Asset]]. Then it will use the asset description/name.

You can also use a special variable like below to automatically show the amount of damage/healing etc the action does based on your current stats, such as damage done effects. These variables also work in [[Wrapper (Asset)|wrapper]] descriptions.

''Note: Target Description/wrapper descriptions will also take target effects into consideration when calculating the number, such as damage taken reduction effects.''
{| class="wikitable"
|+
!Variable
!Example
!Explanation
|-
|$
|$2
|2 multiplied by nr of stacks.
|-
|$D
|$D10
|10 multiplied by damage done effects.
|-
|$H
|$H10
|10 multiplied by healing done effects.
|-
|$N
|$DN10
|''Wrapper effects only.'' Don't multiply the other variables by the stacks of the wrapper that has this variable.
|-
|$B
|$B10
|10 multiplied by block done effects.
|-
|$A
|$A10
|10 multiplied by arousal done effects.
|}
You can also freely combine the variables. Just make sure all the letters come before the number. Ex: $DH10 multiplies 10 by both healing and damage done.

Instead of supplying a number you can also supply a [[math]] formula wrapped in {}. These also need to come after the letters.

Ex: $D{ceil(se_Block/2)} = Damage done multiplier times half the sender's block value.

MathScript Snippets

2025-09-25T17:49:00Z

JasX:

A collection of snippets you can use in math scripts.

=== Update a dvar array on new day. ===
In this example, we use a dungeon with the label <code>sfq_town</code> with the following dVars:

* <code>last_trainer_reset</code> Which we store the day when this math script was run last.
* <code>trainer_skills</code> Where we store an array of 4 action labels that we'll use in conditions to decide which skills are available at a trainer.
The point of the script is to pick a random set of trainer skills each day to present to the player when visiting a trainer. We do this by having game actions checking if action labels are present in the trainer_skills dvar.<pre>setDvar("sfq_town","last_trainer_reset","!$g_day")
actions = getAssetLabelsRegex('Action', '^sfq_pc')
shuffle(actions)
actions = arraySlice(actions, 0,4)
setDvar("sfq_town", "trainer_skills", actions)</pre>Explanation:

* <code>setDvar("sfq_town","last_trainer_reset","!$g_day")</code> Sets a dvar called last_trainer_reset in the dungeon labeled sfq_town to the current day. The !$ prefix in the setDvar function is used to mark that the rest of the data should be evaluated as a formula. g_day is a game mathvar (used in ALL formulas) and is an integer value specifying how many days have elapsed in the active game.
*<code>actions = getAssetLabelsRegex('Action', '^sfq_pc')</code> Scans through the Action library and return an array of all actions starting with sfq_pc (^sfq_pc is a regular expression).
*<code>shuffle(actions)</code> Shuffles the action array.
*<code>actions = arraySlice(actions, 0,4)</code> Get the first 4 actions of the array.
*<code>setDvar("sfq_town", "trainer_skills", actions)</code> Sets the trainer_skills dungeon var in the dungeon labeled sfq_town to the array of actions.
Said mathScript game action is run every time the player enters the gym.

MathScript Snippets

2025-09-25T17:47:45Z

JasX:

MathScript Snippets

2025-09-25T17:41:32Z

JasX: Created page with "A collection of snippets you can use in math scripts. === Update a dvar array on new day. === In this example, we use a dungeon with the label <code>sfq_town</code> . We have the following dVars: * <code>last_trainer_reset</code> Which we store the day when this math script was run last. * <code>trainer_skills</code> Where we store an array of 4 action labels that we'll use in conditions to decide which skills are available at a trainer. <pre>setDvar("sfq_town","last_t..."

A collection of snippets you can use in math scripts.

=== Update a dvar array on new day. ===
In this example, we use a dungeon with the label <code>sfq_town</code> . We have the following dVars:

* <code>last_trainer_reset</code> Which we store the day when this math script was run last.
* <code>trainer_skills</code> Where we store an array of 4 action labels that we'll use in conditions to decide which skills are available at a trainer.
<pre>setDvar("sfq_town","last_trainer_reset","!$g_day")
actions = getAssetLabelsRegex('Action', '^sfq_pc')
shuffle(actions)
actions = arraySlice(actions, 0,4)
setDvar("sfq_town", "trainer_skills", actions)</pre>Explanation:

* <code>setDvar("sfq_town","last_trainer_reset","!$g_day")</code> Sets a dvar called last_trainer_reset in the dungeon labeled sfq_town to the current day.
*

Effect (Asset)

2025-09-25T10:10:09Z

JasX:

An effect is a block of data that describes something that should affect a player, such as modifying HP or stats. Effects are tied to [[Wrapper (Asset)|Wrappers]] which may contain multiple effects. Effects are always triggered by events.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your effect. '''Do not change this after setting up your effect!'''
|-
|Description
|String
|
|Describe your effect. This is not used in game, but helps search in the editor.
|-
|Type
|String
|
|Effect type. When you change this value, the description below will change.
|-
|Don't multiply by stacks
|Boolean
|False
|By default, most integer values will be multiplied by the nr of stacks in the parent wrapper. Checking this sets the stack count to a fixed 1.
|-
|Debug
|Boolean
|False
|Used to output debug output. Only use if you're modifying the FQ source code.
|-
|Highlight
|Boolean
|False
|Highlights the parent wrapper icon. If the effect is a non-passive type, it blinks. Otherwise it highlights while the effect conditions are matched.
|-
|Targets
|Array
|
|Sets what targets the effects should affect. Auto is usually the parent wrapper target.
|-
|Events
|Array
|
|List of events that should trigger the effect. internalWrapperTick is triggered when an instant wrapper is triggered, or a duration wrapper ticks. For most instant effects, you just want internalWrapperTick. You can use as many as you want.
|-
|Effect Data
|JSON
|
|A JSON object which changes based on the type of effect you're editing. Above the editor is a description of the fields you can use, and what the effect does.
|-
|Tags
|[[Tag]]
|
|Tags to apply to the target(s) while affected by the effect.
|-
|Conditions
|[[Condition (Asset)|Conditions]]
|
|Conditions required for the effect to trigger, or in the case of modifier effects (such as stat modifiers), to apply to the target(s).
Example: You bind the effect to trigger on event actionMissed and attach the parent wrapper to PlayerA. PlayerB triggers an actionMissed event against PlayerC.
event.effect is this effect, evt.originalWrapper is the wrapper involved in the miss, and evt.wrapper this event.effect.parent. Sender is PlayerB, target is PlayerC.
|-
|Subconditions
|[[Condition (Asset)|Conditions]]
|
|Conditions are always checked with sender/target being the same as the event that triggered the effect. However, if you use a target other than sender/target, and want to check conditions on the recipient, then you can use a subcondition. Sender of the subcondition is always the parent wrapper's owner.
Example: You bind the effect to trigger on event actionMissed with target set to aoe, and attach the parent wrapper to PlayerA. PlayerB triggers an actionMissed event against PlayerC.
event.effect is this effect, evt.originalWrapper is the wrapper involved in the miss, and evt.wrapper this event.effect.parent. Sender is the player affected by this effect's parent (holder). The effect then iterates through every player (because of AoE), sets that player as the target, and runs the effect on that target only if they match conditions.
|}

=== Notes ===

* If the target of the event that triggered the effect is the holder of the wrapper this effect is attached to, then it flips target/sender. So generally you want to flip so ta_ vars target the owner of the effect, whereas se_ will target the target of the effect. I don't remember why I made it this way, but I think it was important.
* By default, mathVar targets will be the target(s) set in the targets section. If you want to access the parent wrapper's sender or target, you have access to pws_ and pwt_. These stand for parentWrapperSender and parentWrapperTarget, and contain data about the effect parent wrapper\'s send and target.

Node Editor

2025-09-07T23:10:13Z

JasX:

The node editor offers a better overview over how an asset is connected. Currently this is used for [[Roleplay (Asset)|Roleplay]].

Controls:
{| class="wikitable"
|+
!Input
!Description
|-
|Click & Drag On Background
|Pans the node view.
|-
|Click & Drag On Block Header
|Moves a node.
|-
|Click & Drag On Block Node
|Draws a new node connection. Nodes can be connected right and left side of a block, and must match by color.
|-
|Ctrl + Click & Drag
|Drags a selection box, allowing you to select multiple blocks.
|-
|Right Click on Background
|Opens the global context menu (see below).
|-
|Right Click On Block
|Opens the block context menu (see below).
|-
|Right Click On Background With Multiple Selctions
|Opens the batch context menu (see below).
|-
|Shift + Click & Drag Block Header
|Clones the block (or all selected blocks if you have an active multi-block selection).
|-
|Mousewheel
|Zooms
|-
|Shift + Right Click On Block
|Resets block connection positions.
|-
|Right Click on Line
|Opens the line context menu (see below).
|}
{| class="wikitable"
|+Global Context Menu
!Option
!Description
|-
| + <blockType>
|Inserts a new block of this type.
|-
|Pan To Root
|Pans to the root node.
|-
|Purge Position
|Resets all positions (can be useful is you've lost the node positions).
|-
|Minimize All
|Minimizes all Blocks
|-
|Maximize All
|Maximizes all Blocks.
|}
{| class="wikitable"
|+Block Context Menu
!Option
!Description
|-
|Align Inputs
|Moves connected nodes to this one.
|-
|Delete
|Deletes the node.
|}
{| class="wikitable"
|+Bath Context Menu
!Option
!Description
|-
|Maximize
|Maximizes selected blocks.
|-
|Minimize
|Minimizes selected blocks.
|-
|Delete
|Deletes selected blocks.
|}
{| class="wikitable"
|+Line Context menu
!Option
!Description
|-
|Delete
|Deletes the line
|}

Node Editor

2025-09-07T11:59:56Z

JasX: Created page with "The node editor offers a better overview over how an asset is connected. Currently this is used for Roleplay. Controls: {| class="wikitable" |+ !Input !Description |- |Click & Drag On Background |Pans the node view. |- |Click & Drag On Block Header |Moves a node. |- |Click & Drag On Block Node |Draws a new node connection. Nodes can be connected right and left side of a block, and must match by color. |- |Ctrl + Click & Drag |Drags a selection box,..."

The node editor offers a better overview over how an asset is connected. Currently this is used for [[Roleplay (Asset)|Roleplay]].

Controls:
{| class="wikitable"
|+
!Input
!Description
|-
|Click & Drag On Background
|Pans the node view.
|-
|Click & Drag On Block Header
|Moves a node.
|-
|Click & Drag On Block Node
|Draws a new node connection. Nodes can be connected right and left side of a block, and must match by color.
|-
|Ctrl + Click & Drag
|Drags a selection box, allowing you to select multiple blocks.
|-
|Right Click on Background
|Opens the global context menu (see below).
|-
|Right Click On Block
|Opens the block context menu (see below).
|-
|Right Click On Background With Multiple Selctions
|Opens the batch context menu (see below).
|-
|Shift + Click & Drag Block Header
|Clones the block (or all selected blocks if you have an active multi-block selection).
|-
|Mousewheel
|Zooms
|-
|Shift + Right Click On Block
|Resets block connection positions.
|-
|Right Click on Line
|Opens the line context menu (see below).
|}
{| class="wikitable"
|+Global Context Menu
!Option
!Description
|-
| + <blockType>
|Inserts a new block of this type.
|-
|Pan To Root
|Pans to the root node.
|-
|Purge Position
|Resets all positions (can be useful is you've lost the node positions, which aren't saved on export).
|-
|Minimize All
|Minimizes all Blocks
|-
|Maximize All
|Maximizes all Blocks.
|}
{| class="wikitable"
|+Block Context Menu
!Option
!Description
|-
|Align Inputs
|Moves connected nodes to this one.
|-
|Delete
|Deletes the node.
|}
{| class="wikitable"
|+Bath Context Menu
!Option
!Description
|-
|Maximize
|Maximizes selected blocks.
|-
|Minimize
|Minimizes selected blocks.
|-
|Delete
|Deletes selected blocks.
|}
{| class="wikitable"
|+Line Context menu
!Option
!Description
|-
|Delete
|Deletes the line
|}

Roleplay (Asset)

2025-09-03T21:58:29Z

JasX:

Roleplay is the dialog popup with multiple options you may encounter. In order to trigger a roleplay, you need to tie it to a [[Game Action (Asset)|game action]], generally a unique one inside of an [[Encounter (Asset)|encounter]].

This is the asset reference. If you want a tutorial, you can check out [[Creating a Roleplay]].

=== Definitely Use Outliner Mode ===
Click the Outliner button to enter outliner mode. This is a vastly superior mode of designing your roleplays. Right click to add a node, and then simply drag and drop to connect them. You can also right click a node or path to delete it. Some features are only availabe in the outliner.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your roleplay. '''Do not edit after setting up your roleplay.'''
|-
|Description
|String
|
|A description that's only visible in the editor. Helps you organize roleplays.
|-
|Portrait
|String
|
|URL to a portrait, or an [[Icon]]. Portrait can also be left empty to auto fetch from player. And it can be overridden in [[Roleplay Stage (Asset)|roleplay stages]].
|-
|Persistent
|Boolean
|True
|A persistent roleplay maintains its state. Otherwise the roleplay resets when you close it.
|-
|Once
|Boolean
|True
|Makes the roleplay only happen once. When closed, the roleplay cannot be reopened.
|-
|Auto Play
|Boolean
|True
|Automatically plays the roleplay when encountered.
|-
|Auto Play Once
|Boolean
|False
|Requires auto play. Makes the roleplay only auto play once.
|-
|No Attach
|Boolean
|False
|Allows the RP to auto play, but no speech interaction is added to the player, preventing them from picking it up after exiting.
|-
|rpVars Persistent
|Boolean
|False
|Makes roleplay variables persistent. Otherwise they reset when the roleplay is closed. Consider using dungeon vars if the outcome of a roleplay should affect something in the game outside of the roleplay.
|-
|Music
|[[Music (Asset)|Music]]
|
|If set, music is overridden with this track while the roleplay is open.
|-
|Player
|[[Player (Asset)|Player]]
|
|When set, this player is used for the portrait and speech bubbles.
|-
|Stages
|[[Roleplay Stage (Asset)|Roleplay Stage]]
|
|Stages attached to this roleplay. I strongly suggest using the outliner instead of manually creating stages.
|-
|Outliner
|
|
|Opens the RP outliner.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions needed to start the roleplay.
|-
|Player Conditoins
|[[Condition (Asset)|Condition]]
|
|By default, roleplays will use the player who triggered it as the roleplay player. Roleplay players can be accessed by %P, %P2 etc and the roleplay players can be modified inside of an RP. You can alternatively add player conditions, then all players who match these conditions will be added as RP players (Including NPCs, so consider using targetOnPlayerTeam). The order of this list is random.
|-
|Min Players
|Int
|1
|Minimum players that need to pass player conditions in order to start the RP. Setting to -1 means all players on the player team must match.
|-
|Max Players
|Int
|1
|Maximum players that should be stored as RP targets. The roleplay can still start if exceeded, but the RP Players will be capped to this amount.
|-
|Game Actions
|[[Game Action (Asset)|Game Action]]
|
|Game actions to trigger when the RP is started.
|-
|Close Actions
|[[Game Action (Asset)|Game Action]]
|
|Game actions to trigger when the RP ends.
|}

== Using the outliner ==

* You can click and drag the header of all assets to move it.
* Clicking the middle of an asset will open an editor window for that asset.
* Right click the background to add a new asset. You can also use Pan To Root to go back to the root roleplay node.
* Be careful with purge positions as it resets all asset positions back to default.
* Drag the little round connectors from the right edge of one asset to the left edge of another. The colors must match.

{| class="wikitable"
|+Outliner Assets
!Asset
!Connections
!Description
|-
|Roleplay
|[[Roleplay Stage (Asset)|Stage]]
|This is the root roleplay node. All roleplays have exactly one.
|-
|Stage
|[[Roleplay Option (Asset)|Reply]], [[Roleplay Stage (Asset)|Stage]]
|Stage is a text that the NPC will say (or may be silent). When connected directly to another stage, a [Continue] reply is automatically added pointing to said stage. If no reply or stage is connected, a [Leave] option is automatically added.
|-
|Reply
|[[Roleplay Goto (Asset)|Goto]], [[Roleplay Stage (Asset)|Stage]]
|A reply is an option that the player can click. Goto connections are checked first against their conditions. A stage connection is always last.
|-
|Goto
|[[Roleplay Stage (Asset)|Stage]]
|A goto option is an invisible flow control block. You use them to take the conversation to a different stage based on the goto conditoins.
|}

Procedural Dungeon (Asset)

2025-08-30T21:17:34Z

JasX:

This lets you create procedural dungeons (exploration dungeons). In order to link a procedural dungeon to the world, create a door in the dungeon room and double click it to add a game action of type "proceduralDungeon", set the label to a unique label for your dungeon, and then link this dungeon template to the game action.

This is the asset reference. You can find a tutorial at [[Creating an Exploration Dungeon]].
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your procedural dungeon. '''Do not modify after setting up!'''
|-
|Fog override
|Float
|0
|Use 0 to turn off. See [[Room (Asset)|Room]] for more information.
|-
|Ambient light
|String
|
|Overrides ambient light. See [[Room (Asset)|Room]] for more information.
|-
|Ambiance
|String
|
|URL to an ambient OGG file to use, unless the room itself has ambient set.
|-
|Ambiance volume
|Float
|0.2
|
|-
|Saturation
|Float
|1.3
|Dungeon color saturation. Can be overridden in rooms. See [[Room (Asset)|Room]] for more info.
|-
|Max Treasures
|Int
| -1
|Sets a hard cap on nr of treasures in the dungeon. -1 defaults to 25% of rooms. The total nr generated will never exceed this value, no matter what you set in the flow nodes.
|-
|Max Exp Events
|Int
| -1
|Defaults to 20% of all rooms.
|-
|Progress Tracker
|Boolean
|true
|Shows the nr of rooms you have explored in this dungeon at the top of the screen.
|-
|Reward Cartograph
|Boolean
|true
|If set to false, disable the dungeon exploration reward, including "dungeon explored" popup, exp, and cartograph rewards.
|-
|Reverb Type
|String
|Room Mesh
|Lets you set reverb type for your dungeon unless overridden by the rooms themselves. Room Mesh will use the room mesh settings.
|-
|Reverb intensity
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset reverb intensity.
|-
|Lowpass filter
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset lowpass filter. Mainly used for underwater dungeons.
|-
|Test Audio
|N/A
|
|Plays a random sample with your audio settings.
|-
|Unique Consumables
|[[Asset (Asset)|Asset]]
|
|Sets the [[Dungeon (Asset)|dungeon]] consumables field.
|-
|Ignore Global Consumables in autoLoot
|Boolean
|false
|Maps to the [[Dungeon (Asset)|dungeon]] l_no_auto field.
|-
|Ignore asset templates in autoLoot
|Boolean
|false
|Maps to the [[Dungeon (Asset)|dungeon]] l_no_cons field.
|-
|Rooms
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds rooms to the list of rooms that can be added.
|-
|Encounters
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds encounters that can be placed randomly in the dungeon (as long as conditions match the room).
|-
|Ambient Music
|[[Music (Asset)|Music]]
|
|Sets music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Combat Music
|[[Music (Asset)|Music]]
|
|Sets combat music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed at start. If multiple encounters are picked, the order is randomized and the first viable encounter is played.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed in the final room. If multiple encounters are picked, the order of encounters is shuffled. Cannot be used if a template quest is used.
|-
|Flow Map
|[[Dungeon Flow Node (Asset)|Dungeon Flow Node]]
|
|You can use flow nodes to enforce a certain layout. Such as "start with a forest", "then a settlement" etc. See the flow node asset type for more info. Using flow nodes will override the nr of cells setting in the procedural dungeon game action.
|-
|Procedural Quests
|[[Quest (Asset)|Quest]]
|
|Quests that can be offered here. Note that these quests are marked as procedural.
|}

Dungeon Sub Template (Asset)

2025-08-30T21:01:54Z

JasX:

Used to set conditions for rooms and encounters attached to a procedural dungeon.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Room/Encounter
|[[Room (Asset)|Room]] / [[Encounter (Asset)|Encounter]]
|
|Asset to add conditions to.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions needed to validate to add the room. Often Z position conditions.
|-
|Min Z / Max Z
|
|
|Only available in room templates. Sets the min and max z coordinates where these rooms can be placed. '''Do not use Z level conditions in Room type subtemplates, it will fail to generate! Use Min Z / Max Z instead!'''
|}

Dungeon Flow Node (Asset)

2025-08-30T20:45:40Z

JasX:

A flow node is used to create a general layout for an advanced procedural dungeon. Each node can have multiple condition groups, but only one is ever picked. These condition groups decide which room templates should be available in that group. Such as cave tiles that also support forest tiles etc. These tiles must be specified in Room Templates, and the conditions of the room templates still apply.

===== Caveats: =====

* The first flow node used in a dungeon template MUST be able to start at coordinates 0,0,0. Because that's where the entrance room is placed.

{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Name
|String
|
|Optional, just used in the editor to remind you of the purpose of the flow node, such as "forest".
|-
|Optional
|Boolean
|False
|When checked, this flow node may be ignored at random.
|-
|Friendly
|Boolean
|False
|You can use the flowNodeFriendly condition type in the various conditions fields in your dungeon template.
|-
|Offer Quest
|Boolean
|False
|Can offer a quest in any of these rooms. You must setup quests in the [[Procedural Dungeon (Asset)|DungeonTemplate]] to use this.
|-
|Min Rooms
|Int
|1
|Minimum nr of rooms to generate. A minimum of 1 is enforced.
|-
|Max Rooms
|Int
| -1
|Maximum nr of rooms to generate. Anything below Min Rooms is clamped at Min Rooms.
|-
|Shape
|Constant
|Random
|Sets the dungeon shape. Random will place rooms at random. Linear will generate all rooms in a sequence. SemiLinear will generate a few side rooms.
|-
|Min Z
|Int
| -3
|Sets how far below the entrance on the Z axis we can go.
|-
|Max Z
|Int
|3
|Sets how far above the entrance on the Z axis we can go.
|-
|No Mimics
|Boolean
|False
|Disables mimics.
|-
|Random Encounters
|Boolean
|False
|Enables random encounters (exploration events).
|-
|Levers
|Boolean
|False
|Place levers.
|-
|Quest Items
|Boolean
|False
|If the picked quest has items to collect, you can place them in this room's cells. Recommended to only not do it on a flownode before the one that offers the quest.
|-
|Quest Encounters
|Boolean
|False
|If the picked quest has specific encounters, you can place them here.
|-
|Max Treasures
|Boolean
| -1
|Sets how many treasures can be placed in this flowNode. Note that this value will never override the grand total set in the [[Procedural Dungeon (Asset)|DungeonTemplate]].
|-
|Condition Groups
|[[Dungeon Sub Template (Asset)|Dungeon Sub Template]]
|
|When generated, these are shuffled, and only one of these are picked. At least one room must pass conditions and be valid to be used with the dungeon template quest. If none are supplied, a condition-free group is used.
|-
|Vaible Templates
|[[Dungeon (Asset)|Dungeon]]
|
|Allows the generator to link template dungeons in this node.
|-
|Entry Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions that need to be met for the door linking to this flow node to be treated as "unlocked". Do not use this on the first flowNode of your dungeon. To prevent the player from entering a quest objective area before accepting the quest, consider adding a questAccepted condition that isn't pointing to a quest.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the first room will get these encounters as its encounters, and one is picked at random.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the last room generated will have its encounters set to this one.
|}

Dungeon Flow Node (Asset)

2025-08-30T20:37:07Z

JasX:

A flow node is used to create a general layout for an advanced procedural dungeon. Each node can have multiple condition groups, but only one is ever picked. These condition groups decide which room templates should be available in that group. Such as cave tiles that also support forest tiles etc. These tiles must be specified in Room Templates, and the conditions of the room templates still apply.

===== Caveats: =====

* The first flow node used in a dungeon template MUST be able to start at coordinates 0,0,0. Because that's where the entrance room is placed.

{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Name
|String
|
|Optional, just used in the editor to remind you of the purpose of the flow node, such as "forest".
|-
|Optional
|Boolean
|False
|When checked, this flow node may be ignored at random.
|-
|Friendly
|Boolean
|False
|You can use the flowNodeFriendly condition type in the various conditions fields in your dungeon template.
|-
|Offer Quest
|Boolean
|False
|Can offer a quest in any of these rooms. You must setup quests in the [[Procedural Dungeon (Asset)|DungeonTemplate]] to use this.
|-
|Min Rooms
|Int
|1
|Minimum nr of rooms to generate. A minimum of 1 is enforced.
|-
|Max Rooms
|Int
| -1
|Maximum nr of rooms to generate. Anything below Min Rooms is clamped at Min Rooms.
|-
|Shape
|Constant
|Random
|Sets the dungeon shape. Random will place rooms at random. Linear will generate all rooms in a sequence. SemiLinear will generate a few side rooms.
|-
|Min Z
|Int
| -3
|Sets how far below the entrance on the Z axis we can go.
|-
|Max Z
|Int
|3
|Sets how far above the entrance on the Z axis we can go.
|-
|No Mimics
|Boolean
|False
|Disables mimics.
|-
|Random Encounters
|Boolean
|False
|Enables random encounters (exploration events).
|-
|Levers
|Boolean
|False
|Place levers.
|-
|Quest Items
|Boolean
|False
|If the picked quest has items to collect, you can place them in this room's cells. Recommended to only not do it on a flownode before the one that offers the quest.
|-
|Quest Encounters
|Boolean
|False
|If the picked quest has specific encounters, you can place them here.
|-
|Max Treasures
|Boolean
| -1
|Sets how many treasures can be placed in this flowNode. Note that this value will never override the grand total set in the [[Procedural Dungeon (Asset)|DungeonTemplate]].
|-
|Condition Groups
|[[Dungeon Sub Template (Asset)|Dungeon Sub Template]]
|
|When generated, these are shuffled, and only one of these are picked. At least one room must pass conditions and be valid to be used with the dungeon template quest.
|-
|Vaible Templates
|[[Dungeon (Asset)|Dungeon]]
|
|Allows the generator to link template dungeons in this node.
|-
|Entry Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions that need to be met for the door linking to this flow node to be treated as "unlocked". Do not use this on the first flowNode of your dungeon. To prevent the player from entering a quest objective area before accepting the quest, consider adding a questAccepted condition that isn't pointing to a quest.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the first room will get these encounters as its encounters, and one is picked at random.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the last room generated will have its encounters set to this one.
|}

Dungeon Flow Node (Asset)

2025-08-28T14:56:34Z

JasX:

A flow node is used to create a general layout for an advanced procedural dungeon. Each node can have multiple condition groups, but only one is ever picked. These condition groups decide which room templates should be available in that group. Such as cave tiles that also support forest tiles etc. These tiles must be specified in Room Templates, and the conditions of the room templates still apply.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Name
|String
|
|Optional, just used in the editor to remind you of the purpose of the flow node, such as "forest".
|-
|Optional
|Boolean
|False
|When checked, this flow node may be ignored at random.
|-
|Friendly
|Boolean
|False
|You can use the flowNodeFriendly condition type in the various conditions fields in your dungeon template.
|-
|Offer Quest
|Boolean
|False
|Can offer a quest in any of these rooms. You must setup quests in the [[Procedural Dungeon (Asset)|DungeonTemplate]] to use this.
|-
|Min Rooms
|Int
|1
|Minimum nr of rooms to generate. A minimum of 1 is enforced.
|-
|Max Rooms
|Int
| -1
|Maximum nr of rooms to generate. Anything below Min Rooms is clamped at Min Rooms.
|-
|Shape
|Constant
|Random
|Sets the dungeon shape. Random will place rooms at random. Linear will generate all rooms in a sequence. SemiLinear will generate a few side rooms.
|-
|Min Z
|Int
| -3
|Sets how far below the entrance on the Z axis we can go.
|-
|Max Z
|Int
|3
|Sets how far above the entrance on the Z axis we can go.
|-
|No Mimics
|Boolean
|False
|Disables mimics.
|-
|Random Encounters
|Boolean
|False
|Enables random encounters (exploration events).
|-
|Levers
|Boolean
|False
|Place levers.
|-
|Quest Items
|Boolean
|False
|If the picked quest has items to collect, you can place them in this room's cells. Recommended to only not do it on a flownode before the one that offers the quest.
|-
|Quest Encounters
|Boolean
|False
|If the picked quest has specific encounters, you can place them here.
|-
|Max Treasures
|Boolean
| -1
|Sets how many treasures can be placed in this flowNode. Note that this value will never override the grand total set in the [[Procedural Dungeon (Asset)|DungeonTemplate]].
|-
|Condition Groups
|[[Dungeon Sub Template (Asset)|Dungeon Sub Template]]
|
|When generated, these are shuffled, and only one of these are picked. At least one room must pass conditions and be valid to be used with the dungeon template quest.
|-
|Vaible Templates
|[[Dungeon (Asset)|Dungeon]]
|
|Allows the generator to link template dungeons in this node.
|-
|Entry Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions that need to be met for the door linking to this flow node to be treated as "unlocked". Do not use this on the first flowNode of your dungeon. To prevent the player from entering a quest objective area before accepting the quest, consider adding a questAccepted condition that isn't pointing to a quest.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the first room will get these encounters as its encounters, and one is picked at random.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|When set, the last room generated will have its encounters set to this one.
|}

Dungeon Sub Template (Asset)

2025-08-28T14:44:23Z

JasX:

Procedural Dungeon (Asset)

2025-08-28T14:43:27Z

JasX:

This lets you create procedural dungeons (exploration dungeons). In order to link a procedural dungeon to the world, create a door in the dungeon room and double click it to add a game action of type "proceduralDungeon", set the label to a unique label for your dungeon, and then link this dungeon template to the game action.

This is the asset reference. You can find a tutorial at [[Creating an Exploration Dungeon]].
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your procedural dungeon. '''Do not modify after setting up!'''
|-
|Fog override
|Float
|0
|Use 0 to turn off. See [[Room (Asset)|Room]] for more information.
|-
|Ambient light
|String
|
|Overrides ambient light. See [[Room (Asset)|Room]] for more information.
|-
|Ambiance
|String
|
|URL to an ambient OGG file to use, unless the room itself has ambient set.
|-
|Ambiance volume
|Float
|0.2
|
|-
|Saturation
|Float
|1.3
|Dungeon color saturation. Can be overridden in rooms. See [[Room (Asset)|Room]] for more info.
|-
|Max Treasures
|Int
| -1
|Sets a hard cap on nr of treasures in the dungeon. -1 defaults to 25% of rooms. The total nr generated will never exceed this value, no matter what you set in the flow nodes.
|-
|Max Exp Events
|Int
| -1
|Defaults to 20% of all rooms.
|-
|Progress Tracker
|Boolean
|true
|Shows the nr of rooms you have explored in this dungeon at the top of the screen.
|-
|Reward Cartograph
|Boolean
|true
|If set to false, disable the dungeon exploration reward, including "dungeon explored" popup, exp, and cartograph rewards.
|-
|Reverb Type
|String
|Room Mesh
|Lets you set reverb type for your dungeon unless overridden by the rooms themselves. Room Mesh will use the room mesh settings.
|-
|Reverb intensity
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset reverb intensity.
|-
|Lowpass filter
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset lowpass filter. Mainly used for underwater dungeons.
|-
|Test Audio
|N/A
|
|Plays a random sample with your audio settings.
|-
|Unique Consumables
|[[Asset (Asset)|Asset]]
|
|Sets the [[Dungeon (Asset)|dungeon]] consumables field.
|-
|Ignore Global Consumables in autoLoot
|Boolean
|false
|Maps to the [[Dungeon (Asset)|dungeon]] l_no_auto field.
|-
|Ignore asset templates in autoLoot
|Boolean
|false
|Maps to the [[Dungeon (Asset)|dungeon]] l_no_cons field.
|-
|Template Dungeons
|[[Dungeon (Asset)|Dungeon]]
|
|Attaches rooms from a dungeon. These can currently only be attached to DungeonRoomAssets tagged as ''m_house_ent'' and ''m_door_autoxy''.
|-
|Room Templates
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds rooms to the list of rooms that can be added.
|-
|Encounters
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds encounters that can be placed randomly in the dungeon (as long as conditions match the room).
|-
|Ambient Music
|[[Music (Asset)|Music]]
|
|Sets music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Combat Music
|[[Music (Asset)|Music]]
|
|Sets combat music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed at start. If multiple encounters are picked, the order is randomized and the first viable encounter is played.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed in the final room. If multiple encounters are picked, the order of encounters is shuffled. Cannot be used if a template quest is used.
|-
|Flow Map
|[[Dungeon Flow Node (Asset)|Dungeon Flow Node]]
|
|You can use flow nodes to enforce a certain layout. Such as "start with a forest", "then a settlement" etc. See the flow node asset type for more info. Using flow nodes will override the nr of cells setting in the procedural dungeon game action.
|-
|Procedural Quests
|[[Quest (Asset)|Quest]]
|
|Quests that can be offered here. Note that these quests are marked as procedural.
|}

Procedural Dungeon (Asset)

2025-08-28T14:34:11Z

JasX:

This lets you create procedural dungeons (exploration dungeons). In order to link a procedural dungeon to the world, create a door in the dungeon room and double click it to add a game action of type "proceduralDungeon", set the label to a unique label for your dungeon, and then link this dungeon template to the game action.

This is the asset reference. You can find a tutorial at [[Creating an Exploration Dungeon]].
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your procedural dungeon. '''Do not modify after setting up!'''
|-
|Fog override
|Float
|0
|Use 0 to turn off. See [[Room (Asset)|Room]] for more information.
|-
|Ambient light
|String
|
|Overrides ambient light. See [[Room (Asset)|Room]] for more information.
|-
|Ambiance
|String
|
|URL to an ambient OGG file to use, unless the room itself has ambient set.
|-
|Ambiance volume
|Float
|0.2
|
|-
|Saturation
|Float
|1.3
|Dungeon color saturation. Can be overridden in rooms. See [[Room (Asset)|Room]] for more info.
|-
|Max Treasures
|Int
| -1
|Sets a hard cap on nr of treasures in the dungeon. -1 defaults to 25% of rooms. The total nr generated will never exceed this value, no matter what you set in the flow nodes.
|-
|Max Encounters
|
|
|
|-
|Reverb Type
|String
|Room Mesh
|Lets you set reverb type for your dungeon unless overridden by the rooms themselves. Room Mesh will use the room mesh settings.
|-
|Reverb intensity
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset reverb intensity.
|-
|Lowpass filter
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset lowpass filter. Mainly used for underwater dungeons.
|-
|Test Audio
|N/A
|
|Plays a random sample with your audio settings.
|-
|Room Templates
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds rooms to the list of rooms that can be added.
|-
|Encounters
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds encounters that can be found in the dungeon.
|-
|Ambient Music
|[[Music (Asset)|Music]]
|
|Sets music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Combat Music
|[[Music (Asset)|Music]]
|
|Sets combat music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed at start. If multiple encounters are picked, the order is randomized and the first viable encounter is played.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed in the final room. If multiple encounters are picked, the order of encounters is shuffled. Cannot be used if a template quest is used.
|-
|Flow Map
|[[Dungeon Flow Node (Asset)|Dungeon Flow Node]]
|
|You can use flow nodes to enforce a certain layout. Such as "start with a forest", "then a settlement" etc. See the flow node asset type for more info. Using flow nodes will override the nr of cells setting in the procedural dungeon game action.
|}

Procedural Dungeon (Asset)

2025-08-28T14:29:06Z

JasX:

Procedural Dungeon (Asset)

2025-08-28T14:26:52Z

JasX:

This lets you create procedural dungeons (exploration dungeons). In order to link a procedural dungeon to the world, create a door in the dungeon room and double click it to add a game action of type "proceduralDungeon", set the label to a unique label for your dungeon, and then link this dungeon template to the game action.

This is the asset reference. You can find a tutorial at [[Creating an Exploration Dungeon]].
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your procedural dungeon. '''Do not modify after setting up!'''
|-
|Random Encounters
|Boolean
|False
|Allows encounters marked as Proc Event to be added to some rooms.
|-
|Fog override
|Float
|0
|Use 0 to turn off. See [[Room (Asset)|Room]] for more information.
|-
|Ambient light
|String
|
|Overrides ambient light. See [[Room (Asset)|Room]] for more information.
|-
|Ambiance
|String
|
|URL to an ambient OGG file to use, unless the room itself has ambient set.
|-
|Ambiance volume
|Float
|0.2
|
|-
|Saturation
|Float
|1.3
|Dungeon color saturation. Can be overridden in rooms. See [[Room (Asset)|Room]] for more info.
|-
|Reverb Type
|String
|Room Mesh
|Lets you set reverb type for your dungeon unless overridden by the rooms themselves. Room Mesh will use the room mesh settings.
|-
|Reverb intensity
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset reverb intensity.
|-
|Lowpass filter
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset lowpass filter. Mainly used for underwater dungeons.
|-
|Test Audio
|N/A
|
|Plays a random sample with your audio settings.
|-
|Room Templates
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds rooms to the list of rooms that can be added.
|-
|Encounters
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds encounters that can be found in the dungeon.
|-
|Ambient Music
|[[Music (Asset)|Music]]
|
|Sets music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Combat Music
|[[Music (Asset)|Music]]
|
|Sets combat music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed at start. If multiple encounters are picked, the order is randomized and the first viable encounter is played.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed in the final room. If multiple encounters are picked, the order of encounters is shuffled. Cannot be used if a template quest is used.
|-
|Flow Map
|[[Dungeon Flow Node (Asset)|Dungeon Flow Node]]
|
|You can use flow nodes to enforce a certain layout. Such as "start with a forest", "then a settlement" etc. See the flow node asset type for more info. Using flow nodes will override the nr of cells setting in the procedural dungeon game action.
|}

Procedural Dungeon (Asset)

2025-08-21T15:57:29Z

JasX:

This lets you create procedural dungeons (exploration dungeons). In order to link a procedural dungeon to the world, create a door in the dungeon room and double click it to add a game action of type "proceduralDungeon", set the label to a unique label for your dungeon, and then link this dungeon template to the game action.

This is the asset reference. You can find a tutorial at [[Creating an Exploration Dungeon]].
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your procedural dungeon. '''Do not modify after setting up!'''
|-
|Allow Up
|Boolean
|True
|If turned off, the dungeon won't generate any rooms above the entrance height.
|-
|Allow Down
|Boolean
|True
|If turned off, the dungeon won't generate any rooms below the entrance height.
|-
|Levers
|Boolean
|False
|If turned on, levers and locked doors will be generated. Note that you have to make sure that the dungeon room assets used all have lever placeholders in them.
|-
|Random Encounters
|Boolean
|False
|Allows encounters marked as Proc Event to be added to some rooms.
|-
|Fog override
|Float
|0
|Use 0 to turn off. See [[Room (Asset)|Room]] for more information.
|-
|Ambient light
|String
|
|Overrides ambient light. See [[Room (Asset)|Room]] for more information.
|-
|Ambiance
|String
|
|URL to an ambient OGG file to use, unless the room itself has ambient set.
|-
|Ambiance volume
|Float
|0.2
|
|-
|Saturation
|Float
|1.3
|Dungeon color saturation. Can be overridden in rooms. See [[Room (Asset)|Room]] for more info.
|-
|Reverb Type
|String
|Room Mesh
|Lets you set reverb type for your dungeon unless overridden by the rooms themselves. Room Mesh will use the room mesh settings.
|-
|Reverb intensity
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset reverb intensity.
|-
|Lowpass filter
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset lowpass filter. Mainly used for underwater dungeons.
|-
|Test Audio
|N/A
|
|Plays a random sample with your audio settings.
|-
|Room Templates
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds rooms to the list of rooms that can be added.
|-
|Encounters
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds encounters that can be found in the dungeon.
|-
|Ambient Music
|[[Music (Asset)|Music]]
|
|Sets music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Combat Music
|[[Music (Asset)|Music]]
|
|Sets combat music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed at start. If multiple encounters are picked, the order is randomized and the first viable encounter is played.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed in the final room. If multiple encounters are picked, the order of encounters is shuffled. Cannot be used if a template quest is used.
|-
|Flow Map
|[[Dungeon Flow Node (Asset)|Dungeon Flow Node]]
|
|You can use flow nodes to enforce a certain layout. Such as "start with a forest", "then a settlement" etc. See the flow node asset type for more info. Using flow nodes will override the nr of cells setting in the procedural dungeon game action.
|}

Procedural Dungeon (Asset)

2025-08-21T15:55:18Z

JasX:

This lets you create procedural dungeons (exploration dungeons). In order to link a procedural dungeon to the world, create a door in the dungeon room and double click it to add a game action of type "proceduralDungeon", set the label to a unique label for your dungeon, and then link this dungeon template to the game action.

This is the asset reference. You can find a tutorial at [[Creating an Exploration Dungeon]].
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your procedural dungeon. '''Do not modify after setting up!'''
|-
|Allow Up
|Boolean
|True
|If turned off, the dungeon won't generate any rooms above the entrance height.
|-
|Allow Down
|Boolean
|True
|If turned off, the dungeon won't generate any rooms below the entrance height.
|-
|Levers
|Boolean
|False
|If turned on, levers and locked doors will be generated. Note that you have to make sure that the dungeon room assets used all have lever placeholders in them.
|-
|Random Encounters
|Boolean
|False
|Allows encounters marked as Proc Event to be added to some rooms.
|-
|Fog override
|Float
|0
|Use 0 to turn off. See [[Room (Asset)|Room]] for more information.
|-
|Ambient light
|String
|
|Overrides ambient light. See [[Room (Asset)|Room]] for more information.
|-
|Ambiance
|String
|
|URL to an ambient OGG file to use, unless the room itself has ambient set.
|-
|Ambiance volume
|Float
|0.2
|
|-
|Saturation
|Float
|1.3
|Dungeon color saturation. Can be overridden in rooms. See [[Room (Asset)|Room]] for more info.
|-
|Reverb Type
|String
|Room Mesh
|Lets you set reverb type for your dungeon unless overridden by the rooms themselves. Room Mesh will use the room mesh settings.
|-
|Reverb intensity
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset reverb intensity.
|-
|Lowpass filter
|Float
|PASS
|Setting to pass automates it. Otherwise you can override the room asset lowpass filter. Mainly used for underwater dungeons.
|-
|Test Audio
|N/A
|
|Plays a random sample with your audio settings.
|-
|Room Templates
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds rooms to the list of rooms that can be added.
|-
|Encounters
|[[Dungeon Sub Template (Asset)|Sub Template]]
|
|Adds encounters that can be found in the dungeon.
|-
|Ambient Music
|[[Music (Asset)|Music]]
|
|Sets music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Combat Music
|[[Music (Asset)|Music]]
|
|Sets combat music to play in the dungeon. Note that rooms/encounters/RP may override this.
|-
|Force Start Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed at start. If multiple encounters are picked, the order is randomized and the first viable encounter is played.
|-
|Force End Encounter
|[[Encounter (Asset)|Encounter]]
|
|One or many encounters that must be placed in the final room. If multiple encounters are picked, the order of encounters is shuffled. Cannot be used if a template quest is used.
|-
|Flow Map
|Dungeon Template Flow Map
|
|
|}

Dungeon Flow Node (Asset)

2025-08-21T15:52:43Z

JasX: Created page with "A flow node is used to create a general layout for an advanced procedural dungeon. Each node can have multiple condition groups, but only one is ever picked. These condition groups decide which room templates should be available in that group. Such as cave tiles that also support forest tiles etc. These tiles must be specified in Room Templates, and the conditions of the room templates still apply. {| class="wikitable" |+ !Field !Type !Default !Description |- |Name |Stri..."

Dungeon (Asset)

2025-08-15T23:27:21Z

JasX:

This is the asset reference. If you want help creating a dungeon, you can check out the [[Creating a Dungeon|Creating a Dungeon tutorial]].

Dungeons are collections of rooms (cells) that a player can navigate.

=== Common pitfalls ===

* Avoid adding new rooms to official dungeons. Your rooms may be overwritten in the future. Add a "door" to an official dungeon instead and have it connect to your own dungeon.

{| class="wikitable"
|+
!Field
!Type
!Description
|-
|Label
|String
|A unique label for your dungeon. I strongly suggest you use a prefix for your mod. Such as if your mod is called "my dungeon mod", prefix your label like mdm_dungeonName. '''Do not change after creating your dungeon!'''
|-
|Name
|String
|Name of your dungeon. Doesn't have to be unique.
|-
|Difficulty
|Float
|Leave this at -1 for auto generated difficulty. This may be used in the future.
|-
|Free roam
|Boolean
|Removes the "back" button on doors. Generally used for dungeons that don't have a start or end, such as outdoor areas in the main world.
|-
|Fog Override
|Float
|Lets you override fog for the entire dungeon. Experiment with the fog value in specific rooms before setting it on an entire dungeon.
|-
|Ambient Light
|String
|Lets you override the ambient light (currently only works for indoor rooms). Experiment with it in a room before changing the dungeon value.
|-
|Time of day override
|Float
|Sets time of day between 0-1 where 0 is midnight, 0.5 midday etc. Currently only works on outdoor rooms. Use -1 to use world time.
|-
|Rain override
|Float
|Overrides the rain setting. Leave at 0 for auto.
|-
|Ambiance
|String
|URL of an ambient sound file to play. Can be overridden on a room by room basis. Should be an OGG format file.
|-
|Ambiance Volume
|Float
|Sets the volume of the ambient loop. Default 0.2
|-
|Saturation
|Float
|Sets the color saturation for the dungeon. Can be overridden in room settings. Default 1.3
|-
|Reverb Type
|String
|Sets the reverb type for your dungeon. If left at Room Mesh, then the room mesh will automatically decide the best reverb for your dungeon. Reverb can also be set in rooms themselves.
|-
|Reverb intensity.
|Float
|Drag all the way to the left to set reverb to automatic.
|-
|Lowpass filter
|Float
|Adds a lowpass filter to sounds, muffling them. Mainly used for underwater areas.
|-
|Test audio
|N/A
|Triggers a random sound, letting you preview the reverb and lowpass settings.
|-
|Ambient music
|[[Music (Asset)|Music]]
|Sets ambient music to play in the dungeon. Can be overridden in dungeon room, encounter, and roleplay.
|-
|Combat Music
|[[Music (Asset)|Music]]
|Sets combat music. Can be overridden in dungeon room and encounter.
|-
|Vars
|JSON
|Creates a JSON object of dungeon variables. The Dungeon tutorial has a section [[Creating a Dungeon#Creating Levers|shows basic dungeon var usage]].
|-
|Developer comments
|String
|These are only visible in the editor. Lets you make comments. Often used to describe what the different dungeon vars do.
|-
|Tags
|Tags
|Any tags added here will be attached to players and can be used in the tag condition type.
|-
|Unique Consumables
|[[Asset (Asset)|Asset]]
|Used with the autoLoot [[Game Action (Asset)|GameAction]]. Adding these items to the auto loot consumable generator.
|-
|Ignore global consumables
|Boolean
|By default, autoLoot game actions will pull from ALL assets with Autoloot checked. This removes any global ones from autoLoot in this dungeon, but still allows Unique Consumables. Useful in stories where you don't want to use the global loot table.
|-
|Ignore asset templates in autoLoot
|Boolean
|When checked, autoLoot does not generate armor in this dungeon.
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|Passives applied to all players that match the wrapper conditions.
|-
|Rooms
|[[Room (Asset)|Room]]
|Contains an editor that lets you add rooms. Note that rooms can only grow in 6 directions and rooms may not overlap. Clicking the direction buttons adds a new room in that direction. Use the dropdown in the top right to change floor. Click a room box to bring up the room editor.
|}

Dungeon (Asset)

2025-08-15T23:01:56Z

JasX:

This is the asset reference. If you want help creating a dungeon, you can check out the [[Creating a Dungeon|Creating a Dungeon tutorial]].

Dungeons are collections of rooms (cells) that a player can navigate.

=== Common pitfalls ===

* Avoid adding new rooms to official dungeons. Your rooms may be overwritten in the future. Add a "door" to an official dungeon instead and have it connect to your own dungeon.

{| class="wikitable"
|+
!Field
!Type
!Description
|-
|Label
|String
|A unique label for your dungeon. I strongly suggest you use a prefix for your mod. Such as if your mod is called "my dungeon mod", prefix your label like mdm_dungeonName. '''Do not change after creating your dungeon!'''
|-
|Name
|String
|Name of your dungeon. Doesn't have to be unique.
|-
|Difficulty
|Float
|Leave this at -1 for auto generated difficulty. This may be used in the future.
|-
|Free roam
|Boolean
|Removes the "back" button on doors. Generally used for dungeons that don't have a start or end, such as outdoor areas in the main world.
|-
|Fog Override
|Float
|Lets you override fog for the entire dungeon. Experiment with the fog value in specific rooms before setting it on an entire dungeon.
|-
|Ambient Light
|String
|Lets you override the ambient light (currently only works for indoor rooms). Experiment with it in a room before changing the dungeon value.
|-
|Time of day override
|Float
|Sets time of day between 0-1 where 0 is midnight, 0.5 midday etc. Currently only works on outdoor rooms. Use -1 to use world time.
|-
|Rain override
|Float
|Overrides the rain setting. Leave at 0 for auto.
|-
|Ambiance
|String
|URL of an ambient sound file to play. Can be overridden on a room by room basis. Should be an OGG format file.
|-
|Ambiance Volume
|Float
|Sets the volume of the ambient loop. Default 0.2
|-
|Saturation
|Float
|Sets the color saturation for the dungeon. Can be overridden in room settings. Default 1.3
|-
|Reverb Type
|String
|Sets the reverb type for your dungeon. If left at Room Mesh, then the room mesh will automatically decide the best reverb for your dungeon. Reverb can also be set in rooms themselves.
|-
|Reverb intensity.
|Float
|Drag all the way to the left to set reverb to automatic.
|-
|Lowpass filter
|Float
|Adds a lowpass filter to sounds, muffling them. Mainly used for underwater areas.
|-
|Test audio
|N/A
|Triggers a random sound, letting you preview the reverb and lowpass settings.
|-
|Ambient music
|[[Music (Asset)|Music]]
|Sets ambient music to play in the dungeon. Can be overridden in dungeon room, encounter, and roleplay.
|-
|Combat Music
|[[Music (Asset)|Music]]
|Sets combat music. Can be overridden in dungeon room and encounter.
|-
|Vars
|JSON
|Creates a JSON object of dungeon variables. The Dungeon tutorial has a section [[Creating a Dungeon#Creating Levers|shows basic dungeon var usage]].
|-
|Developer comments
|String
|These are only visible in the editor. Lets you make comments. Often used to describe what the different dungeon vars do.
|-
|Tags
|Tags
|Any tags added here will be attached to players and can be used in the tag condition type.
|-
|Unique Consumables
|[[Asset (Asset)|Asset]]
|Used with the autoLoot [[Game Action (Asset)|GameAction]]. Adding these items to the auto loot consumable generator.
|-
|Passives
|[[Wrapper (Asset)|Wrapper]]
|Passives applied to all players that match the wrapper conditions.
|-
|Rooms
|[[Room (Asset)|Room]]
|Contains an editor that lets you add rooms. Note that rooms can only grow in 6 directions and rooms may not overlap. Clicking the direction buttons adds a new room in that direction. Use the dropdown in the top right to change floor. Click a room box to bring up the room editor.
|}

Audio Trigger (Asset)

2025-08-14T22:02:48Z

JasX:

Audiotriggers are mainly used to create combat grunts. They contain lists of audio kits and when the conditions are met, one is played at random. Each player is limited to play 1 audio kit every 500ms.

Note:

* Audio triggers are not currently used in the main game.
* For most of these, you\'ll want to use the conditions eventIsTextTrigger, targetVoice_x (when victim) or senderVoice_x (when attacker), and any relevant meta condition such as metaVeryPainful. But you can toy with these freely, like adding a disgust reaction to trigger on metaGooey.
* To autocomplete in the player editor, make a voice condition that targets this voice.

{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your kit. '''Do not alter after finishing setting up.'''
|-
|Priority
|Int
|1
|If multiple audio triggers match, the higher priority number gets triggered. Ex pain could be 1, and pain heavy 2.
|-
|Trig
|Int
|50
|Percent chance for this kit to trigger.
|-
|Sounds
|[[Audio Kit (Asset)|Audio Kit]]
|
|When triggered, one of these sounds will be picked at random and played. Meaning you can (for an example) create a single Audio Trigger for all pain grunts, and one for heavy pain etc.
|-
|Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions. Works the same way as with text conditions. You'll probably want to add a "voice" type condition to each set of grunts. Which is how you link voice kits to players.
|}

Text (Asset)

2025-08-08T13:28:40Z

JasX:

This is the asset reference, you can find a tutorial [[Creating a Text|here]].
{| class="wikitable"
|+
!Field
!Type
!Description
|-
|Text
|String
|The text to generate. See below for tags you can use.
|-
|Enabled
|Boolean
|Only affects texts in the texts database (so not RP etc). Required checked if you want the text to be included in the combat log.
|-
|Nr Targets
|Int
|Nr targets REQUIRED to trigger this text. Generally used in custom texts with abilities that can have multiple targets. When making combat texts, make sure there's at least one 1 target text. Conditions are checked against ALL targets and must match. Use -1 for ANY amount of target. -1 is mainly useful for AoE where you only want to have one text.
|-
|Weight
|Float
|Lets you increase the chance of a text to show up. If you have a lot of conditions, you may want to increase it. Otherwise I suggest simply leaving it at default (in the middle).
|-
|Conditions
|[[Condition (Asset)]]
|Conditions required to trigger this text.
|-
|Condition Templates
|N/A
|You can use this to quickly add commonly used conditions. Such as if you want your text to be output when an action is used, and if the action was used by a humanoid on a humanoid you can click Humanoid on Humanoid to quickly add the: actionHit, eventIsActionUsed, senderNotBeast, and targetNotBeast conditions.
|-
|Turn Tags
|Tags
|Sets temporary tags on a the recipient of the text. These will be wiped on the player's next turn. Can be used to add texts that refer to previous texts. Such as if a text triggers that bends the target over, you can set the tt_bent_over text, and then use a condition in the other text such as "ttBentOver" to add a text that assumes that the player was already bent over. It's a bit complicated, and not frequently used. Turn tags start with tt_
|-
|Target Tags
|Tags
|'''Used in RP only.''' Tags applied to the text target while on a roleplay stage. Can be used to trigger facial expressions and such. Checking persistent persists the tags until the next time a stage text with at least 1 Target Tags is set, or the roleplay ends. Note that Persistent OVERWRITES previously persistent tags, it's not additive.
|-
|
|
|Same as target tags, but for the sender(s).
|-
|Meta Tags
|Tags
|These tags describe the text (generally for the victim). And are mainly used in kinks and for NPC speech. Go through the list and tag anything you feel applies.
|-
|Chat
|Boolean
|Changes it from a descriptive text to a chat (NPC speech). Changing the text type to chant adds the Chat Player Conditions linker.
|-
|Chat Player Conditions
|[[Condition (Asset)]]
|Conditions that need to be met on the talking NPC for this text to be triggered. If you just want the sender of a text (such as attacker in an action) speak, then you can use senderIsChatPlayer in the regular conditions. But if you want a third party NPC to say something, then you'll have to use chat player conditions.
|-
|Reuse Chat
|Boolean
|By default, an NPC can only say the same line once per combat. Checking Reuse chat lets the NPC say this line as many times they want.
|-
|Armor Slot
|String
|If your attack targets armor, mark that here. It's used to trigger the correct sounds, for an instance a clunk if the victim takes a punch to the chest while wearing plate armor.
|-
|Audio Kits
|[[Audio Kit (Asset)]]
|Plays audio when the text is triggered. Note: HitFX includes audio. Only pick Audio Kits here if you want to add additional sounds to a HitFX object, or if you want to play audio without triggering a HitFX.
|-
|HitFX
|[[HitFX (Asset)]]
|Selected HitFX will be triggered when the text triggers.
|-
|Debug
|Boolean
|Outputs logging information into the console whenever the text's conditions are checked. Leave it unchecked unless you're working on a fork of FQ.
|-
|Extra senders
|[[Condition (Asset)]]
|If left empty, extra senders are ignored. This is if you want to include another player as an extra "attacker" in your text. These extra attackers get the tags %A, %A2... Any players that match the specified conditions will be put into a list, and the first min_extra_senders nr of players will be used. Can be used for texts where two enemies double team a player. Consider not using this for player on NPC attacks. Also note that this is only for flavor, the extra sender doesn't affect combat at all. Click the Add Defaults button to add some suggested conditions.
|-
|Min extra senders
|Int
|Nr of minimum extra senders that need to match extra sender conditions in order for this text to be triggered.
|}

== Reserved Characters ==
You cannot use <code>% or @</code> as characters in your text. They have special uses.

== Tags ==
You can use text tags as placeholder for information. For an example, %T is replaced with the event target's name.
{| class="wikitable"
|+Name Tags
!Tag(s)
!Description
|-
|%T, %T2...
|Target full name, colorized.
|-
|%S
|Sender full name, colorized.
|-
|%P, %P2...
|Roleplay player, colorized.
|-
|%A, %A2...
|When using extra sender conditions, these are the matched player names. Colorized.
|-
|%RturnTag
|Name of a player who applied a turn tag, colorized. Such as %Rspanked
|-
|%PCSV
|Special case only used in an RP and outputs ALL event target names separated by comma.
|}
{| class="wikitable"
|+Meta tags
These can be added to a valid target. Such as %Trace or %P2race.
(We'll use %T as an example here)
!Tag(s)
!Description
|-
|%The
|Pronoun he/she/it etc
|-
|%Thim
|Pronoun him/her/its etc
|-
|%This
|Prnoun his/her/its etc
|-
|%Tgenitals
|Gets the name of a genital the player has, such as penis/vagina
|-
|%TclothUpper
|Name of upper body armor.
|-
|%TclothLower
|Name of lower body armor
|-
|%Tgear
|Name of handheld equipment
|-
|%Trace
|Species of player.
|}
{| class="wikitable"
|+Pronoun specific meta tags
(Same as above, but if the target is not male or female, these are removed)
!Tag
!Male
!Female
|-
|%Tmister
|mister
|miss
|-
|%Tsir
|sir
|maam
|-
|%Tlord
|lord
|lady
|-
|%Tgentleman
|gentleman
|lady
|-
|%Tboy
|boy
|girl
|-
|%Tlad
|lad
|lass
|-
|%Tman
|man
|woman
|-
|%Tguy
|guy
|gal
|-
|%Tprince
|prince
|princess
|-
|%Tking
|king
|queen
|-
|%Tboyo
|boyo
|girlie
|-
|%Tbrother
|brother
|sister
|}
{| class="wikitable"
|+Synonym tags
These just pick a random synonym each time
!Tag
!Examples
|-
|%cum
|spunk, jizz
|-
|%few
|handful of, couple of
|-
|%pounding
|thrusting, humping
|-
|%firmly
|rigidly, thoroughly
|-
|%firm
|tight, rigid, thorough
|-
|%quickly
|rapidly, speedily, hastily
|-
|%rapid
|quick, hasty, swift
|-
|%breast
|boob, tit
|-
|%penis
|dong, cock, member
|-
|%vagina
|pussy, cunt
|-
|%butt
|rear, behind
|-
|%groin
|crotch
|-
|%around
|about
|-
|%start
|begin
|-
|%into
|inside
|-
|%rapidly
|hastily, promptly, swiftly
|-
|%slither
|slip, slink, wiggle
|-
|%rough
|hard
|-
|%slightly
|a little, somewhat
|-
|%big
|large
|-
|%glob
|wad, blob
|-
|%flings
|launches, lobs, slings
|-
|%sticky
|syrupy, viscous
|-
|%letting
|allowing
|-
|%splattering
|splashing
|-
|%jostle
|shake, rattle
|-
|%jostling
|shaking, rattling
|-
|%wiggling
|squirming, wriggling
|-
|%bulge
|package
|-
|%somach
|belly, tummy
|-
|%twitch
|spasm, jerk, throb
|}

== Modifiers ==
{| class="wikitable"
|+Most tags support the following modifiers
!Modifier
!Example
!Output
!Description
|-
|!
|%!The
|He
|Turns the first character into uppercase.
|-
|a
|%S is %SaRace wearing %SaClothUpper
|Jas is a lynx wearing an oversized hauberk.
|Works on race and cloth tags. Tries to prepend ''a'' or ''an'' accordingly.
|}

== Using mathVars in texts ==
For non-player specific math vars, such as numbers, you just prepend the math var label with @.

* ''Note: Using @ to refer to a math var is only used in the text itself. Inside of formulas, you should just use the math var as is, without prefixing @.''

If you need player-specific math vars, then see [[Math]] for a primer on the FQ math system.

== Using formulas in texts ==
Use the syntax <code>@{formula}</code>. Such as <code>@{d_dungeonName_dungeonVar*3}</code>.