FetishQuest Wiki - User contributions [en]

Wrapper (Asset)

2026-06-06T11:19:10Z

JasX:

A wrapper is a collection of effects to run immediately, ticking, on events, or passively. Wrappers with no duration are called instant effects. Wrappers with an infinite duration are called passives. And wrappers with a limited duration are called buffs or debuffs depending on what they do.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your wrapper. '''Do not change after finishing creating your wrapper!'''
|-
|Editor Description
|String
|
|Adds a short description of your wrapper to help you locate it when searching. This field is only used in the editor, and not shown in game.
|-
|Name
|String
|
|Name of your wrapper. Doesn't have to be unique. Only needed in buffs/debuffs.
|-
|Icon
|[[Icon]]
|
|Icon of your wrapper. Only needed in buffs/debuffs.
|-
|Target
|String
|
|Target of your wrapper. Auto, Caster and AoE are the most commonly used one.
|-
|Duration
|String
|0
|How long the effect should last. Using -1 on a wrapper applied in combat will last until combat ends. Can be a formula.
|-
|Stacks
|Int
|1
|Amount of stacks to add. Leave at 1 for instant effects.
|-
|Max Stacks
|Int
|1
|Max stacks a player can have. Leave at 1 for instant effects.
|-
|Rarity
|String
|COMMON
|Only used for wrappers attached to armor. Used to set the color of the tooltip.
|-
|Unique
|Boolean
|False
|When unique, players can only have one wrapper of this type, regardless of caster. Otherwise you may have one instance of each wrapper per caster.
|-
|Hidden
|Boolean
|False
|Don't show the icon on the player.
|-
|Trigger Immediate
|Boolean
|False
|Doesn't affect instant effects. When checked, trigger all valid effects immediately when the wrapper is applied, otherwise it triggers the first time on their turn.
|-
|Tick on turn start
|Boolean
|True
|Triggers effects when the player's turn starts.
|-
|Stack time
|Boolean
|False
|When true, duration is added to any existing wrappers, otherwise duration resets to what the duration was set to in the incoming wrapper.
|-
|Tick on team turn end
|Boolean
|False
|Triggers effects when the player's team members have all ended their turns.
|-
|Tick on personal turn end
|Boolean
|False
|Triggers effects when the player hits the end turn button (or similar), regardless of if their team members have ended their turn or not.
|-
|Global
|Boolean
|False
|When checked, all players will receive this wrapper as a passive when they're placed in world. Use sparingly!
|-
|Use game timer
|Boolean
|False
|By default, duration is in turns. If you check use game timer, the duration becomes in-game seconds. Mainly used by buffs and debuffs related to items and random events, and talents. When linked to a talent, use game timer is automatically enforced since it puts the icon at the bottom of your portrait.
|-
|Description
|String
|
|Describe the wrapper. You can use special vars here such as modifying a value by damage taken/done etc. See [[Action (Asset)|Action]] for a list of valid variables. In addition to the Action variables, there's a few special ones for wrappers.
|-
|Tags
|[[Tag]]
|
|Tags applied to the target. Use wr_ tags.
|-
|Effects
|[[Effect (Asset)|Effect]]
|interrupt
|Effects to trigger as long as their conditions match.
|-
|Add Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to apply this to a target. If you're using a multi-target target, then each target will be checked before applying it to them individually.
|-
|Stay Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required for this wrapper to stay on its target.
|}

== Description vars ==
{| class="wikitable"
|+
!Var
!Description
|-
|%knockdown
|Can be used if the wrapper has a knockdown effect. Returns stomach or back.
|-
|%caster / %S
|Colored name of caster (sender).
|-
|%target / %T
|Colored name of target.
|}

== Description condition lines ==
A line may start with |AC:<condition>,<condition>...|. If conditions between |AC: and the closing pipe are not met, the whole line is removed. This takes place on wrapper ADD and is never checked after that. Use sparingly. Currently it's only used for overWhelmingOrgasm because the label is hardcoded.

FQCrop Batch

2026-06-05T14:30:02Z

JasX:

The following is a script you can use along with the [[Creating Advanced Art Layers|Creating Advanced Art Layers Guide]] to speed up connecting your advanced art layers to your FQ mod.

To use it, simply copy the content into a new text file and name it fqcrop_batch.jsx

You can either put this in your Phothoshop/Presets/Scripts folder and restart photoshop to use it from file > scripts. Or you can go to file > scripts > browse.

<pre>
/*
Note: This is similar to the fqcrop.jsx file except it exports all layers one at a time.
Usage: See fqcrop.jsx for more info. Things you need to keep in mind in this implementation:
- Each art layer can only consist of ONE photoshop layer
- All layers must begin with <layerNr>_ ex 30_bikini_light_ub to use layer 30 (upper body base)
- A JSON metadata file named the same as the original file will be created or updated. It's going to need a bit of editing, but you can use it to quickly upload a full character.
- Layers and groups starting with # are ignored.
- If a JSON file exists, it's loaded and updated. Missing layers aren't deleted from it. So if you remove layers you have to remove them from the JSON file or delete the JSON file to generate a new one.
- The following values are overwritten into the JSON file, using the photoshop settings:
- icon
- x
- y
- blendMode (only normal, multiply, overlay are supported)
- opacity
*/
var startRulesUnits = preferences.rulerUnits;
var doc = activeDocument;
var docW = doc.width;
var docH = doc.height;
var allLayers = [];
var dirJson = decodeURI(doc.path.fsName)+"/";
var jsonName = doc.name.split(".");
jsonName.pop();
var fName = jsonName.join('_')
var dir = dirJson+fName+"/";
jsonName = jsonName.join(".")+".json";
var pics = [];
var url = '';
var bgName = "";
var bgLayer;
Array.prototype.indexOf = function ( item ) {

var index = 0, length = this.length;

for ( ; index < length; index++ ) {

if ( this[index] === item )

return index;

}

return -1;

};
var jiggleMasks = {
'jm_breasts' : {
slot : "Breasts",
points : []
},
'jm_groin' : {
slot : "Groin",
points : []
},
'jm_butt' : {
slot : "Butt",
points : []
}
};

var condMap = {
'55_stains' : {
conds : ['targetStains'],
},
'51_gloves' : {
conds : ['targetGloves']
},
'50_gloves' : {
conds : ['targetGloves']
},
'19_gloves' : {
conds : ['targetGloves']
},
'18_gloves' : {
conds : ['targetGloves']
},
'41_boots' : {
conds : ['targetBoots']
},
'40_boots' : {
conds : ['targetBoots']
},
'26_sling_heavy' : {
conds: ['targetWearsSlingBikini','targetLowerBodyHard']
},
'25_sling_heavy' : {
conds: ['targetWearsSlingBikini','targetLowerBodyHard']
},
'26_sling_med' : {
conds: ['targetWearsSlingBikini','targetLowerBodyLeather']
},
'25_sling_med' : {
conds: ['targetWearsSlingBikini','targetLowerBodyLeather']
},
'26_sling_light' : {
conds: ['targetWearsSlingBikini']
},
'25_sling_light' : {
conds: ['targetWearsSlingBikini']
},
'26_bodysuit_med' : {
conds: ['targetBodysuit', 'targetLowerBodyLeather']
},
'25_bodysuit_med' : {
conds: ['targetBodysuit', 'targetLowerBodyLeather']
},
'26_bodysuit_light' : {
conds: ['targetBodysuit']
},
'25_bodysuit_light' : {
conds: ['targetBodysuit']
},

'36_heavy_ub' : {
conds: ['targetUpperBodyHard', 'targetNoBodysuit']
},
'35_heavy_ub' : {
conds: ['targetUpperBodyHard', 'targetNoBodysuit']
},

'26_heavy_lb' : {
conds: ['targetLowerBodyHard']
},
'25_heavy_lb' : {
conds: ['targetLowerBodyHard']
},

'36_bikini_med_ub' : {
conds: ['targetUpperBodyBikini', 'targetUpperBodyLeather', 'targetNoBodysuit']
},
'35_bikini_med_ub' : {
conds: ['targetUpperBodyBikini', 'targetUpperBodyLeather', 'targetNoBodysuit']
},
'26_bikini_med_lb' : {
conds: ['targetWearsThong', 'targetLowerBodyLeather']
},
'25_bikini_med_lb' : {
conds: ['targetWearsThong', 'targetLowerBodyLeather']
},

'36_bikini_light_ub' : {
conds: ['targetUpperBodyBikini', 'targetNoBodysuit']
},
'35_bikini_light_ub' : {
conds: ['targetUpperBodyBikini', 'targetNoBodysuit']
},
'26_bikini_light_lb' : {
conds: ['targetWearsThong', 'targetNoBodysuit']
},
'25_bikini_light_lb' : {
conds: ['targetWearsThong', 'targetNoBodysuit']
},

'36_med_ub' : {
conds: ['targetUpperBodyLeather', 'targetNoBodysuit']
},
'35_med_ub' : {
conds: ['targetUpperBodyLeather', 'targetNoBodysuit']
},
'26_med_lb' : {
conds: ['targetLowerBodyLeather']
},
'25_med_lb' : {
conds: ['targetLowerBodyLeather']
},

'36_light_ub' : {
conds: ['targetWearsUpperBody', 'targetNoBodysuit']
},
'35_light_ub' : {
conds: ['targetWearsUpperBody', 'targetNoBodysuit']
},
'26_light_lb' : {
conds: ['targetWearsLowerBody']
},
'25_light_lb' : {
conds: ['targetWearsLowerBody']
},

// Collar can be either above or below armor
'3_collar' : {
conds: ['targetCollar']
},
'23_collar' : {
conds: ['targetCollar']
},
'43_collar' : {
conds: ['targetCollar']
},

'22_nipple_studs' : {
conds: ['targetCollar']
},

'15_aroused_heavy' : {
conds: ['metaVeryArousing'],
stdtag: 'ex_aroused_heavy'
},
'15_pain_heavy' : {
conds: ['metaVeryPainful'],
stdtag : 'ex_pained_heavy'
},
'10_aroused' : {
conds: ['metaArousing'],
stdtag: 'ex_aroused'
},
'10_pain' : {
conds: ['metaPainful'],
stdtag : 'ex_pained'
},
'5_orgasm' : {
conds: ['targetHasOrgasm']
},

};

function round(input){
return Math.round(input*100)/100;
}

function exec(){

preferences.rulerUnits = Units.PIXELS;

fetchLayers(doc);

// Fetch JSON if possible
var jsonFile = new File(dir+jsonName);
jsonFile.encoding = 'UTF8';
if( jsonFile.exists ){

jsonFile.open("r");
var parsed = JSON.parse(jsonFile.read());
url = parsed.url || '';
bgName = parsed.base || "";
pics = parsed.layers;
jsonFile.close();

}

var pngOpts = new PNGSaveOptions();
pngOpts.method = stringIDToTypeID("thorough");
pngOpts.compression = 1;

var missingFromMap = [];
for( var i = 0; i < allLayers.length; ++i ){

var l = allLayers[i];
l.visible = true;
if( i && allLayers[i-1].name.substring(0,1) != "#" )
allLayers[i-1].visible = false;

var baseOpacity = l.opacity;

var bounds = l.bounds;
var left = bounds[0];
var right = docW-bounds[2];
var top = bounds[1];
var bottom = docH - bounds[3];
var width = bounds[2]-bounds[0];
var height = bounds[3]-bounds[1];

var layerName = l.name;
var layerNr = parseInt(layerName);
var blendMode = 'source-over';
if( l.blendMode == BlendMode.MULTIPLY )
blendMode = 'multiply';
else if( l.blendMode == BlendMode.OVERLAY )
blendMode = 'overlay';
var opacity = baseOpacity/100;
var jiggleMask = jiggleMasks[layerName];

if( layerName.substring(0,3) === 'jp_' ){
var layer = layerName.substring(3);
var targ = jiggleMasks['jm_'+layer];
if( targ ){
// Create a jiggle point
var point = {
r : round(width/docW),
x : round((width/2+left)/docW),
y : round((height/2+top)/docH),
};
targ.points.push(point);

}
}
else if( isNaN(layerNr) && !jiggleMask )
alert("Layer "+layerName+" needs to start with the FQ art layer number. Use # if you don't want to save this layer.");
else{

var file = layerName+".png";

var folder = Folder(dir);
if( !folder.exists )
folder.create();

l.opacity = 100;

//alert("Image cropped x:"+left+" y:"+top)
var workLayer = doc.duplicate();

workLayer.crop(bounds);

var fileOut = new File(dir+file)
workLayer.saveAs(fileOut, pngOpts, true);
workLayer.close(SaveOptions.DONOTSAVECHANGES);

l.opacity = baseOpacity;
var baseData = {
x : parseInt(left),
y : parseInt(top),
};

if( jiggleMask ){

baseData.slot = layerName.substring(3);
baseData.mask = file;
baseData = makeJiggleMask(baseData);
baseData.p = jiggleMask.points;

}else{

var duration = 0;
if( layerNr < 18 && layerNr >= 10 )
duration = 3000; // Facial expressions generally.
var slots = {
s26 : 'lowerBody',
s31 : 'hands',
s36 : 'upperBody',
s41 : 'jewelleryCosmetic',
s46 : 'lowerBodyCosmetic',
s51 : 'upperBodyCosmetic',
};

var cmap = condMap[layerName], cm = [], stdtag = '';
if( cmap ){
cm = cmap.conds;
stdtag = cmap.stdtag;
}

if( !cm.length )
missingFromMap.push(layerName);

baseData.layer = layerNr;
baseData.icon = file;
baseData.duration = duration;
baseData.slot = slots['s'+layerNr] || '';
baseData.blendMode = blendMode;
baseData.opacity = opacity;
baseData.conditions = cm;
baseData.stdtag = stdtag;

baseData = makePic(baseData);

}

updatePic(baseData);

}

}
if( missingFromMap.length )
alert("The following layers are missing auto condition definitions, check your spelling etc: "+missingFromMap.join(", "));

// Save BG as nude layer
if( bgLayer ){

if( allLayers.length )
allLayers[i-1].visible = false;
bgLayer.visible = true;
var jpegOpts = new JPEGSaveOptions();
jpegOpts.quality = 9;
var fn = fName+"_n.jpg";
doc.saveAs(new File(dir+fn), jpegOpts, true);
bgName = fn;

}

var keys = [];
for( var i in condMap ){
keys.push(i);
}

pics.sort(function(a, b){

var aln = (a.icon || a.mask).split(".")[0];
var bln = (b.icon || b.mask).split(".")[0];
var aPos = keys.indexOf(aln);
var bPos = keys.indexOf(bln);
if( aPos == bPos )
return 0;
if( aPos == -1 )
return 1;
if( bPos == -1 )
return -1;
return aPos < bPos ? -1 : 1;

});

var dump = JSON.stringify({
base : bgName,
url : url,
layers : pics
}, null, 4);
jsonFile.open("w");
jsonFile.write(dump);
jsonFile.close();

preferences.rulerUnits = startRulesUnits;

}

// Accept data from makePic
function updatePic( picData ){
for( var i = 0; i < pics.length; ++i ){

var p = pics[i];
if( (p.icon && p.icon == picData.icon) || (p.mask && picData.mask === p.mask) ){

if( picData.layer !== undefined )
p.layer = picData.layer;
p.x = picData.x;
p.y = picData.y;
if( picData.blendMode !== undefined )
p.blendMode = picData.blendMode;
if( picData.opacity !== undefined )
p.opacity = picData.opacity;
if( picData.slot !== undefined )
p.slot = picData.slot;
if( picData.p )
p.p = picData.p;

return;
}

}

pics.push(picData);

}

// Fetches all viable art layers
function fetchLayers( parentLayer, ignore ){

for( var i = 0; i < parentLayer.layers.length; ++i ){

var l = parentLayer.layers[i];

var ign = ignore;
var isBg = l.name == "Background";

if( !ignore )
ign = isBg;
if( l.name.substring(0,1) == "#" )
continue;

if( isBg )
bgLayer = l;

l.visible = (l.typename == "LayerSet");

if( l.typename == "LayerSet" ){
fetchLayers(l, ign);
continue;
}

if( !ign )
allLayers.push(l);

}

}

function makeJiggleMask( data ){
if( typeof data != "object" )
data = {};
var out = {};
out.x = data.x || 0;
out.y = data.y || 0;
out.mask = data.mask;
out.slot = data.slot;
return out;

}

function makePic( data ){

if( typeof data != "object" )
data = {};

var out = {};
out.icon = data.icon;
out.conditions = data.conditions || [];
out.layer = data.layer || 0;
out.duration = parseInt(data.duration) || 0;
out.x = data.x || 0;
out.y = data.y || 0;
out.slot = data.slot || '';
out.blendMode = data.blendMode || 'source-over';
out.opacity = 1.0;
if( !isNaN(data.opacity) )
out.opacity = data.opacity;
out.conditions = data.conditions;
out.stdtag = data.stdtag;
return out;

}

function save_as_png(doc, file, copy, comp, filter, none){

try {

if (copy == undefined) copy = true;

if (comp == undefined) comp = 9;

if (none == undefined) none = true;

if (filter == undefined) filter = "PNGFilterAdaptive";

var doc0 = app.activeDocument;

app.activeDocument = doc;

var d = new ActionDescriptor();

var d1 = new ActionDescriptor();

d1.putEnumerated(stringIDToTypeID("method"), stringIDToTypeID("PNGMethod"), stringIDToTypeID("quick"));

if (none)

d1.putEnumerated(stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceNone"));

else

d1.putEnumerated(stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceAdam7"));

d1.putEnumerated(stringIDToTypeID("PNGFilter"), stringIDToTypeID("PNGFilter"), stringIDToTypeID(filter));

d1.putInteger(stringIDToTypeID("compression"), comp);

d.putObject(stringIDToTypeID("as"), stringIDToTypeID("PNGFormat"), d1);

d.putPath(stringIDToTypeID("in"), file);

d.putBoolean(stringIDToTypeID("copy"), copy);

executeAction(stringIDToTypeID("save"), d, DialogModes.NO);

app.activeDocument = doc0;

return true;

}

catch (e) { alert(e); return false; }

}

// json2.js
// 2023-05-10
// Public Domain.
// NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.

// USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
// NOT CONTROL.

// This file creates a global JSON object containing two methods: stringify
// and parse. This file provides the ES5 JSON capability to ES3 systems.
// If a project might run on IE8 or earlier, then this file should be included.
// This file does nothing on ES5 systems.

// JSON.stringify(value, replacer, space)
// value any JavaScript value, usually an object or array.
// replacer an optional parameter that determines how object
// values are stringified for objects. It can be a
// function or an array of strings.
// space an optional parameter that specifies the indentation
// of nested structures. If it is omitted, the text will
// be packed without extra whitespace. If it is a number,
// it will specify the number of spaces to indent at each
// level. If it is a string (such as "\t" or " "),
// it contains the characters used to indent at each level.
// This method produces a JSON text from a JavaScript value.
// When an object value is found, if the object contains a toJSON
// method, its toJSON method will be called and the result will be
// stringified. A toJSON method does not serialize: it returns the
// value represented by the name/value pair that should be serialized,
// or undefined if nothing should be serialized. The toJSON method
// will be passed the key associated with the value, and this will be
// bound to the value.

// For example, this would serialize Dates as ISO strings.

// Date.prototype.toJSON = function (key) {
// function f(n) {
// // Format integers to have at least two digits.
// return (n < 10)
// ? "0" + n
// : n;
// }
// return this.getUTCFullYear() + "-" +
// f(this.getUTCMonth() + 1) + "-" +
// f(this.getUTCDate()) + "T" +
// f(this.getUTCHours()) + ":" +
// f(this.getUTCMinutes()) + ":" +
// f(this.getUTCSeconds()) + "Z";
// };

// You can provide an optional replacer method. It will be passed the
// key and value of each member, with this bound to the containing
// object. The value that is returned from your method will be
// serialized. If your method returns undefined, then the member will
// be excluded from the serialization.

// If the replacer parameter is an array of strings, then it will be
// used to select the members to be serialized. It filters the results
// such that only members with keys listed in the replacer array are
// stringified.

// Values that do not have JSON representations, such as undefined or
// functions, will not be serialized. Such values in objects will be
// dropped; in arrays they will be replaced with null. You can use
// a replacer function to replace those with JSON values.

// JSON.stringify(undefined) returns undefined.

// The optional space parameter produces a stringification of the
// value that is filled with line breaks and indentation to make it
// easier to read.

// If the space parameter is a non-empty string, then that string will
// be used for indentation. If the space parameter is a number, then
// the indentation will be that many spaces.

// Example:

// text = JSON.stringify(["e", {pluribus: "unum"}]);
// // text is '["e",{"pluribus":"unum"}]'

// text = JSON.stringify(["e", {pluribus: "unum"}], null, "\t");
// // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'

// text = JSON.stringify([new Date()], function (key, value) {
// return this[key] instanceof Date
// ? "Date(" + this[key] + ")"
// : value;
// });
// // text is '["Date(---current time---)"]'

// JSON.parse(text, reviver)
// This method parses a JSON text to produce an object or array.
// It can throw a SyntaxError exception.

// The optional reviver parameter is a function that can filter and
// transform the results. It receives each of the keys and values,
// and its return value is used instead of the original value.
// If it returns what it received, then the structure is not modified.
// If it returns undefined then the member is deleted.

// Example:

// // Parse the text. Values that look like ISO date strings will
// // be converted to Date objects.

// myData = JSON.parse(text, function (key, value) {
// var a;
// if (typeof value === "string") {
// a =
// /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
// if (a) {
// return new Date(Date.UTC(
// +a[1], +a[2] - 1, +a[3], +a[4], +a[5], +a[6]
// ));
// }
// return value;
// }
// });

// myData = JSON.parse(
// "[\"Date(09/09/2001)\"]",
// function (key, value) {
// var d;
// if (
// typeof value === "string"
// && value.slice(0, 5) === "Date("
// && value.slice(-1) === ")"
// ) {
// d = new Date(value.slice(5, -1));
// if (d) {
// return d;
// }
// }
// return value;
// }
// );

// This is a reference implementation. You are free to copy, modify, or
// redistribute.

/*jslint
eval, for, this
*/

/*property
JSON, apply, call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
lastIndex, length, parse, prototype, push, replace, slice, stringify,
test, toJSON, toString, valueOf
*/

// Create a JSON object only if one does not already exist. We create the
// methods in a closure to avoid creating global variables.

var JSON = {};

(function () {
"use strict";

var rx_one = /^[\],:{}\s]*$/;
var rx_two = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g;
var rx_three = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g;
var rx_four = /(?:^|:|,)(?:\s*\[)+/g;
var rx_escapable = /[\\"\u0000-\u001f\u007f-\u009f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g;
var rx_dangerous = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g;

function f(n) {
// Format integers to have at least two digits.
return (n < 10)
? "0" + n
: n;
}

function this_value() {
return this.valueOf();
}

if (typeof Date.prototype.toJSON !== "function") {

Date.prototype.toJSON = function () {

return isFinite(this.valueOf())
? (
this.getUTCFullYear()
+ "-"
+ f(this.getUTCMonth() + 1)
+ "-"
+ f(this.getUTCDate())
+ "T"
+ f(this.getUTCHours())
+ ":"
+ f(this.getUTCMinutes())
+ ":"
+ f(this.getUTCSeconds())
+ "Z"
)
: null;
};

Boolean.prototype.toJSON = this_value;
Number.prototype.toJSON = this_value;
String.prototype.toJSON = this_value;
}

var gap;
var indent;
var meta;
var rep;

function quote(string) {

// If the string contains no control characters, no quote characters, and no
// backslash characters, then we can safely slap some quotes around it.
// Otherwise we must also replace the offending characters with safe escape
// sequences.

rx_escapable.lastIndex = 0;
return rx_escapable.test(string)
? "\"" + string.replace(rx_escapable, function (a) {
var c = meta[a];
return typeof c === "string"
? c
: "\\u" + ("0000" + a.charCodeAt(0).toString(16)).slice(-4);
}) + "\""
: "\"" + string + "\"";
}

function str(key, holder) {

// Produce a string from holder[key].

var i; // The loop counter.
var k; // The member key.
var v; // The member value.
var length;
var mind = gap;
var partial;
var value = holder[key];

// If the value has a toJSON method, call it to obtain a replacement value.

if (
value
&& typeof value === "object"
&& typeof value.toJSON === "function"
) {
value = value.toJSON(key);
}

// If we were called with a replacer function, then call the replacer to
// obtain a replacement value.

if (typeof rep === "function") {
value = rep.call(holder, key, value);
}

// What happens next depends on the value's type.

switch (typeof value) {
case "string":
return quote(value);

case "number":

// JSON numbers must be finite. Encode non-finite numbers as null.

return (isFinite(value))
? String(value)
: "null";

case "boolean":
case "null":

// If the value is a boolean or null, convert it to a string. Note:
// typeof null does not produce "null". The case is included here in
// the remote chance that this gets fixed someday.

return String(value);

// If the type is "object", we might be dealing with an object or an array or
// null.

case "object":

// Due to a specification blunder in ECMAScript, typeof null is "object",
// so watch out for that case.

if (!value) {
return "null";
}

// Make an array to hold the partial results of stringifying this object value.

gap += indent;
partial = [];

// Is the value an array?

if (Object.prototype.toString.apply(value) === "[object Array]") {

// The value is an array. Stringify every element. Use null as a placeholder
// for non-JSON values.

length = value.length;
for (i = 0; i < length; i += 1) {
partial[i] = str(i, value) || "null";
}

// Join all of the elements together, separated with commas, and wrap them in
// brackets.

v = partial.length === 0
? "[]"
: gap
? (
"[\n"
+ gap
+ partial.join(",\n" + gap)
+ "\n"
+ mind
+ "]"
)
: "[" + partial.join(",") + "]";
gap = mind;
return v;
}

// If the replacer is an array, use it to select the members to be stringified.

if (rep && typeof rep === "object") {
length = rep.length;
for (i = 0; i < length; i += 1) {
if (typeof rep[i] === "string") {
k = rep[i];
v = str(k, value);
if (v) {
partial.push(quote(k) + (
(gap)
? ": "
: ":"
) + v);
}
}
}
} else {

// Otherwise, iterate through all of the keys in the object.

for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = str(k, value);
if (v) {
partial.push(quote(k) + (
(gap)
? ": "
: ":"
) + v);
}
}
}
}

// Join all of the member texts together, separated with commas,
// and wrap them in braces.

v = partial.length === 0
? "{}"
: gap
? "{\n" + gap + partial.join(",\n" + gap) + "\n" + mind + "}"
: "{" + partial.join(",") + "}";
gap = mind;
return v;
}
}

// If the JSON object does not yet have a stringify method, give it one.

if (typeof JSON.stringify !== "function") {
meta = { // table of character substitutions
"\b": "\\b",
"\t": "\\t",
"\n": "\\n",
"\f": "\\f",
"\r": "\\r",
"\"": "\\\"",
"\\": "\\\\"
};
JSON.stringify = function (value, replacer, space) {

// The stringify method takes a value and an optional replacer, and an optional
// space parameter, and returns a JSON text. The replacer can be a function
// that can replace values, or an array of strings that will select the keys.
// A default replacer method can be provided. Use of the space parameter can
// produce text that is more easily readable.

var i;
gap = "";
indent = "";

// If the space parameter is a number, make an indent string containing that
// many spaces.

if (typeof space === "number") {
for (i = 0; i < space; i += 1) {
indent += " ";
}

// If the space parameter is a string, it will be used as the indent string.

} else if (typeof space === "string") {
indent = space;
}

// If there is a replacer, it must be a function or an array.
// Otherwise, throw an error.

rep = replacer;
if (replacer && typeof replacer !== "function" && (
typeof replacer !== "object"
|| typeof replacer.length !== "number"
)) {
throw new Error("JSON.stringify");
}

// Make a fake root object containing our value under the key of "".
// Return the result of stringifying the value.

return str("", {"": value});
};
}

// If the JSON object does not yet have a parse method, give it one.

if (typeof JSON.parse !== "function") {
JSON.parse = function (text, reviver) {

// The parse method takes a text and an optional reviver function, and returns
// a JavaScript value if the text is a valid JSON text.

var j;

function walk(holder, key) {

// The walk method is used to recursively walk the resulting structure so
// that modifications can be made.

var k;
var v;
var value = holder[key];
if (value && typeof value === "object") {
for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = walk(value, k);
if (v !== undefined) {
value[k] = v;
} else {
delete value[k];
}
}
}
}
return reviver.call(holder, key, value);
}

// Parsing happens in four stages. In the first stage, we replace certain
// Unicode characters with escape sequences. JavaScript handles many characters
// incorrectly, either silently deleting them, or treating them as line endings.

text = String(text);
rx_dangerous.lastIndex = 0;
if (rx_dangerous.test(text)) {
text = text.replace(rx_dangerous, function (a) {
return (
"\\u"
+ ("0000" + a.charCodeAt(0).toString(16)).slice(-4)
);
});
}

// In the second stage, we run the text against regular expressions that look
// for non-JSON patterns. We are especially concerned with "()" and "new"
// because they can cause invocation, and "=" because it can cause mutation.
// But just to be safe, we want to reject all unexpected forms.

// We split the second stage into 4 regexp operations in order to work around
// crippling inefficiencies in IE's and Safari's regexp engines. First we
// replace the JSON backslash pairs with "@" (a non-JSON character). Second, we
// replace all simple value tokens with "]" characters. Third, we delete all
// open brackets that follow a colon or comma or that begin the text. Finally,
// we look to see that the remaining characters are only whitespace or "]" or
// "," or ":" or "{" or "}". If that is so, then the text is safe for eval.

if (
rx_one.test(
text
.replace(rx_two, "@")
.replace(rx_three, "]")
.replace(rx_four, "")
)
) {

// In the third stage we use the eval function to compile the text into a
// JavaScript structure. The "{" operator is subject to a syntactic ambiguity
// in JavaScript: it can begin a block or an object literal. We wrap the text
// in parens to eliminate the ambiguity.

j = eval("(" + text + ")");

// In the optional fourth stage, we recursively walk the new structure, passing
// each name/value pair to a reviver function for possible transformation.

return (typeof reviver === "function")
? walk({"": j}, "")
: j;
}

// If the text is not JSON parseable, then a SyntaxError is thrown.

throw new SyntaxError("JSON.parse");
};
}
}());

exec();

</pre>

[[Category:Modding]]

Player (Asset)

2026-06-05T14:06:57Z

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.
|-
|Icon Y Offset
|Int
|
|Offset from top to put portrait in percent. 0 uses default (5%).
|-
|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
|Sets how powerful an NPC is compared to other NPCs in the encounter. Note that this value is normalized. If you want a harder fight, set difficulty on the encounter instead.
|-
|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.
|}

Player (Asset)

2026-06-05T13:06:52Z

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.
|-
|Icon Y Offset
|Int
|
|Offset from top to put portrait in percent. 0 uses default (5%).
|-
|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.
|}

FqAutoLayers

2026-06-05T11:54:34Z

JasX:

This script will automatically try to remove unchanged pixels. Save it as fqAutoLayers.jsx and import into photoshop.

<pre>
var startRulesUnits = preferences.rulerUnits;
var doc = activeDocument;
var bgLayer;
var allLayers = [];

var layerNames = {
stains : 55,
gloves : 50,
boots : 40,

sling_heavy: 25,
sling_med : 25,
sling_leather : {alias:"sling_med", num:25},
sling_medium : {alias:"sling_med", num:25},
sling_light : 25,
sling_cloth : {alias:"sling_light", num:25},

bodysuit_med : 25,
bodysuit_medium : {alias:"bodysuit_med", num:25},
bodysuit_leather : {alias:"bodysuit_med", num:25},

bodysuit_light : 25,
bodysuit_cloth : {alias:"bodysuit_light", num:25},

bikini_med : 35,
bikini_light : 35,

heavy : {alias:"heavy_ub",num:35},

leather : {alias:"med_ub", num:35},
med : {alias:"med_ub", num:35},
medium : {alias:"med_ub", num:35},

armor : {alias:"light_ub",num:35}, // Used for NPCs with only one armor set
cloth : {alias:"light_ub", num:35},
light : {alias:"light_ub", num:35},

collar : 23,
nipple_studs : 22,
stocks_aroused : {alias:"aroused", num:10},
aroused : 10,
stocks_pain : {alias:"pain", num:10},
pain : 10,
stocks_orgasm : {alias:"orgasm", num:5},
orgasm : 5,
stocks_pain_heavy : {alias:"pain_heavy", num:15},
pain_heavy: 15,
stocks_aroused_heavy : {alias:"aroused_heavy", num:15},
aroused_heavy: 15
};

function exec(){

fetchLayers(doc);

for( var i = 0; i < allLayers.length; ++i ){

hideAllLayers();

var l = allLayers[i];
activeDocument.activeLayer = l;
l.visible = true;

l.blendMode = BlendMode.DIFFERENCE;

quickSel(0,0,1);
doc.selection.clear();
doc.selection.deselect();

l.blendMode = BlendMode.NORMAL;
}

}

function quickSel (x, y, tol){

var idsetd = charIDToTypeID( "setd" );
var desc2 = new ActionDescriptor();
var idnull = charIDToTypeID( "null" );
var ref1 = new ActionReference();
var idChnl = charIDToTypeID( "Chnl" );
var idfsel = charIDToTypeID( "fsel" );
ref1.putProperty( idChnl, idfsel );
desc2.putReference( idnull, ref1 );
var idT = charIDToTypeID( "T " );
var desc3 = new ActionDescriptor();
var idHrzn = charIDToTypeID( "Hrzn" );
var idPxl = charIDToTypeID( "#Pxl" );
desc3.putUnitDouble( idHrzn, idPxl, x );
var idVrtc = charIDToTypeID( "Vrtc" );
var idPxl = charIDToTypeID( "#Pxl" );
desc3.putUnitDouble( idVrtc, idPxl, y);
var idPnt = charIDToTypeID( "Pnt " );
desc2.putObject( idT, idPnt, desc3 );
var idTlrn = charIDToTypeID( "Tlrn" );
desc2.putInteger( idTlrn, tol);
var idAntA = charIDToTypeID( "AntA" );
desc2.putBoolean( idAntA, true );
var idCntg = charIDToTypeID( "Cntg" );
desc2.putBoolean( idCntg, true );
var idMrgd = charIDToTypeID( "Mrgd" );
desc2.putBoolean( idMrgd, true );
executeAction( idsetd, desc2, DialogModes.NO );

};

function hideAllLayers(){
for( var i = 0; i < allLayers.length; ++i )
allLayers[i].visible = false;

}

// Fetches all viable art layers
function fetchLayers( parentLayer, ignore ){

for( var i = 0; i < parentLayer.layers.length; ++i ){

var l = parentLayer.layers[i];

var ign = ignore;
var isBg = l.name == "Background";
if( !ignore )
ign = ( l.name.substring(0,1) == "#" || isBg || l.name.substring(0,1) == "." );
if( isBg )
bgLayer = l;

if( l.typename == "LayerSet" ){
fetchLayers(l, ign);
continue;
}

if( !isBg ){

var subname = l.name.split('.');
subname.pop();
subname = subname.join(".").toLowerCase();
var itm = layerNames[subname];
if( itm !== undefined ){
if( typeof itm === "object" ){
subname = itm.alias;
itm = itm.num;
}
l.name = itm+"_"+subname;
}
}

if( !ign ){
allLayers.push(l);
}
}

}

exec();

</pre>

FQCrop Batch

2026-06-05T11:53:55Z

JasX:

The following is a script you can use along with the [[Creating Advanced Art Layers|Creating Advanced Art Layers Guide]] to speed up connecting your advanced art layers to your FQ mod.

To use it, simply copy the content into a new text file and name it fqcrop_batch.jsx

You can either put this in your Phothoshop/Presets/Scripts folder and restart photoshop to use it from file > scripts. Or you can go to file > scripts > browse.

<pre>
/*
Note: This is similar to the fqcrop.jsx file except it exports all layers one at a time.
Usage: See fqcrop.jsx for more info. Things you need to keep in mind in this implementation:
- Each art layer can only consist of ONE photoshop layer
- All layers must begin with <layerNr>_ ex 30_bikini_light_ub to use layer 30 (upper body base)
- A JSON metadata file named the same as the original file will be created or updated. It's going to need a bit of editing, but you can use it to quickly upload a full character.
- Layers and groups starting with # are ignored.
- If a JSON file exists, it's loaded and updated. Missing layers aren't deleted from it. So if you remove layers you have to remove them from the JSON file or delete the JSON file to generate a new one.
- The following values are overwritten into the JSON file, using the photoshop settings:
- icon
- x
- y
- blendMode (only normal, multiply, overlay are supported)
- opacity
*/
var startRulesUnits = preferences.rulerUnits;
var doc = activeDocument;
var docW = doc.width;
var docH = doc.height;
var allLayers = [];
var dirJson = decodeURI(doc.path.fsName)+"/";
var jsonName = doc.name.split(".");
jsonName.pop();
var fName = jsonName.join('_')
var dir = dirJson+fName+"/";
jsonName = jsonName.join(".")+".json";
var pics = [];
var url = '';
var bgName = "";
var bgLayer;
Array.prototype.indexOf = function ( item ) {

var index = 0, length = this.length;

for ( ; index < length; index++ ) {

if ( this[index] === item )

return index;

}

return -1;

};
var jiggleMasks = {
'jm_breasts' : {
slot : "Breasts",
points : []
},
'jm_groin' : {
slot : "Groin",
points : []
},
'jm_butt' : {
slot : "Butt",
points : []
}
};

var condMap = {
'55_stains' : {
conds : ['targetStains'],
},
'51_gloves' : {
conds : ['targetGloves']
},
'50_gloves' : {
conds : ['targetGloves']
},
'19_gloves' : {
conds : ['targetGloves']
},
'18_gloves' : {
conds : ['targetGloves']
},
'41_boots' : {
conds : ['targetBoots']
},
'40_boots' : {
conds : ['targetBoots']
},
'26_sling_heavy' : {
conds: ['targetWearsSlingBikini','targetLowerBodyHard']
},
'25_sling_heavy' : {
conds: ['targetWearsSlingBikini','targetLowerBodyHard']
},
'26_sling_med' : {
conds: ['targetWearsSlingBikini','targetLowerBodyLeather']
},
'25_sling_med' : {
conds: ['targetWearsSlingBikini','targetLowerBodyLeather']
},
'26_sling_light' : {
conds: ['targetWearsSlingBikini']
},
'25_sling_light' : {
conds: ['targetWearsSlingBikini']
},
'26_bodysuit_med' : {
conds: ['targetBodysuit', 'targetLowerBodyLeather']
},
'25_bodysuit_med' : {
conds: ['targetBodysuit', 'targetLowerBodyLeather']
},
'26_bodysuit_light' : {
conds: ['targetBodysuit']
},
'25_bodysuit_light' : {
conds: ['targetBodysuit']
},

'36_heavy_ub' : {
conds: ['targetUpperBodyHard', 'targetNoBodysuit']
},
'35_heavy_ub' : {
conds: ['targetUpperBodyHard', 'targetNoBodysuit']
},

'26_heavy_lb' : {
conds: ['targetLowerBodyHard']
},
'25_heavy_lb' : {
conds: ['targetLowerBodyHard']
},

'36_bikini_med_ub' : {
conds: ['targetUpperBodyBikini', 'targetUpperBodyLeather', 'targetNoBodysuit']
},
'35_bikini_med_ub' : {
conds: ['targetUpperBodyBikini', 'targetUpperBodyLeather', 'targetNoBodysuit']
},
'26_bikini_med_lb' : {
conds: ['targetWearsThong', 'targetLowerBodyLeather']
},
'25_bikini_med_lb' : {
conds: ['targetWearsThong', 'targetLowerBodyLeather']
},

'36_bikini_light_ub' : {
conds: ['targetUpperBodyBikini', 'targetNoBodysuit']
},
'35_bikini_light_ub' : {
conds: ['targetUpperBodyBikini', 'targetNoBodysuit']
},
'26_bikini_light_lb' : {
conds: ['targetWearsThong', 'targetNoBodysuit']
},
'25_bikini_light_lb' : {
conds: ['targetWearsThong', 'targetNoBodysuit']
},

'36_med_ub' : {
conds: ['targetUpperBodyLeather', 'targetNoBodysuit']
},
'35_med_ub' : {
conds: ['targetUpperBodyLeather', 'targetNoBodysuit']
},
'26_med_lb' : {
conds: ['targetLowerBodyLeather']
},
'25_med_lb' : {
conds: ['targetLowerBodyLeather']
},

'36_light_ub' : {
conds: ['targetWearsUpperBody', 'targetNoBodysuit']
},
'35_light_ub' : {
conds: ['targetWearsUpperBody', 'targetNoBodysuit']
},
'26_light_lb' : {
conds: ['targetWearsLowerBody']
},
'25_light_lb' : {
conds: ['targetWearsLowerBody']
},

// Collar can be either above or below armor
'3_collar' : {
conds: ['targetCollar']
},
'23_collar' : {
conds: ['targetCollar']
},
'43_collar' : {
conds: ['targetCollar']
},

'22_nipple_studs' : {
conds: ['targetCollar']
},

'15_aroused_heavy' : {
conds: ['metaVeryArousing'],
stdtag: 'ex_aroused_heavy'
},
'15_pain_heavy' : {
conds: ['metaVeryPainful'],
stdtag : 'ex_pained_heavy'
},
'10_aroused' : {
conds: ['metaArousing'],
stdtag: 'ex_aroused'
},
'10_pain' : {
conds: ['metaPainful'],
stdtag : 'ex_pained'
},
'5_orgasm' : {
conds: ['targetHasOrgasm']
},

};

function round(input){
return Math.round(input*100)/100;
}

function exec(){

preferences.rulerUnits = Units.PIXELS;

fetchLayers(doc);

// Fetch JSON if possible
var jsonFile = new File(dir+jsonName);
jsonFile.encoding = 'UTF8';
if( jsonFile.exists ){

jsonFile.open("r");
var parsed = JSON.parse(jsonFile.read());
url = parsed.url || '';
bgName = parsed.base || "";
pics = parsed.layers;
jsonFile.close();

}

var pngOpts = new PNGSaveOptions();
pngOpts.method = stringIDToTypeID("thorough");
pngOpts.compression = 1;

var missingFromMap = [];
for( var i = 0; i < allLayers.length; ++i ){

var l = allLayers[i];
l.visible = true;
if( i && allLayers[i-1].name.substring(0,1) != "#" )
allLayers[i-1].visible = false;

var baseOpacity = l.opacity;

var bounds = l.bounds;
var left = bounds[0];
var right = docW-bounds[2];
var top = bounds[1];
var bottom = docH - bounds[3];
var width = bounds[2]-bounds[0];
var height = bounds[3]-bounds[1];

var layerName = l.name;
var layerNr = parseInt(layerName);
var blendMode = 'source-over';
if( l.blendMode == BlendMode.MULTIPLY )
blendMode = 'multiply';
else if( l.blendMode == BlendMode.OVERLAY )
blendMode = 'overlay';
var opacity = baseOpacity/100;
var jiggleMask = jiggleMasks[layerName];

if( layerName.substring(0,3) === 'jp_' ){
var layer = layerName.substring(3);
var targ = jiggleMasks['jm_'+layer];
if( targ ){
// Create a jiggle point
var point = {
r : round(width/docW),
x : round((width/2+left)/docW),
y : round((height/2+top)/docH),
};
targ.points.push(point);

}
}
else if( isNaN(layerNr) && !jiggleMask )
alert("Layer "+layerName+" needs to start with the FQ art layer number. Use # if you don't want to save this layer.");
else{

var file = layerName+".png";

var folder = Folder(dir);
if( !folder.exists )
folder.create();

l.opacity = 100;

//alert("Image cropped x:"+left+" y:"+top)
var workLayer = doc.duplicate();

workLayer.crop(bounds);

var fileOut = new File(dir+file)
workLayer.saveAs(fileOut, pngOpts, true);
workLayer.close(SaveOptions.DONOTSAVECHANGES);

l.opacity = baseOpacity;
var baseData = {
x : parseInt(left),
y : parseInt(top),
};

if( jiggleMask ){

baseData.slot = layerName.substring(3);
baseData.mask = file;
baseData = makeJiggleMask(baseData);
baseData.p = jiggleMask.points;

}else{

var duration = 0;
if( layerNr < 20 && layerNr >= 10 )
duration = 3000; // Facial expressions generally.
var slots = {
s26 : 'lowerBody',
s31 : 'hands',
s36 : 'upperBody',
s41 : 'jewelleryCosmetic',
s46 : 'lowerBodyCosmetic',
s51 : 'upperBodyCosmetic',
};

var cmap = condMap[layerName], cm = [], stdtag = '';
if( cmap ){
cm = cmap.conds;
stdtag = cmap.stdtag;
}

if( !cm.length )
missingFromMap.push(layerName);

baseData.layer = layerNr;
baseData.icon = file;
baseData.duration = duration;
baseData.slot = slots['s'+layerNr] || '';
baseData.blendMode = blendMode;
baseData.opacity = opacity;
baseData.conditions = cm;
baseData.stdtag = stdtag;

baseData = makePic(baseData);

}

updatePic(baseData);

}

}
if( missingFromMap.length )
alert("The following layers are missing auto condition definitions, check your spelling etc: "+missingFromMap.join(", "));

// Save BG as nude layer
if( bgLayer ){

if( allLayers.length )
allLayers[i-1].visible = false;
bgLayer.visible = true;
var jpegOpts = new JPEGSaveOptions();
jpegOpts.quality = 9;
var fn = fName+"_n.jpg";
doc.saveAs(new File(dir+fn), jpegOpts, true);
bgName = fn;

}

var keys = [];
for( var i in condMap ){
keys.push(i);
}

pics.sort(function(a, b){

var aln = (a.icon || a.mask).split(".")[0];
var bln = (b.icon || b.mask).split(".")[0];
var aPos = keys.indexOf(aln);
var bPos = keys.indexOf(bln);
if( aPos == bPos )
return 0;
if( aPos == -1 )
return 1;
if( bPos == -1 )
return -1;
return aPos < bPos ? -1 : 1;

});

var dump = JSON.stringify({
base : bgName,
url : url,
layers : pics
}, null, 4);
jsonFile.open("w");
jsonFile.write(dump);
jsonFile.close();

preferences.rulerUnits = startRulesUnits;

}

// Accept data from makePic
function updatePic( picData ){
for( var i = 0; i < pics.length; ++i ){

var p = pics[i];
if( (p.icon && p.icon == picData.icon) || (p.mask && picData.mask === p.mask) ){

if( picData.layer !== undefined )
p.layer = picData.layer;
p.x = picData.x;
p.y = picData.y;
if( picData.blendMode !== undefined )
p.blendMode = picData.blendMode;
if( picData.opacity !== undefined )
p.opacity = picData.opacity;
if( picData.slot !== undefined )
p.slot = picData.slot;
if( picData.p )
p.p = picData.p;

return;
}

}

pics.push(picData);

}

// Fetches all viable art layers
function fetchLayers( parentLayer, ignore ){

for( var i = 0; i < parentLayer.layers.length; ++i ){

var l = parentLayer.layers[i];

var ign = ignore;
var isBg = l.name == "Background";

if( !ignore )
ign = isBg;
if( l.name.substring(0,1) == "#" )
continue;

if( isBg )
bgLayer = l;

l.visible = (l.typename == "LayerSet");

if( l.typename == "LayerSet" ){
fetchLayers(l, ign);
continue;
}

if( !ign )
allLayers.push(l);

}

}

function makeJiggleMask( data ){
if( typeof data != "object" )
data = {};
var out = {};
out.x = data.x || 0;
out.y = data.y || 0;
out.mask = data.mask;
out.slot = data.slot;
return out;

}

function makePic( data ){

if( typeof data != "object" )
data = {};

var out = {};
out.icon = data.icon;
out.conditions = data.conditions || [];
out.layer = data.layer || 0;
out.duration = parseInt(data.duration) || 0;
out.x = data.x || 0;
out.y = data.y || 0;
out.slot = data.slot || '';
out.blendMode = data.blendMode || 'source-over';
out.opacity = 1.0;
if( !isNaN(data.opacity) )
out.opacity = data.opacity;
out.conditions = data.conditions;
out.stdtag = data.stdtag;
return out;

}

function save_as_png(doc, file, copy, comp, filter, none){

try {

if (copy == undefined) copy = true;

if (comp == undefined) comp = 9;

if (none == undefined) none = true;

if (filter == undefined) filter = "PNGFilterAdaptive";

var doc0 = app.activeDocument;

app.activeDocument = doc;

var d = new ActionDescriptor();

var d1 = new ActionDescriptor();

d1.putEnumerated(stringIDToTypeID("method"), stringIDToTypeID("PNGMethod"), stringIDToTypeID("quick"));

if (none)

d1.putEnumerated(stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceNone"));

else

d1.putEnumerated(stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceAdam7"));

d1.putEnumerated(stringIDToTypeID("PNGFilter"), stringIDToTypeID("PNGFilter"), stringIDToTypeID(filter));

d1.putInteger(stringIDToTypeID("compression"), comp);

d.putObject(stringIDToTypeID("as"), stringIDToTypeID("PNGFormat"), d1);

d.putPath(stringIDToTypeID("in"), file);

d.putBoolean(stringIDToTypeID("copy"), copy);

executeAction(stringIDToTypeID("save"), d, DialogModes.NO);

app.activeDocument = doc0;

return true;

}

catch (e) { alert(e); return false; }

}

// json2.js
// 2023-05-10
// Public Domain.
// NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.

// USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
// NOT CONTROL.

// This file creates a global JSON object containing two methods: stringify
// and parse. This file provides the ES5 JSON capability to ES3 systems.
// If a project might run on IE8 or earlier, then this file should be included.
// This file does nothing on ES5 systems.

// JSON.stringify(value, replacer, space)
// value any JavaScript value, usually an object or array.
// replacer an optional parameter that determines how object
// values are stringified for objects. It can be a
// function or an array of strings.
// space an optional parameter that specifies the indentation
// of nested structures. If it is omitted, the text will
// be packed without extra whitespace. If it is a number,
// it will specify the number of spaces to indent at each
// level. If it is a string (such as "\t" or " "),
// it contains the characters used to indent at each level.
// This method produces a JSON text from a JavaScript value.
// When an object value is found, if the object contains a toJSON
// method, its toJSON method will be called and the result will be
// stringified. A toJSON method does not serialize: it returns the
// value represented by the name/value pair that should be serialized,
// or undefined if nothing should be serialized. The toJSON method
// will be passed the key associated with the value, and this will be
// bound to the value.

// For example, this would serialize Dates as ISO strings.

// Date.prototype.toJSON = function (key) {
// function f(n) {
// // Format integers to have at least two digits.
// return (n < 10)
// ? "0" + n
// : n;
// }
// return this.getUTCFullYear() + "-" +
// f(this.getUTCMonth() + 1) + "-" +
// f(this.getUTCDate()) + "T" +
// f(this.getUTCHours()) + ":" +
// f(this.getUTCMinutes()) + ":" +
// f(this.getUTCSeconds()) + "Z";
// };

// You can provide an optional replacer method. It will be passed the
// key and value of each member, with this bound to the containing
// object. The value that is returned from your method will be
// serialized. If your method returns undefined, then the member will
// be excluded from the serialization.

// If the replacer parameter is an array of strings, then it will be
// used to select the members to be serialized. It filters the results
// such that only members with keys listed in the replacer array are
// stringified.

// Values that do not have JSON representations, such as undefined or
// functions, will not be serialized. Such values in objects will be
// dropped; in arrays they will be replaced with null. You can use
// a replacer function to replace those with JSON values.

// JSON.stringify(undefined) returns undefined.

// The optional space parameter produces a stringification of the
// value that is filled with line breaks and indentation to make it
// easier to read.

// If the space parameter is a non-empty string, then that string will
// be used for indentation. If the space parameter is a number, then
// the indentation will be that many spaces.

// Example:

// text = JSON.stringify(["e", {pluribus: "unum"}]);
// // text is '["e",{"pluribus":"unum"}]'

// text = JSON.stringify(["e", {pluribus: "unum"}], null, "\t");
// // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'

// text = JSON.stringify([new Date()], function (key, value) {
// return this[key] instanceof Date
// ? "Date(" + this[key] + ")"
// : value;
// });
// // text is '["Date(---current time---)"]'

// JSON.parse(text, reviver)
// This method parses a JSON text to produce an object or array.
// It can throw a SyntaxError exception.

// The optional reviver parameter is a function that can filter and
// transform the results. It receives each of the keys and values,
// and its return value is used instead of the original value.
// If it returns what it received, then the structure is not modified.
// If it returns undefined then the member is deleted.

// Example:

// // Parse the text. Values that look like ISO date strings will
// // be converted to Date objects.

// myData = JSON.parse(text, function (key, value) {
// var a;
// if (typeof value === "string") {
// a =
// /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
// if (a) {
// return new Date(Date.UTC(
// +a[1], +a[2] - 1, +a[3], +a[4], +a[5], +a[6]
// ));
// }
// return value;
// }
// });

// myData = JSON.parse(
// "[\"Date(09/09/2001)\"]",
// function (key, value) {
// var d;
// if (
// typeof value === "string"
// && value.slice(0, 5) === "Date("
// && value.slice(-1) === ")"
// ) {
// d = new Date(value.slice(5, -1));
// if (d) {
// return d;
// }
// }
// return value;
// }
// );

// This is a reference implementation. You are free to copy, modify, or
// redistribute.

/*jslint
eval, for, this
*/

/*property
JSON, apply, call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
lastIndex, length, parse, prototype, push, replace, slice, stringify,
test, toJSON, toString, valueOf
*/

// Create a JSON object only if one does not already exist. We create the
// methods in a closure to avoid creating global variables.

var JSON = {};

(function () {
"use strict";

var rx_one = /^[\],:{}\s]*$/;
var rx_two = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g;
var rx_three = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g;
var rx_four = /(?:^|:|,)(?:\s*\[)+/g;
var rx_escapable = /[\\"\u0000-\u001f\u007f-\u009f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g;
var rx_dangerous = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g;

function f(n) {
// Format integers to have at least two digits.
return (n < 10)
? "0" + n
: n;
}

function this_value() {
return this.valueOf();
}

if (typeof Date.prototype.toJSON !== "function") {

Date.prototype.toJSON = function () {

return isFinite(this.valueOf())
? (
this.getUTCFullYear()
+ "-"
+ f(this.getUTCMonth() + 1)
+ "-"
+ f(this.getUTCDate())
+ "T"
+ f(this.getUTCHours())
+ ":"
+ f(this.getUTCMinutes())
+ ":"
+ f(this.getUTCSeconds())
+ "Z"
)
: null;
};

Boolean.prototype.toJSON = this_value;
Number.prototype.toJSON = this_value;
String.prototype.toJSON = this_value;
}

var gap;
var indent;
var meta;
var rep;

function quote(string) {

// If the string contains no control characters, no quote characters, and no
// backslash characters, then we can safely slap some quotes around it.
// Otherwise we must also replace the offending characters with safe escape
// sequences.

rx_escapable.lastIndex = 0;
return rx_escapable.test(string)
? "\"" + string.replace(rx_escapable, function (a) {
var c = meta[a];
return typeof c === "string"
? c
: "\\u" + ("0000" + a.charCodeAt(0).toString(16)).slice(-4);
}) + "\""
: "\"" + string + "\"";
}

function str(key, holder) {

// Produce a string from holder[key].

var i; // The loop counter.
var k; // The member key.
var v; // The member value.
var length;
var mind = gap;
var partial;
var value = holder[key];

// If the value has a toJSON method, call it to obtain a replacement value.

if (
value
&& typeof value === "object"
&& typeof value.toJSON === "function"
) {
value = value.toJSON(key);
}

// If we were called with a replacer function, then call the replacer to
// obtain a replacement value.

if (typeof rep === "function") {
value = rep.call(holder, key, value);
}

// What happens next depends on the value's type.

switch (typeof value) {
case "string":
return quote(value);

case "number":

// JSON numbers must be finite. Encode non-finite numbers as null.

return (isFinite(value))
? String(value)
: "null";

case "boolean":
case "null":

// If the value is a boolean or null, convert it to a string. Note:
// typeof null does not produce "null". The case is included here in
// the remote chance that this gets fixed someday.

return String(value);

// If the type is "object", we might be dealing with an object or an array or
// null.

case "object":

// Due to a specification blunder in ECMAScript, typeof null is "object",
// so watch out for that case.

if (!value) {
return "null";
}

// Make an array to hold the partial results of stringifying this object value.

gap += indent;
partial = [];

// Is the value an array?

if (Object.prototype.toString.apply(value) === "[object Array]") {

// The value is an array. Stringify every element. Use null as a placeholder
// for non-JSON values.

length = value.length;
for (i = 0; i < length; i += 1) {
partial[i] = str(i, value) || "null";
}

// Join all of the elements together, separated with commas, and wrap them in
// brackets.

v = partial.length === 0
? "[]"
: gap
? (
"[\n"
+ gap
+ partial.join(",\n" + gap)
+ "\n"
+ mind
+ "]"
)
: "[" + partial.join(",") + "]";
gap = mind;
return v;
}

// If the replacer is an array, use it to select the members to be stringified.

if (rep && typeof rep === "object") {
length = rep.length;
for (i = 0; i < length; i += 1) {
if (typeof rep[i] === "string") {
k = rep[i];
v = str(k, value);
if (v) {
partial.push(quote(k) + (
(gap)
? ": "
: ":"
) + v);
}
}
}
} else {

// Otherwise, iterate through all of the keys in the object.

for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = str(k, value);
if (v) {
partial.push(quote(k) + (
(gap)
? ": "
: ":"
) + v);
}
}
}
}

// Join all of the member texts together, separated with commas,
// and wrap them in braces.

v = partial.length === 0
? "{}"
: gap
? "{\n" + gap + partial.join(",\n" + gap) + "\n" + mind + "}"
: "{" + partial.join(",") + "}";
gap = mind;
return v;
}
}

// If the JSON object does not yet have a stringify method, give it one.

if (typeof JSON.stringify !== "function") {
meta = { // table of character substitutions
"\b": "\\b",
"\t": "\\t",
"\n": "\\n",
"\f": "\\f",
"\r": "\\r",
"\"": "\\\"",
"\\": "\\\\"
};
JSON.stringify = function (value, replacer, space) {

// The stringify method takes a value and an optional replacer, and an optional
// space parameter, and returns a JSON text. The replacer can be a function
// that can replace values, or an array of strings that will select the keys.
// A default replacer method can be provided. Use of the space parameter can
// produce text that is more easily readable.

var i;
gap = "";
indent = "";

// If the space parameter is a number, make an indent string containing that
// many spaces.

if (typeof space === "number") {
for (i = 0; i < space; i += 1) {
indent += " ";
}

// If the space parameter is a string, it will be used as the indent string.

} else if (typeof space === "string") {
indent = space;
}

// If there is a replacer, it must be a function or an array.
// Otherwise, throw an error.

rep = replacer;
if (replacer && typeof replacer !== "function" && (
typeof replacer !== "object"
|| typeof replacer.length !== "number"
)) {
throw new Error("JSON.stringify");
}

// Make a fake root object containing our value under the key of "".
// Return the result of stringifying the value.

return str("", {"": value});
};
}

// If the JSON object does not yet have a parse method, give it one.

if (typeof JSON.parse !== "function") {
JSON.parse = function (text, reviver) {

// The parse method takes a text and an optional reviver function, and returns
// a JavaScript value if the text is a valid JSON text.

var j;

function walk(holder, key) {

// The walk method is used to recursively walk the resulting structure so
// that modifications can be made.

var k;
var v;
var value = holder[key];
if (value && typeof value === "object") {
for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = walk(value, k);
if (v !== undefined) {
value[k] = v;
} else {
delete value[k];
}
}
}
}
return reviver.call(holder, key, value);
}

// Parsing happens in four stages. In the first stage, we replace certain
// Unicode characters with escape sequences. JavaScript handles many characters
// incorrectly, either silently deleting them, or treating them as line endings.

text = String(text);
rx_dangerous.lastIndex = 0;
if (rx_dangerous.test(text)) {
text = text.replace(rx_dangerous, function (a) {
return (
"\\u"
+ ("0000" + a.charCodeAt(0).toString(16)).slice(-4)
);
});
}

// In the second stage, we run the text against regular expressions that look
// for non-JSON patterns. We are especially concerned with "()" and "new"
// because they can cause invocation, and "=" because it can cause mutation.
// But just to be safe, we want to reject all unexpected forms.

// We split the second stage into 4 regexp operations in order to work around
// crippling inefficiencies in IE's and Safari's regexp engines. First we
// replace the JSON backslash pairs with "@" (a non-JSON character). Second, we
// replace all simple value tokens with "]" characters. Third, we delete all
// open brackets that follow a colon or comma or that begin the text. Finally,
// we look to see that the remaining characters are only whitespace or "]" or
// "," or ":" or "{" or "}". If that is so, then the text is safe for eval.

if (
rx_one.test(
text
.replace(rx_two, "@")
.replace(rx_three, "]")
.replace(rx_four, "")
)
) {

// In the third stage we use the eval function to compile the text into a
// JavaScript structure. The "{" operator is subject to a syntactic ambiguity
// in JavaScript: it can begin a block or an object literal. We wrap the text
// in parens to eliminate the ambiguity.

j = eval("(" + text + ")");

// In the optional fourth stage, we recursively walk the new structure, passing
// each name/value pair to a reviver function for possible transformation.

return (typeof reviver === "function")
? walk({"": j}, "")
: j;
}

// If the text is not JSON parseable, then a SyntaxError is thrown.

throw new SyntaxError("JSON.parse");
};
}
}());

exec();

</pre>

[[Category:Modding]]

FqAutoLayers

2026-06-05T11:53:39Z

JasX:

This script will automatically try to remove unchanged pixels. Save it as fqAutoLayers.jsx and import into photoshop.

<pre>
/*
Note: This is similar to the fqcrop.jsx file except it exports all layers one at a time.
Usage: See fqcrop.jsx for more info. Things you need to keep in mind in this implementation:
- Each art layer can only consist of ONE photoshop layer
- All layers must begin with <layerNr>_ ex 30_bikini_light_ub to use layer 30 (upper body base)
- A JSON metadata file named the same as the original file will be created or updated. It's going to need a bit of editing, but you can use it to quickly upload a full character.
- Layers and groups starting with # are ignored.
- If a JSON file exists, it's loaded and updated. Missing layers aren't deleted from it. So if you remove layers you have to remove them from the JSON file or delete the JSON file to generate a new one.
- The following values are overwritten into the JSON file, using the photoshop settings:
- icon
- x
- y
- blendMode (only normal, multiply, overlay are supported)
- opacity
*/
var startRulesUnits = preferences.rulerUnits;
var doc = activeDocument;
var docW = doc.width;
var docH = doc.height;
var allLayers = [];
var dirJson = decodeURI(doc.path.fsName)+"/";
var jsonName = doc.name.split(".");
jsonName.pop();
var fName = jsonName.join('_')
var dir = dirJson+fName+"/";
jsonName = jsonName.join(".")+".json";
var pics = [];
var url = '';
var bgName = "";
var bgLayer;
Array.prototype.indexOf = function ( item ) {

var index = 0, length = this.length;

for ( ; index < length; index++ ) {

if ( this[index] === item )

return index;

}

return -1;

};
var jiggleMasks = {
'jm_breasts' : {
slot : "Breasts",
points : []
},
'jm_groin' : {
slot : "Groin",
points : []
},
'jm_butt' : {
slot : "Butt",
points : []
}
};

var condMap = {
'55_stains' : {
conds : ['targetStains'],
},
'51_gloves' : {
conds : ['targetGloves']
},
'50_gloves' : {
conds : ['targetGloves']
},
'19_gloves' : {
conds : ['targetGloves']
},
'18_gloves' : {
conds : ['targetGloves']
},
'41_boots' : {
conds : ['targetBoots']
},
'40_boots' : {
conds : ['targetBoots']
},
'26_sling_heavy' : {
conds: ['targetWearsSlingBikini','targetLowerBodyHard']
},
'25_sling_heavy' : {
conds: ['targetWearsSlingBikini','targetLowerBodyHard']
},
'26_sling_med' : {
conds: ['targetWearsSlingBikini','targetLowerBodyLeather']
},
'25_sling_med' : {
conds: ['targetWearsSlingBikini','targetLowerBodyLeather']
},
'26_sling_light' : {
conds: ['targetWearsSlingBikini']
},
'25_sling_light' : {
conds: ['targetWearsSlingBikini']
},
'26_bodysuit_med' : {
conds: ['targetBodysuit', 'targetLowerBodyLeather']
},
'25_bodysuit_med' : {
conds: ['targetBodysuit', 'targetLowerBodyLeather']
},
'26_bodysuit_light' : {
conds: ['targetBodysuit']
},
'25_bodysuit_light' : {
conds: ['targetBodysuit']
},

'36_heavy_ub' : {
conds: ['targetUpperBodyHard', 'targetNoBodysuit']
},
'35_heavy_ub' : {
conds: ['targetUpperBodyHard', 'targetNoBodysuit']
},

'26_heavy_lb' : {
conds: ['targetLowerBodyHard']
},
'25_heavy_lb' : {
conds: ['targetLowerBodyHard']
},

'36_bikini_med_ub' : {
conds: ['targetUpperBodyBikini', 'targetUpperBodyLeather', 'targetNoBodysuit']
},
'35_bikini_med_ub' : {
conds: ['targetUpperBodyBikini', 'targetUpperBodyLeather', 'targetNoBodysuit']
},
'26_bikini_med_lb' : {
conds: ['targetWearsThong', 'targetLowerBodyLeather']
},
'25_bikini_med_lb' : {
conds: ['targetWearsThong', 'targetLowerBodyLeather']
},

'36_bikini_light_ub' : {
conds: ['targetUpperBodyBikini', 'targetNoBodysuit']
},
'35_bikini_light_ub' : {
conds: ['targetUpperBodyBikini', 'targetNoBodysuit']
},
'26_bikini_light_lb' : {
conds: ['targetWearsThong', 'targetNoBodysuit']
},
'25_bikini_light_lb' : {
conds: ['targetWearsThong', 'targetNoBodysuit']
},

'36_med_ub' : {
conds: ['targetUpperBodyLeather', 'targetNoBodysuit']
},
'35_med_ub' : {
conds: ['targetUpperBodyLeather', 'targetNoBodysuit']
},
'26_med_lb' : {
conds: ['targetLowerBodyLeather']
},
'25_med_lb' : {
conds: ['targetLowerBodyLeather']
},

'36_light_ub' : {
conds: ['targetWearsUpperBody', 'targetNoBodysuit']
},
'35_light_ub' : {
conds: ['targetWearsUpperBody', 'targetNoBodysuit']
},
'26_light_lb' : {
conds: ['targetWearsLowerBody']
},
'25_light_lb' : {
conds: ['targetWearsLowerBody']
},

// Collar can be either above or below armor
'3_collar' : {
conds: ['targetCollar']
},
'23_collar' : {
conds: ['targetCollar']
},
'43_collar' : {
conds: ['targetCollar']
},

'22_nipple_studs' : {
conds: ['targetCollar']
},

'15_aroused_heavy' : {
conds: ['metaVeryArousing'],
stdtag: 'ex_aroused_heavy'
},
'15_pain_heavy' : {
conds: ['metaVeryPainful'],
stdtag : 'ex_pained_heavy'
},
'10_aroused' : {
conds: ['metaArousing'],
stdtag: 'ex_aroused'
},
'10_pain' : {
conds: ['metaPainful'],
stdtag : 'ex_pained'
},
'5_orgasm' : {
conds: ['targetHasOrgasm']
},

};

function round(input){
return Math.round(input*100)/100;
}

function exec(){

preferences.rulerUnits = Units.PIXELS;

fetchLayers(doc);

// Fetch JSON if possible
var jsonFile = new File(dir+jsonName);
jsonFile.encoding = 'UTF8';
if( jsonFile.exists ){

jsonFile.open("r");
var parsed = JSON.parse(jsonFile.read());
url = parsed.url || '';
bgName = parsed.base || "";
pics = parsed.layers;
jsonFile.close();

}

var pngOpts = new PNGSaveOptions();
pngOpts.method = stringIDToTypeID("thorough");
pngOpts.compression = 1;

var missingFromMap = [];
for( var i = 0; i < allLayers.length; ++i ){

var l = allLayers[i];
l.visible = true;
if( i && allLayers[i-1].name.substring(0,1) != "#" )
allLayers[i-1].visible = false;

var baseOpacity = l.opacity;

var bounds = l.bounds;
var left = bounds[0];
var right = docW-bounds[2];
var top = bounds[1];
var bottom = docH - bounds[3];
var width = bounds[2]-bounds[0];
var height = bounds[3]-bounds[1];

var layerName = l.name;
var layerNr = parseInt(layerName);
var blendMode = 'source-over';
if( l.blendMode == BlendMode.MULTIPLY )
blendMode = 'multiply';
else if( l.blendMode == BlendMode.OVERLAY )
blendMode = 'overlay';
var opacity = baseOpacity/100;
var jiggleMask = jiggleMasks[layerName];

if( layerName.substring(0,3) === 'jp_' ){
var layer = layerName.substring(3);
var targ = jiggleMasks['jm_'+layer];
if( targ ){
// Create a jiggle point
var point = {
r : round(width/docW),
x : round((width/2+left)/docW),
y : round((height/2+top)/docH),
};
targ.points.push(point);

}
}
else if( isNaN(layerNr) && !jiggleMask )
alert("Layer "+layerName+" needs to start with the FQ art layer number. Use # if you don't want to save this layer.");
else{

var file = layerName+".png";

var folder = Folder(dir);
if( !folder.exists )
folder.create();

l.opacity = 100;

//alert("Image cropped x:"+left+" y:"+top)
var workLayer = doc.duplicate();

workLayer.crop(bounds);

var fileOut = new File(dir+file)
workLayer.saveAs(fileOut, pngOpts, true);
workLayer.close(SaveOptions.DONOTSAVECHANGES);

l.opacity = baseOpacity;
var baseData = {
x : parseInt(left),
y : parseInt(top),
};

if( jiggleMask ){

baseData.slot = layerName.substring(3);
baseData.mask = file;
baseData = makeJiggleMask(baseData);
baseData.p = jiggleMask.points;

}else{

var duration = 0;
if( layerNr < 20 && layerNr >= 10 )
duration = 3000; // Facial expressions generally.
var slots = {
s26 : 'lowerBody',
s31 : 'hands',
s36 : 'upperBody',
s41 : 'jewelleryCosmetic',
s46 : 'lowerBodyCosmetic',
s51 : 'upperBodyCosmetic',
};

var cmap = condMap[layerName], cm = [], stdtag = '';
if( cmap ){
cm = cmap.conds;
stdtag = cmap.stdtag;
}

if( !cm.length )
missingFromMap.push(layerName);

baseData.layer = layerNr;
baseData.icon = file;
baseData.duration = duration;
baseData.slot = slots['s'+layerNr] || '';
baseData.blendMode = blendMode;
baseData.opacity = opacity;
baseData.conditions = cm;
baseData.stdtag = stdtag;

baseData = makePic(baseData);

}

updatePic(baseData);

}

}
if( missingFromMap.length )
alert("The following layers are missing auto condition definitions, check your spelling etc: "+missingFromMap.join(", "));

// Save BG as nude layer
if( bgLayer ){

if( allLayers.length )
allLayers[i-1].visible = false;
bgLayer.visible = true;
var jpegOpts = new JPEGSaveOptions();
jpegOpts.quality = 9;
var fn = fName+"_n.jpg";
doc.saveAs(new File(dir+fn), jpegOpts, true);
bgName = fn;

}

var keys = [];
for( var i in condMap ){
keys.push(i);
}

pics.sort(function(a, b){

var aln = (a.icon || a.mask).split(".")[0];
var bln = (b.icon || b.mask).split(".")[0];
var aPos = keys.indexOf(aln);
var bPos = keys.indexOf(bln);
if( aPos == bPos )
return 0;
if( aPos == -1 )
return 1;
if( bPos == -1 )
return -1;
return aPos < bPos ? -1 : 1;

});

var dump = JSON.stringify({
base : bgName,
url : url,
layers : pics
}, null, 4);
jsonFile.open("w");
jsonFile.write(dump);
jsonFile.close();

preferences.rulerUnits = startRulesUnits;

}

// Accept data from makePic
function updatePic( picData ){
for( var i = 0; i < pics.length; ++i ){

var p = pics[i];
if( (p.icon && p.icon == picData.icon) || (p.mask && picData.mask === p.mask) ){

if( picData.layer !== undefined )
p.layer = picData.layer;
p.x = picData.x;
p.y = picData.y;
if( picData.blendMode !== undefined )
p.blendMode = picData.blendMode;
if( picData.opacity !== undefined )
p.opacity = picData.opacity;
if( picData.slot !== undefined )
p.slot = picData.slot;
if( picData.p )
p.p = picData.p;

return;
}

}

pics.push(picData);

}

// Fetches all viable art layers
function fetchLayers( parentLayer, ignore ){

for( var i = 0; i < parentLayer.layers.length; ++i ){

var l = parentLayer.layers[i];

var ign = ignore;
var isBg = l.name == "Background";

if( !ignore )
ign = isBg;
if( l.name.substring(0,1) == "#" )
continue;

if( isBg )
bgLayer = l;

l.visible = (l.typename == "LayerSet");

if( l.typename == "LayerSet" ){
fetchLayers(l, ign);
continue;
}

if( !ign )
allLayers.push(l);

}

}

function makeJiggleMask( data ){
if( typeof data != "object" )
data = {};
var out = {};
out.x = data.x || 0;
out.y = data.y || 0;
out.mask = data.mask;
out.slot = data.slot;
return out;

}

function makePic( data ){

if( typeof data != "object" )
data = {};

var out = {};
out.icon = data.icon;
out.conditions = data.conditions || [];
out.layer = data.layer || 0;
out.duration = parseInt(data.duration) || 0;
out.x = data.x || 0;
out.y = data.y || 0;
out.slot = data.slot || '';
out.blendMode = data.blendMode || 'source-over';
out.opacity = 1.0;
if( !isNaN(data.opacity) )
out.opacity = data.opacity;
out.conditions = data.conditions;
out.stdtag = data.stdtag;
return out;

}

function save_as_png(doc, file, copy, comp, filter, none){

try {

if (copy == undefined) copy = true;

if (comp == undefined) comp = 9;

if (none == undefined) none = true;

if (filter == undefined) filter = "PNGFilterAdaptive";

var doc0 = app.activeDocument;

app.activeDocument = doc;

var d = new ActionDescriptor();

var d1 = new ActionDescriptor();

d1.putEnumerated(stringIDToTypeID("method"), stringIDToTypeID("PNGMethod"), stringIDToTypeID("quick"));

if (none)

d1.putEnumerated(stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceNone"));

else

d1.putEnumerated(stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceType"), stringIDToTypeID("PNGInterlaceAdam7"));

d1.putEnumerated(stringIDToTypeID("PNGFilter"), stringIDToTypeID("PNGFilter"), stringIDToTypeID(filter));

d1.putInteger(stringIDToTypeID("compression"), comp);

d.putObject(stringIDToTypeID("as"), stringIDToTypeID("PNGFormat"), d1);

d.putPath(stringIDToTypeID("in"), file);

d.putBoolean(stringIDToTypeID("copy"), copy);

executeAction(stringIDToTypeID("save"), d, DialogModes.NO);

app.activeDocument = doc0;

return true;

}

catch (e) { alert(e); return false; }

}

// json2.js
// 2023-05-10
// Public Domain.
// NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.

// USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
// NOT CONTROL.

// This file creates a global JSON object containing two methods: stringify
// and parse. This file provides the ES5 JSON capability to ES3 systems.
// If a project might run on IE8 or earlier, then this file should be included.
// This file does nothing on ES5 systems.

// JSON.stringify(value, replacer, space)
// value any JavaScript value, usually an object or array.
// replacer an optional parameter that determines how object
// values are stringified for objects. It can be a
// function or an array of strings.
// space an optional parameter that specifies the indentation
// of nested structures. If it is omitted, the text will
// be packed without extra whitespace. If it is a number,
// it will specify the number of spaces to indent at each
// level. If it is a string (such as "\t" or " "),
// it contains the characters used to indent at each level.
// This method produces a JSON text from a JavaScript value.
// When an object value is found, if the object contains a toJSON
// method, its toJSON method will be called and the result will be
// stringified. A toJSON method does not serialize: it returns the
// value represented by the name/value pair that should be serialized,
// or undefined if nothing should be serialized. The toJSON method
// will be passed the key associated with the value, and this will be
// bound to the value.

// For example, this would serialize Dates as ISO strings.

// Date.prototype.toJSON = function (key) {
// function f(n) {
// // Format integers to have at least two digits.
// return (n < 10)
// ? "0" + n
// : n;
// }
// return this.getUTCFullYear() + "-" +
// f(this.getUTCMonth() + 1) + "-" +
// f(this.getUTCDate()) + "T" +
// f(this.getUTCHours()) + ":" +
// f(this.getUTCMinutes()) + ":" +
// f(this.getUTCSeconds()) + "Z";
// };

// You can provide an optional replacer method. It will be passed the
// key and value of each member, with this bound to the containing
// object. The value that is returned from your method will be
// serialized. If your method returns undefined, then the member will
// be excluded from the serialization.

// If the replacer parameter is an array of strings, then it will be
// used to select the members to be serialized. It filters the results
// such that only members with keys listed in the replacer array are
// stringified.

// Values that do not have JSON representations, such as undefined or
// functions, will not be serialized. Such values in objects will be
// dropped; in arrays they will be replaced with null. You can use
// a replacer function to replace those with JSON values.

// JSON.stringify(undefined) returns undefined.

// The optional space parameter produces a stringification of the
// value that is filled with line breaks and indentation to make it
// easier to read.

// If the space parameter is a non-empty string, then that string will
// be used for indentation. If the space parameter is a number, then
// the indentation will be that many spaces.

// Example:

// text = JSON.stringify(["e", {pluribus: "unum"}]);
// // text is '["e",{"pluribus":"unum"}]'

// text = JSON.stringify(["e", {pluribus: "unum"}], null, "\t");
// // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'

// text = JSON.stringify([new Date()], function (key, value) {
// return this[key] instanceof Date
// ? "Date(" + this[key] + ")"
// : value;
// });
// // text is '["Date(---current time---)"]'

// JSON.parse(text, reviver)
// This method parses a JSON text to produce an object or array.
// It can throw a SyntaxError exception.

// The optional reviver parameter is a function that can filter and
// transform the results. It receives each of the keys and values,
// and its return value is used instead of the original value.
// If it returns what it received, then the structure is not modified.
// If it returns undefined then the member is deleted.

// Example:

// // Parse the text. Values that look like ISO date strings will
// // be converted to Date objects.

// myData = JSON.parse(text, function (key, value) {
// var a;
// if (typeof value === "string") {
// a =
// /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
// if (a) {
// return new Date(Date.UTC(
// +a[1], +a[2] - 1, +a[3], +a[4], +a[5], +a[6]
// ));
// }
// return value;
// }
// });

// myData = JSON.parse(
// "[\"Date(09/09/2001)\"]",
// function (key, value) {
// var d;
// if (
// typeof value === "string"
// && value.slice(0, 5) === "Date("
// && value.slice(-1) === ")"
// ) {
// d = new Date(value.slice(5, -1));
// if (d) {
// return d;
// }
// }
// return value;
// }
// );

// This is a reference implementation. You are free to copy, modify, or
// redistribute.

/*jslint
eval, for, this
*/

/*property
JSON, apply, call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
lastIndex, length, parse, prototype, push, replace, slice, stringify,
test, toJSON, toString, valueOf
*/

// Create a JSON object only if one does not already exist. We create the
// methods in a closure to avoid creating global variables.

var JSON = {};

(function () {
"use strict";

var rx_one = /^[\],:{}\s]*$/;
var rx_two = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g;
var rx_three = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g;
var rx_four = /(?:^|:|,)(?:\s*\[)+/g;
var rx_escapable = /[\\"\u0000-\u001f\u007f-\u009f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g;
var rx_dangerous = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g;

function f(n) {
// Format integers to have at least two digits.
return (n < 10)
? "0" + n
: n;
}

function this_value() {
return this.valueOf();
}

if (typeof Date.prototype.toJSON !== "function") {

Date.prototype.toJSON = function () {

return isFinite(this.valueOf())
? (
this.getUTCFullYear()
+ "-"
+ f(this.getUTCMonth() + 1)
+ "-"
+ f(this.getUTCDate())
+ "T"
+ f(this.getUTCHours())
+ ":"
+ f(this.getUTCMinutes())
+ ":"
+ f(this.getUTCSeconds())
+ "Z"
)
: null;
};

Boolean.prototype.toJSON = this_value;
Number.prototype.toJSON = this_value;
String.prototype.toJSON = this_value;
}

var gap;
var indent;
var meta;
var rep;

function quote(string) {

// If the string contains no control characters, no quote characters, and no
// backslash characters, then we can safely slap some quotes around it.
// Otherwise we must also replace the offending characters with safe escape
// sequences.

rx_escapable.lastIndex = 0;
return rx_escapable.test(string)
? "\"" + string.replace(rx_escapable, function (a) {
var c = meta[a];
return typeof c === "string"
? c
: "\\u" + ("0000" + a.charCodeAt(0).toString(16)).slice(-4);
}) + "\""
: "\"" + string + "\"";
}

function str(key, holder) {

// Produce a string from holder[key].

var i; // The loop counter.
var k; // The member key.
var v; // The member value.
var length;
var mind = gap;
var partial;
var value = holder[key];

// If the value has a toJSON method, call it to obtain a replacement value.

if (
value
&& typeof value === "object"
&& typeof value.toJSON === "function"
) {
value = value.toJSON(key);
}

// If we were called with a replacer function, then call the replacer to
// obtain a replacement value.

if (typeof rep === "function") {
value = rep.call(holder, key, value);
}

// What happens next depends on the value's type.

switch (typeof value) {
case "string":
return quote(value);

case "number":

// JSON numbers must be finite. Encode non-finite numbers as null.

return (isFinite(value))
? String(value)
: "null";

case "boolean":
case "null":

// If the value is a boolean or null, convert it to a string. Note:
// typeof null does not produce "null". The case is included here in
// the remote chance that this gets fixed someday.

return String(value);

// If the type is "object", we might be dealing with an object or an array or
// null.

case "object":

// Due to a specification blunder in ECMAScript, typeof null is "object",
// so watch out for that case.

if (!value) {
return "null";
}

// Make an array to hold the partial results of stringifying this object value.

gap += indent;
partial = [];

// Is the value an array?

if (Object.prototype.toString.apply(value) === "[object Array]") {

// The value is an array. Stringify every element. Use null as a placeholder
// for non-JSON values.

length = value.length;
for (i = 0; i < length; i += 1) {
partial[i] = str(i, value) || "null";
}

// Join all of the elements together, separated with commas, and wrap them in
// brackets.

v = partial.length === 0
? "[]"
: gap
? (
"[\n"
+ gap
+ partial.join(",\n" + gap)
+ "\n"
+ mind
+ "]"
)
: "[" + partial.join(",") + "]";
gap = mind;
return v;
}

// If the replacer is an array, use it to select the members to be stringified.

if (rep && typeof rep === "object") {
length = rep.length;
for (i = 0; i < length; i += 1) {
if (typeof rep[i] === "string") {
k = rep[i];
v = str(k, value);
if (v) {
partial.push(quote(k) + (
(gap)
? ": "
: ":"
) + v);
}
}
}
} else {

// Otherwise, iterate through all of the keys in the object.

for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = str(k, value);
if (v) {
partial.push(quote(k) + (
(gap)
? ": "
: ":"
) + v);
}
}
}
}

// Join all of the member texts together, separated with commas,
// and wrap them in braces.

v = partial.length === 0
? "{}"
: gap
? "{\n" + gap + partial.join(",\n" + gap) + "\n" + mind + "}"
: "{" + partial.join(",") + "}";
gap = mind;
return v;
}
}

// If the JSON object does not yet have a stringify method, give it one.

if (typeof JSON.stringify !== "function") {
meta = { // table of character substitutions
"\b": "\\b",
"\t": "\\t",
"\n": "\\n",
"\f": "\\f",
"\r": "\\r",
"\"": "\\\"",
"\\": "\\\\"
};
JSON.stringify = function (value, replacer, space) {

// The stringify method takes a value and an optional replacer, and an optional
// space parameter, and returns a JSON text. The replacer can be a function
// that can replace values, or an array of strings that will select the keys.
// A default replacer method can be provided. Use of the space parameter can
// produce text that is more easily readable.

var i;
gap = "";
indent = "";

// If the space parameter is a number, make an indent string containing that
// many spaces.

if (typeof space === "number") {
for (i = 0; i < space; i += 1) {
indent += " ";
}

// If the space parameter is a string, it will be used as the indent string.

} else if (typeof space === "string") {
indent = space;
}

// If there is a replacer, it must be a function or an array.
// Otherwise, throw an error.

rep = replacer;
if (replacer && typeof replacer !== "function" && (
typeof replacer !== "object"
|| typeof replacer.length !== "number"
)) {
throw new Error("JSON.stringify");
}

// Make a fake root object containing our value under the key of "".
// Return the result of stringifying the value.

return str("", {"": value});
};
}

// If the JSON object does not yet have a parse method, give it one.

if (typeof JSON.parse !== "function") {
JSON.parse = function (text, reviver) {

// The parse method takes a text and an optional reviver function, and returns
// a JavaScript value if the text is a valid JSON text.

var j;

function walk(holder, key) {

// The walk method is used to recursively walk the resulting structure so
// that modifications can be made.

var k;
var v;
var value = holder[key];
if (value && typeof value === "object") {
for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = walk(value, k);
if (v !== undefined) {
value[k] = v;
} else {
delete value[k];
}
}
}
}
return reviver.call(holder, key, value);
}

// Parsing happens in four stages. In the first stage, we replace certain
// Unicode characters with escape sequences. JavaScript handles many characters
// incorrectly, either silently deleting them, or treating them as line endings.

text = String(text);
rx_dangerous.lastIndex = 0;
if (rx_dangerous.test(text)) {
text = text.replace(rx_dangerous, function (a) {
return (
"\\u"
+ ("0000" + a.charCodeAt(0).toString(16)).slice(-4)
);
});
}

// In the second stage, we run the text against regular expressions that look
// for non-JSON patterns. We are especially concerned with "()" and "new"
// because they can cause invocation, and "=" because it can cause mutation.
// But just to be safe, we want to reject all unexpected forms.

// We split the second stage into 4 regexp operations in order to work around
// crippling inefficiencies in IE's and Safari's regexp engines. First we
// replace the JSON backslash pairs with "@" (a non-JSON character). Second, we
// replace all simple value tokens with "]" characters. Third, we delete all
// open brackets that follow a colon or comma or that begin the text. Finally,
// we look to see that the remaining characters are only whitespace or "]" or
// "," or ":" or "{" or "}". If that is so, then the text is safe for eval.

if (
rx_one.test(
text
.replace(rx_two, "@")
.replace(rx_three, "]")
.replace(rx_four, "")
)
) {

// In the third stage we use the eval function to compile the text into a
// JavaScript structure. The "{" operator is subject to a syntactic ambiguity
// in JavaScript: it can begin a block or an object literal. We wrap the text
// in parens to eliminate the ambiguity.

j = eval("(" + text + ")");

// In the optional fourth stage, we recursively walk the new structure, passing
// each name/value pair to a reviver function for possible transformation.

return (typeof reviver === "function")
? walk({"": j}, "")
: j;
}

// If the text is not JSON parseable, then a SyntaxError is thrown.

throw new SyntaxError("JSON.parse");
};
}
}());

exec();

</pre>

Creating Advanced Art Layers

2026-06-05T11:52:49Z

JasX:

[[File:Inpaint Tits.png|thumb|Inpainting nipple-studs/clothes: Only inpaint the clothes to make it easier later.]]
Advanced art layers can be used to give a character multiple/colorable outfits. Note: This tutorial was written for photoshop. You can use gimp, but you'll have to either rewrite my script, or add the art in game manually.

== Creating the Art ==

The first thing you'll want to do is to create the actual art. If you're creating AI art, you'll want to draw some clothes over the character and only generate the parts you've drawn. Otherwise you may end up with clashing layers. If you know how to draw yourself, it's going to be significantly easier, since you can just draw the clothes on separate layers directly.

Since I can't draw, this tutorial will be from the perspective of using AI tools.

You can add as many or as few layers as you want, but these are the layers that are used by default and the photoshop script is setup to auto handle these layers:
{| class="wikitable"
|+
!Description
!Base Layer
!UB Layer
!File name for PS script
|-
|Gloves
|50 or 18
|N/A
|gloves.png
|-
|Boots
|40
|N/A
|boots.png
|-
|Sling Bikini Heavy Armor
|25
|N/A
|sling_heavy.png
|-
|Sling Bikini Medium Armor
|25
|N/A
|sling_med.png
|-
|Sling Bikini Light Armor
|25
|N/A
|sling_light.png
|-
|Bodysuit medium armor
|25
|N/A
|bodysuit_med.png
|-
|Bodysuit light armor
|25
|N/A
|bodysuit_light.png
|-
|Heavy 2-part armor
|25
|35
|heavy.png
|-
|Medium 2-part armor
|25
|35
|med.png
|-
|Light 2-part armor
|25
|35
|light.png
|-
|Collar
|23, 3 or 43
|N/A
|collar.png
|-
|Nipple studs (optional)
|22
|N/A
|nipple_studs.png
|-
|Aroused heavy state
|15
|N/A
|aroused_heavy.png
|-
|Pain heavy state
|15
|N/A
|pain_heavy.png
|-
|Aroused state
|10
|N/A
|aroused.png
|-
|Pain state
|10
|N/A
|pain.png
|-
|Orgasm state
|5
|N/A
|
|}
== Preparing the File ==

We'll need to create a photoshop file. In this tutorial I'll be creating a jaguar character. I'll drag the naked layer into photoshop and save it as a new file called "jaguar.psd"

The layer order, names, and settings will be used by the exporter to generate a file you can use in the FetishQuest devtools to make it easier to setup your character art. We'll start with the lower nr layers and go up.

FQ supports the following layers (tho see public/classes/PlayerIconState.js in the source for something more up to date:

* FaceResting : 5 - Resting face reaction. I use it for orgasm faces.
* FaceMild : 10 - Facial expression for mild reactions. I use it for pain/arousal.
* FaceHeavy : 15 - Facial expression for heavy reactions, I use it for heavy pain/arousal such as critical hits.
* CosmeticLower : 20 - Allows you to put cosmetics under armor. Nipple clamps and collars are good examples. I won't be using this in the tutorial.
* ArmorLower : 25 - Lower body armor
* Handheld : 30 - Handheld items. Not used in this tutorial because there's way too many items.
* ArmorUpper : 35 - Upper body armor.
* ArmorCosmeticJewellery : 40 - Jewelry layer. Not used in this tutorial.
* ArmorCosmeticLower : 45 - Lower body cosmetic. Not used in this tutorial.
* ArmorCosmeticUpper : 50 - Upper body cosmetic. Not used in this tutorial.
* Stains : 55 - Stain/slime layers etc. Not used in this tutorial.

When the image is drawn, layers are drawn from lowest to highest, drawing active higher value layers on top of lower value layers. Only one image per layer is ever drawn. The higher the layer is in the FQ editor/photoshop file, the higher priority it gains. There's an exception for temporary layers, such as FaceMild and FaceHeavy, which are triggered from events and the last triggered one gets priority.

== Preparing the Orgasm Face ==
[[File:Layers1.png|thumb|The layer order and name matters. 5_orgasm means draw on layer 5 (FaceResting) and label the layer "orgasm".]]
[[File:Difference.png|thumb|Use difference and magic wand to select and delete all pixels that are the same as the background.]]
''Note: In all these examples, if you draw your own art you can skip the erasing parts of these steps, and go directly to naming your layers. Just keep in mind that you can only have one photoshop layer per art layer. So if for instance your orgasm face is drawn on multiple layers, you'll have to merge those. But don't merge them to the background!''

# Copy your orgasm face art over the background in the jaguar.psd file and rename the layer to 5_orgasm. '''The number followed by _ is required''' and tells the script what FQ art layer you want the photoshop layer to go on. Layer 5 is the FaceResting layer, which we'll use for orgasm. To make things easier, I'll create a Faces folder and put it in there. But you don't have to.
# If you want to prevent a layer from being exported, start the name with # and it will be invisible in the exporter script.
# Next we'll need to erase everything but the face (changed pixels). The easiest way I've found to do this is to change the blend mode of 5_orgasm to "difference". This makes pixels that are the same as the background pure black. While in this mode, use the magic wand with a tolerance of 1 and Sample All Layers checked on any of the black parts of the picture. Then delete the black pixels. Set the blend mode back to normal.
# You may want to do some touch-ups with the eraser tool.

== Preparing the Reaction Faces ==
Reactions are layers that should show up for a specified amount of time. They're all bound to text events, meaning you probably want to use the meta tags conditions. Reaction layers are also special in that you can bind multiple ones to the same layer, and only the most recently triggered one will be made visible. This makes them good for facial reactions.

''When using photoshop, you can use the [[fqAutoLayers]] script to automate removing the unchanged pixels.''

# Copy your aroused face art into the photoshop file.
# Name the layer 10_aroused to use layer 10 (FaceMild). And put it in the Faces folder, on top of 5_orgasm.
# Do the same difference trick. Remember to hide any layers except 10_aroused and the background.
# If you plan to add a collar, you probably want to use a soft eraser brush to remove everything below the chin.
# Do the same with the pain expression, but name it 10_pain
# Do the same thing with your heavy aroused/pained layers, but use layer 15 by naming them 15_aroused_heavy and 15_pain_heavy
# If you did it right, you should now have your layers setup as such:[[File:Facelayers.png|none|thumb|Example of facial reaction layers in photoshop. Ignore the #Background copy layer. I'm only using it to help erase needless pixels.]]

== Preparing Clothing Layers ==
[[File:Clothes Difference.png|thumb|Using the difference trick to remove pixels that are the same on the clothing layer and background.]]
[[File:Panty Selection.png|thumb|Selecting only the colorable part of the outfit.]]
[[File:MaskingLayer Panties.png|thumb|Masking layer set to multiply and 68% opacity]]
[[File:Masked outfit.png|thumb|Outfit with 70% opacity multiply layers on top.]]
Remember that the order of photoshop layers matter. Each layer number (this is the number the layer name starts with) is unique in FQ, and only the first valid layer nr matching a set of conditions will be drawn. Basically, put the most unique outfits on top, and use the lower ones as a fallback.

# The first outfit we'll prepare is the fallback outfit: An outfit that you can fall back on if none of the layers above it are valid. You can pick what you want, but for this I'm going to pick the cloth outfit (shirt and panties).
# Create a new group and name it something descriptive such as "cloth"
# Paste the cloth art into the file and put it in said group.
# Use the difference trick again to remove unchanged pixels. I also recommend using a soft eraser to make the visible parts as small as possible.
# Next select only the top part of the outfit, using a selection tool of your choosing.
# Hit ctrl+shift+J to split it into a new layer.
# Name the layer containing the top half of the armor something like 35_cloth_ub and the lower half layer 25_cloth_lb
# If you did it correct, you should have something like this:[[File:Cloth Layers.png|none|thumb|Ignore the #Background copy layer.]]
# To allow players to recolor the layer, we'll need to create a mask layer. Start by selecting the 25_cloth_lb layer.
# This is the time consuming part. Use a selection tool of your choosing and select only parts of the panties you want to recolor.
# Hit ctrl+j to copy it to a new layer. Name it 26_cloth_lb
# Hit ctrl+u to enter hue/saturation. Drag the lightness all the way up to make it pure white, and accept.
# Hit ctrl+u again and check colorize. Drag saturation all the way to max and color to -50.
# In the layer browser, change the blending mode to multiply or overlay, depending on what you think looks better.
# Alter the opacity until it looks good. Keep in mind this is what it's going to look like if the player dyes their armor pure red.
# Set your brush to pure red and use a small brush / eraser to patch up any sections you missed.
# You can use hue/saturation on this layer to preview what it's going to look like in different brightness and colors.
# Repeat for the top part of the outfit.
# Your layers should now look like this:[[File:Mask Layers.png|none|thumb]]
# Adding a bodysuit is basically the same, except you'll only be using layer 25 and layer 26, since it only affects one layer.
# From this point on it's just rinse and repeat for your art layers. But remember the order of your photoshop layers matter. The following is how I ended up laying it out. I went with the strategy of "most specific outfit" first, meaning bodysuits on top:[[File:Finished Layers.png|none|thumb|Advanced armor setup with faces and armor types.]]

== Using the script ==
[[File:Compiled Output.png|thumb|5 faces and 9 outfits sliced using the FQCrop batch script.]]
Time to bake the different layers! If you wanna do this by hand, you'd crop, make a note of the top left corner, and manually add the layers in the FQ layer editor. But if you have photoshop you can run a script to bake all the layers into a folder and generate a JSON file you can use for uploading.
You can grab the script here: [[FQCrop Batch]]

If everything goes according to plan, you'll see a bunch of images pop up as it crops them for you. A new folder with the same name as the PSD file will be put in the PSD directory. This includes all the sliced images. The background image will also be saved in said folder as a PNG with _n appended to it. This is the nude layer.

The script also outputs (in the same folder as the PSD file) a JSON document named the same as the PSD file. This is pre-filled with some basic values. But we'll need to add conditions to it.

Note: If you make changes in the photoshop file and re-run the script, it'll load and update the JSON file, maintaining your conditions. But if you change the name (including the number) of a photoshop layer, you'll have to modify it in the JSON file to match first. This is because the script will NEVER DELETE anything from the JSON file, only update and add. So make sure you have the order of photoshop layers correct before you start adding conditions to the JSON file.

Also note: The coordinates in the JSON file are based off of the largest image in the set, which is usually the background.

== Modifying the JSON file ==
My preferred way to map conditions is to modify the JSON file. But you can also skip editing the JSON file and import it into the FQ mod tool. Then use the mod tool to setup the conditions. If you do, I recommend you export it back to JSON in case you want to rerun the script to update images and positions.
The JSON file just contains an array objects for each layer. Each object may look something like:
{
"icon": "25_sling_heavy.png",
"conditions": [

],
"layer": 25,
"duration": 0,
"x": 363,
"y": 133,
"slot": "",
"blendMode": "source-over",
"opacity": 1
}

* Icon is the image file name.
* Conditions is an array of FQ conditions that must be matched (see below). If you follow the naming convention in the [[JaguarArtFile|jaguar demo file]], it will try to auto fill conditions.
* Layer is the FQ art layer.
* Duration is used in reaction faces, and specifies how long it should show in milliseconds.
* X/Y are pixel coordinates relative to the largest image (should be the background).
* Slot is the armor slot for the mask layer. It specifies what armor slot it should grab the color from.
* Blend mode is the blend mode. source-over is the same as normal in photoshop.
* Opacity is the opacity between 0-1
On top of the file is a URL field, you can set that to the base path where you're hosting your files.

The script will setup most of these for you, except the conditions, which we'll have to add manually.

# Open the JSON file in one window and the FQ mod tools in another. Load up your mod and go to the conditions listing.
# Search for conditions here and add them to the condition arrays. Example for heavy sling bikini with sling bikini and lowerBodyHard (hard armor) conditions. Note that layer 26 is the masking layer for layer 25. Both of them need the same conditions to work.

{
"icon": "26_sling_heavy.png",
"conditions": [
"targetWearsSlingBikini", "targetLowerBodyHard"
],
"layer": 26,
"duration": 0,
"x": 383,
"y": 159,
"slot": "lowerBody",
"blendMode": "multiply",
"opacity": 0.70196078431373
},
{
"icon": "25_sling_heavy.png",
"conditions": [
"targetWearsSlingBikini", "targetLowerBodyHard"
],
"layer": 25,
"duration": 0,
"x": 363,
"y": 133,
"slot": "",
"blendMode": "source-over",
"opacity": 1
},
{| class="wikitable"
|+Table of the layer order and conditions I used for the jaguar (clothing layers only). Remember that these conditions have to be applied to both cloth and mask layers for each outfit.
!Outfit
!Upper Body (If any)
!Lower Body
!Notes
|-
|Sling Heavy
|
|"targetWearsSlingBikini", "targetLowerBodyHard"
|Sling bikinis are also tagged as bodysuits. So they need to go above bodysuits. You can think of the bodysuit tag as any one-piece.
|-
|Sling Leather
|
|"targetWearsSlingBikini", "targetLowerBodyLeather"
|
|-
|Sling Cloth
|
|"targetWearsSlingBikini"
|Since the other two sling bikinis are above, they will get priority. So we use this as a catchall for sling that don't match above conditions.
|-
|Bodysuit Leather
|
|"targetBodysuit", "targetLowerBodyLeather"
|
|-
|Bodysuit Cloth
|
|"targetBodysuit"
|Same thing with this, if the body suit isn't leather and we're wearing a bodysuit. We fall back to this one.
|-
|Heavy Armor
|"targetUpperBodyHard", "targetNoBodysuit"
|"targetLowerBodyHard"
|This is the last heavy armor, so we use this as a fallback for hard. Bodysuits only use the bottom layer, so we need to add the targetNoBodysuit condition to prevent upper body from overriding bodysuits.
|-
|Bikini Leather
|"targetUpperBodyBikini", "targetUpperBodyLeather", "targetNoBodysuit"
|"targetWearsThong", "targetLowerBodyLeather"
|
|-
|Bikini Cloth
|"targetUpperBodyBikini", "targetNoBodysuit"
|"targetWearsThong"
|Last bikini check, so we fallback for all materials other than leather. Last thong also.
|-
|Cloth
|"targetWearsUpperBody", "targetNoBodysuit"
|"targetWearsLowerBody"
|Last call for clothes. Only check if they're wearing anything on the relevant slots (and upper body isn't bodysuit since we have a fallback for that above). This is used as the final fallback if nothing above matches.
|-
|Orgasm
|"targetHasOrgasm"
|
|Technically not clothes. But it's a passive art layer just like the clothing. It will be visible when the player has the orgasm wrapper.
|}

Finally we need to add conditions to the facial expressions. These are ACTIVE art layers and conditions are checked against texts whenever the player is a target of one. You can use sender/target conditions where sender is who caused the text and target is ALWAYS the player the art is attached to. This is pretty straight forward since you can use the existing meta tag conditions
{| class="wikitable"
|+
!Layer
!Conditions
|-
|aroused_heavy
|"metaVeryArousing"
|-
|pain_heavy
|"metaVeryPainful"
|-
|aroused
|"metaArousing"
|-
|pain
|"metaPainful"
|}
You can find the full JSON file I used for the jaguar [[JaguarArtFile|here]].

You should now have a JSON file all setup and ready to go! Let's import it into the FQ editor!

== Importing into the FQ editor ==
[[File:Player Layers Example.png|thumb|Example of the player editor after importing a JSON file of advanced art layers.]]
[[File:New Game Jaguar.png|thumb|Jaguar in the new game menu.]]
[[File:Messed up art layer.png|thumb|Forgot to add the "targetNoBodysuit" to cloth_ub. After fixing it in the player editor, I refresh my game and use game.players[0].replaceIconsByPlayer('pc_jaguar')]]

# First off, create a player in the editor. Click the question mark on the player window for help with filling out the fields. But if you're using advanced art layers, you can skip filling out the art fields for now.
# Next you need to upload the sliced images you generated. If you have your own webserver, you can just upload them there and make a note of the path. If you upload them to an image service they'll probably get renamed. In that case you'll need to edit each of the created layers in the FQ mod tools. This is a bit tedious, but needs to be done. ''Note: You don't need to specify the full URL anymore! Say I upload 5_orgasm to "<nowiki>https://i.ibb.co/fx8FNvG/5-orgasm.png</nowiki>". I then put <nowiki>https://i.ibb.co/</nowiki> into the "image base path" in the player editor. ALL image URLs used in the player should no longer the first part of the URL. So if I have said base path, then the icon file would just be "fx8FNvG/5-orgasm.png" instead of the full URL.''
# Put the file name of the _n file in the image_nude field. In my case "jaguar_n.png". Unless you follow the note above, you'll have to paste the full URL.
# Click the import JSON button and select the JSON file you generated. It then auto populates the layers. If you uploaded the files to an image service, you can click the layer items and edit the URLs. You can also export your JSON file from here, should you break something while testing. Note: If you're re-importing the JSON file you can check "Replace ALL" and it will delete all the existing layers before adding from the JSON file.
# If you're not happy with the order of the layers, you can reorder them from the player editor.
# Finally go to the Gallery listing and create a new entry.
# You can change the tags here to select what outfit the character should be wearing in the new game listing.

== Modifying ==

* Large changes such as modifying the layer order or layer names in photoshop will require you to delete the JSON file and restart from the exporting step.
* Minor changes such as erasing or recoloring a layer without renaming it can be handled by simply exporting it again. But note that you will have to rename the files again in the editor if you used a service that renamed your uploaded files, which may be tedious.
* When you start playing, the art layers are snapshotted and won't update automatically when you refresh the game. But there's a function to copy your layers from a library player. If your player is the first player in the game (as is usual when you start a new game), you can open the console (chrome: ctrl+shift+j) and run: game.players[0].replaceIconsByPlayer('pc_jaguar') - It'll copy the art layers from a player by label. This is especially handy when changing things around in the player editor.

[[Category:Modding]]

Wrapper (Asset)

2026-05-30T21:50:51Z

JasX:

A wrapper is a collection of effects to run immediately, ticking, on events, or passively. Wrappers with no duration are called instant effects. Wrappers with an infinite duration are called passives. And wrappers with a limited duration are called buffs or debuffs depending on what they do.
{| class="wikitable"
|+
!Field
!Type
!Default
!Description
|-
|Label
|String
|
|A unique label for your wrapper. '''Do not change after finishing creating your wrapper!'''
|-
|Editor Description
|String
|
|Adds a short description of your wrapper to help you locate it when searching. This field is only used in the editor, and not shown in game.
|-
|Name
|String
|
|Name of your wrapper. Doesn't have to be unique. Only needed in buffs/debuffs.
|-
|Icon
|[[Icon]]
|
|Icon of your wrapper. Only needed in buffs/debuffs.
|-
|Target
|String
|
|Target of your wrapper. Auto, Caster and AoE are the most commonly used one.
|-
|Duration
|Int
|0
|How long the effect should last. Using -1 on a wrapper applied in combat will last until combat ends.
|-
|Stacks
|Int
|1
|Amount of stacks to add. Leave at 1 for instant effects.
|-
|Max Stacks
|Int
|1
|Max stacks a player can have. Leave at 1 for instant effects.
|-
|Rarity
|String
|COMMON
|Only used for wrappers attached to armor. Used to set the color of the tooltip.
|-
|Unique
|Boolean
|False
|When unique, players can only have one wrapper of this type, regardless of caster. Otherwise you may have one instance of each wrapper per caster.
|-
|Hidden
|Boolean
|False
|Don't show the icon on the player.
|-
|Trigger Immediate
|Boolean
|False
|Doesn't affect instant effects. When checked, trigger all valid effects immediately when the wrapper is applied, otherwise it triggers the first time on their turn.
|-
|Tick on turn start
|Boolean
|True
|Triggers effects when the player's turn starts.
|-
|Stack time
|Boolean
|False
|When true, duration is added to any existing wrappers, otherwise duration resets to what the duration was set to in the incoming wrapper.
|-
|Tick on team turn end
|Boolean
|False
|Triggers effects when the player's team members have all ended their turns.
|-
|Tick on personal turn end
|Boolean
|False
|Triggers effects when the player hits the end turn button (or similar), regardless of if their team members have ended their turn or not.
|-
|Global
|Boolean
|False
|When checked, all players will receive this wrapper as a passive when they're placed in world. Use sparingly!
|-
|Use game timer
|Boolean
|False
|By default, duration is in turns. If you check use game timer, the duration becomes in-game seconds. Mainly used by buffs and debuffs related to items and random events, and talents. When linked to a talent, use game timer is automatically enforced since it puts the icon at the bottom of your portrait.
|-
|Description
|String
|
|Describe the wrapper. You can use special vars here such as modifying a value by damage taken/done etc. See [[Action (Asset)|Action]] for a list of valid variables. In addition to the Action variables, there's a few special ones for wrappers.
|-
|Tags
|[[Tag]]
|
|Tags applied to the target. Use wr_ tags.
|-
|Effects
|[[Effect (Asset)|Effect]]
|interrupt
|Effects to trigger as long as their conditions match.
|-
|Add Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required to apply this to a target. If you're using a multi-target target, then each target will be checked before applying it to them individually.
|-
|Stay Conditions
|[[Condition (Asset)|Condition]]
|
|Conditions required for this wrapper to stay on its target.
|}

== Description vars ==
{| class="wikitable"
|+
!Var
!Description
|-
|%knockdown
|Can be used if the wrapper has a knockdown effect. Returns stomach or back.
|-
|%caster / %S
|Colored name of caster (sender).
|-
|%target / %T
|Colored name of target.
|}

== Description condition lines ==
A line may start with |AC:<condition>,<condition>...|. If conditions between |AC: and the closing pipe are not met, the whole line is removed. This takes place on wrapper ADD and is never checked after that. Use sparingly. Currently it's only used for overWhelmingOrgasm because the label is hardcoded.

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