Attribute Reference

Justin Jacobs edited this page Aug 31, 2018 · 113 revisions

Attribute description

Attribute descriptions are in the following format: section.attributename, valuetype, short attribute description

Valuetype syntax

[val1, ...], Multiple values between a set of square brackets denotes possible types/values for a single field.

"...", Anything between double quotes is a string literal. This is mostly used in conjunction with the above square brackets syntax.

list(...), Lists are a series of values that can repeat on a single line, separated by commas/semicolons. Example of list(int, bool): "1,false;2,true"

repeatable(...), Repeatable keys can be used for multiple lines. An example of this would be an item with multiple "bonus" lines.

List of available valuetypes

bool, a string value of true or false

int, a signed integer value

string, a text string value

float, a floating point number

item_id, specifies an integer item identifer (greater than 0)

power_id, specifies an integer power identifer (greater than 0)

icon_id, specifies an integer icon identifer (greater than or equal to 0)

point, defined as: int, int : X, Y

rectangle, defined as: int, int, int, int : X, Y, Width, Height

filename, a string path to a file relative to the base of the mod directory (e.g. "animations/hero.txt")

color, defined as: int, int, int : Red, Green, Blue

predefined_string, same as a string, but uses a value defined elsewhere

alignment, defined as: ["topleft", "top", "topright", "left", "center", "right", "bottomleft", "bottom", "bottomright"]

direction, defined as: ["N", "NE", "E", "SE", "S", "SW", "W", "NW", int]. If defined as an integer, the value must be between 0-7 inclusive.

duration, durations can be specified in seconds and milliseconds with integer suffix s, ms (eg. 20s, 20000ms)

label, defined as: "hidden" or int, int, ["left", "right", "center"], ["top", "center", "bottom"], string : X, Y, Justify, Vertical Align, Font style. The font style can be any style defined in engine/font_settings.txt.

loot, defined as: filename or ["currency", item_id], ["fixed", int], int, int : Item, Drop chance, Min quantity, Max quantity. There is a limitation when defining as part of a list(...): filenames can only be used in the first list element.

version, defined as: a string of three numbers, separated by dots (e.g. "1.2.03")

raw, This is plain text, including line breaks. It is used only for map layer data.


AnimationSet

Description of animations in animations/

image | filename | Filename of sprite-sheet image.

render_size | int, int : Width, Height | Width and height of animation.

render_offset | int, int : X offset, Y offset | Render x/y offset.

blend_mode | ["normal", "add"] | The type of blending used when rendering this animation.

alpha_mod | int | Changes the default alpha of this animation. 255 is fully opaque.

color_mod | color | Changes the default color mod of this animation. "255,255,255" is no color mod.

animation.position | int | Number of frames to the right to use as the first frame. Unpacked animations only.

animation.frames | int | The total number of frames

animation.duration | duration | The duration of the entire animation in 'ms' or 's'.

animation.type | ["play_once", "back_forth", "looped"] | How to loop (or not loop) this animation.

animation.active_frame | [list(int), "all"] | A list of frames marked as "active". Also, "all" can be used to mark all frames as active.

animation.frame | int, int, int, int, int, int, int, int : Index, Direction, X, Y, Width, Height, X offset, Y offset | A single frame of a compressed animation.


Avatar: Step sounds

Description of items/step_sounds.txt

id | string | An identifier name for a set of step sounds.

step | filename | Filename of a step sound effect.


Avatar: Hero layers

Description of engine/hero_layers.txt

layer | direction, list(string) : Direction, Layer name(s) | Defines the hero avatar sprite layer


CombatText

Description of engine/combat_text.txt

duration | duration | Duration of the combat text in 'ms' or 's'.

speed | int | Motion speed of the combat text.

offset | int | The vertical offset for the combat text's starting position.


CursorManager

Description of engine/mouse_cursor.txt

normal | filename | Filename of an image for the normal cursor.

interact | filename | Filename of an image for the object interaction cursor.

talk | filename | Filename of an image for the NPC interaction cursor.

attack | filename | Filename of an image for the cursor when attacking enemies.


EnemyGroupManager

Description of enemies in enemies/

level | int | Level of the enemy

rarity | ["common", "uncommon", "rare"] | Enemy rarity

categories | list(predefined_string) | Comma separated list of enemy categories


EngineSettings: Misc

Description of engine/misc.txt

save_hpmp | bool | When saving the game, keep the hero's current HP and MP.

corpse_timeout | duration | Duration that a corpse can exist on the map in 'ms' or 's'.

sell_without_vendor | bool | Allows selling items when not at a vendor via CTRL-Click.

aim_assist | int | The pixel offset for powers that use aim_assist.

window_title | string | Sets the text in the window's titlebar.

save_prefix | string | A string that's prepended to save filenames to prevent conflicts between mods.

sound_falloff | int | The maximum radius in tiles that any single sound is audible.

party_exp_percentage | int | The percentage of XP given to allies.

enable_ally_collision | bool | Allows allies to block the player's path.

enable_ally_collision_ai | bool | Allows allies to block the path of other AI creatures.

currency_id | item_id | An item id that will be used as currency.

interact_range | float | Distance where the player can interact with objects and NPCs.

menus_pause | bool | Opening any menu will pause the game.

save_onload | bool | Save the game upon changing maps.

save_onexit | bool | Save the game upon quitting to the title screen or desktop.

camera_speed | float | Modifies how fast the camera moves to recenter on the player. Larger values mean a slower camera. Default value is 10.

save_buyback | bool | Saves the vendor buyback stock whenever the game is saved.

keep_buyback_on_map_change | bool | If true, NPC buyback stocks will persist when the map changes. If false, save_buyback is disabled.

sfx_unable_to_cast | filename | Sound to play when the player lacks the MP to cast a power.


EngineSettings: Resolution

Description of engine/resolutions.txt

menu_frame_width | int | Width of frame for New Game, Configuration, etc. menus.

menu_frame_height | int | Height of frame for New Game, Configuration, etc. menus.

icon_size | int | Size of icons.

required_width | int | Minimum window/screen resolution width.

required_height | int | Minimum window/screen resolution height.

virtual_height | list(int) | A list of heights (in pixels) that the game can use for its actual rendering area. The virtual height chosen is based on the current window height. The width will be resized to match the window's aspect ratio, and everything will be scaled up to fill the window.

virtual_dpi | float | A target diagonal screen DPI used to determine how much to scale the internal render resolution.

ignore_texture_filter | bool | If true, this ignores the "Texture Filtering" video setting and uses only nearest-neighbor scaling. This is good for games that use pixel art assets.


EngineSettings: Gameplay

Description of engine/gameplay.txt

enable_playgame | bool | Enables the "Play Game" button on the main menu.


EngineSettings: Combat

Description of engine/combat.txt

absorb_percent | int, int : Minimum, Maximum | Limits the percentage of damage that can be absorbed.

resist_percent | int, int : Minimum, Maximum | Limits the percentage of damage that can be resisted.

block_percent | int, int : Minimum, Maximum | Limits the percentage of damage that can be blocked.

avoidance_percent | int, int : Minimum, Maximum | Limits the percentage chance that damage will be avoided.

miss_damage_percent | int, int : Minimum, Maximum | The percentage of damage dealt when a miss occurs.

crit_damage_percent | int, int : Minimum, Maximum | The percentage of damage dealt when a critical hit occurs.

overhit_damage_percent | int, int : Minimum, Maximum | The percentage of damage dealt when an overhit occurs.


EngineSettings: Elements

Description of engine/elements.txt

element.id | string | An identifier for this element.

element.name | string | The displayed name of this element.


EngineSettings: Equip flags

Description of engine/equip_flags.txt

flag.id | string | An identifier for this equip flag.

flag.name | string | The displayed name of this equip flag.


EngineSettings: Primary Stats

Description of engine/primary_stats.txt

stat.id | string | An identifier for this primary stat.

stat.name | string | The displayed name of this primary stat.


EngineSettings: Classes

Description of engine/classes.txt

name | string | The displayed name of this class.

description | string | A description of this class.

currency | int | The amount of currency this class will start with.

equipment | list(item_id) | A list of items that are equipped when starting with this class.

carried | list(item_id) | A list of items that are placed in the normal inventorty when starting with this class.

primary | predefined_string, int : Primary stat name, Default value | Class starts with this value for the specified stat.

actionbar | list(power_id) | A list of powers to place in the action bar for the class.

powers | list(power_id) | A list of powers that are unlocked when starting this class.

campaign | list(string) | A list of campaign statuses that are set when starting this class.

power_tree | string | Power tree that will be loaded by MenuPowers

hero_options | list(int) | A list of indicies of the hero options this class can use.

default_power_tab | int | Index of the tab to switch to when opening the Powers menu


EngineSettings: Damage Types

Description of engine/damage_types.txt

damage_type.id | string | The identifier used for Item damage_type and Power base_damage.

damage_type.name | string | The displayed name for the value of this damage type.

damage_type.name_min | string | The displayed name for the minimum value of this damage type.

damage_type.name_max | string | The displayed name for the maximum value of this damage type.

damage_type.description | string | The description that will be displayed in the Character menu tooltips.

damage_type.min | string | The identifier used as a Stat type and an Effect type, for the minimum damage of this type.

damage_type.max | string | The identifier used as a Stat type and an Effect type, for the maximum damage of this type.


EngineSettings: Death penalty

Description of engine/death_penalty.txt

enable | bool | Enable the death penalty.

permadeath | bool | Force permadeath for all new saves.

currency | int | Remove this percentage of currency.

xp_total | int | Remove this percentage of total XP.

xp_current_level | int | Remove this percentage of the XP gained since the last level.

random_item | bool | Removes a random item from the player's inventory.


EngineSettings: Tooltips

Description of engine/tooltips.txt

tooltip_offset | int | Offset in pixels from the origin point (usually mouse cursor).

tooltip_width | int | Maximum width of tooltip in pixels.

tooltip_margin | int | Padding between the text and the tooltip borders.

npc_tooltip_margin | int | Vertical offset for NPC labels.

tooltip_background_border | int | The pixel size of the border in "images/menus/tooltips.png".


EngineSettings: Loot

Description of engine/loot.txt

tooltip_margin | int | Vertical offset of the loot tooltip from the loot itself.

autopickup_currency | bool | Enable autopickup for currency

autopickup_range | float | Minimum distance the player must be from loot to trigger autopickup.

currency_name | string | Define the name of currency in game

vendor_ratio | int | Percentage of item buying price to use as selling price. Also used as the buyback price until the player leaves the map.

vendor_ratio_buyback | int | Percentage of item buying price to use as the buying price for previously sold items.

sfx_loot | filename | Filename of a sound effect to play for dropping loot.

drop_max | int | The maximum number of random item stacks that can drop at once

drop_radius | int | The distance (in tiles) away from the origin that loot can drop


EngineSettings: Tileset config

Description of engine/tileset_config.txt

tile_size | int, int : Width, Height | The width and height of a tile.

orientation | ["isometric", "orthogonal"] | The perspective of tiles; isometric or orthogonal.


EngineSettings: Widgets

Description of engine/widget_settings.txt

misc.selection_rect_color | color, int : Color, Alpha | Color of the selection rectangle when navigating widgets without a mouse.

tab.padding | int, int : Left/right padding, Top padding | The pixel padding around tabs. Controls how the left and right edges are drawn.

slot.quantity_label | label | Setting for the slot quantity text.

slot.quantity_bg_color | color, int : Color, Alpha | If a slot has a quantity, a rectangle filled with this color will be placed beneath the text.


EngineSettings: XP table

Description of engine/xp_table.txt

level | int, int : Level, XP | The amount of XP required for this level.


EventManager

Description of events in maps/ and npcs/

event.type | string | (IGNORED BY ENGINE) The "type" field, as used by Tiled and other mapping tools.

event.activate | ["on_trigger", "on_load", "on_leave", "on_mapexit", "on_clear", "static"] | Set the state in which the event will be activated (map events only).

event.location | rectangle | Defines the location area for the event.

event.hotspot | ["location", rectangle] | Event uses location as hotspot or defined by rect.

event.cooldown | duration | Duration for event cooldown in 'ms' or 's'.

event.delay | duration | Event will execute after a specified duration.

event.reachable_from | rectangle | If the hero is inside this rectangle, they can activate the event.

event.tooltip | string | Tooltip for event

event.power_path | ["hero", point] | Event power path

event.power_damage | int, int : Min, Max | Range of power damage

event.intermap | filename, int, int : Map file, X, Y | Jump to specific map at location specified.

event.intermap_random | filename | Pick a random map from a map list file and teleport to it.

event.intramap | int, int : X, Y | Jump to specific position within current map.

event.mapmod | list(predefined_string, int, int, int) : Layer, X, Y, Tile ID | Modify map tiles

event.soundfx | filename, int, int, bool : Sound file, X, Y, loop | Filename of a sound to play. Optionally, it can be played at a specific location and/or looped.

event.loot | list(loot) | Add loot to the event.

event.loot_count | int, int : Min, Max | Sets the minimum (and optionally, the maximum) amount of loot this event can drop. Overrides the global drop_max setting.

event.msg | string | Adds a message to be displayed for the event.

event.shakycam | duration | Makes the camera shake for this duration in 'ms' or 's'.

event.requires_status | list(string) | Event requires list of statuses

event.requires_not_status | list(string) | Event requires not list of statuses

event.requires_level | int | Event requires hero level

event.requires_not_level | int | Event requires not hero level

event.requires_currency | int | Event requires atleast this much currency

event.requires_not_currency | int | Event requires no more than this much currency

event.requires_item | list(item_id) | Event requires specific item (not equipped)

event.requires_not_item | list(item_id) | Event requires not having a specific item (not equipped)

event.requires_class | predefined_string | Event requires this base class

event.requires_not_class | predefined_string | Event requires not this base class

event.set_status | list(string) | Sets specified statuses

event.unset_status | list(string) | Unsets specified statuses

event.remove_currency | int | Removes specified amount of currency from hero inventory

event.remove_item | list(item_id) | Removes specified item from hero inventory

event.reward_xp | int | Reward hero with specified amount of experience points.

event.reward_currency | int | Reward hero with specified amount of currency.

event.reward_item | item_id, int : Item, Quantity | Reward hero with y number of item x.

event.reward_loot | list(loot) | Reward hero with random loot.

event.reward_loot_count | int, int : Min, Max | Sets the minimum (and optionally, the maximum) amount of loot that reward_loot can give the hero. Defaults to 1.

event.restore | ["hp", "mp", "hpmp", "status", "all"] | Restore the hero's HP, MP, and/or status.

event.power | power_id | Specify power coupled with event.

event.spawn | list(predefined_string, int, int) : Enemy category, X, Y | Spawn an enemy from this category at location

event.stash | bool | If true, the Stash menu if opened.

event.npc | filename | Filename of an NPC to start dialog with.

event.music | filename | Change background music to specified file.

event.cutscene | filename | Show specified cutscene by filename.

event.repeat | bool | If true, the event to be triggered again.

event.save_game | bool | If true, the game is saved when the event is triggered. The respawn position is set to where the player is standing.

event.book | filename | Opens a book by filename.

event.script | filename | Loads and executes an Event from a file.

event.chance_exec | int | Percentage chance that this event will execute when triggered.

event.respec | ["xp", "stats", "powers"], bool : Respec mode, Ignore class defaults | Resets various aspects of the character's progression. Resetting "xp" also resets "stats". Resetting "stats" also resets "powers".


EventManager: Random Map List

Description of maps/random/lists/

map | filename, int, int : Map file, X, Y | Adds a map and optional spawn position to the random list of maps to teleport to.


FontEngine: Font colors

Description of engine/font_colors.txt

menu_normal | color | Basic menu text color. Recommended white.

menu_bonus | color | Positive menu text color. Recommended green.

menu_penalty | color | Negative menu text color. Recommended red.

widget_normal | color | Basic widget text color. Recommended white.

widget_disabled | color | Disabled widget text color. Recommended grey.

combat_givedmg | color | Enemy damage text color. Recommended white.

combat_takedmg | color | Player damage text color. Recommended red.

combat_crit | color | Enemy critical damage text color. Recommended yellow.

combat_buff | color | Healing/buff text color. Recommended green.

combat_miss | color | Missed attack text color. Recommended grey.

requirements_not_met | color | Unmet requirements text color. Recommended red.

item_bonus | color | Item bonus text color. Recommended green.

item_penalty | color | Item penalty text color. Recommended red.

item_flavor | color | Item flavor text color. Recommended grey.

hardcore_color_name | color | Permadeath save slot player name color. Recommended red.


GameStateConfigBase

Description of menus/config.txt

button_ok | int, int, alignment : X, Y, Alignment | Position of the "OK" button.

button_defaults | int, int, alignment : X, Y, Alignment | Position of the "Defaults" button.

button_cancel | int, int, alignment : X, Y, Alignment | Position of the "Cancel" button.

listbox_scrollbar_offset | int | Horizontal offset from the right of listboxes (mods, languages, etc) to place the scrollbar.

frame_offset | point | Offset for all the widgets contained under each tab.

tab_offset | point | Offset for the row of tabs.

music_volume | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Music Volume" slider relative to the frame.

sound_volume | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Sound Volume" slider relative to the frame.

language | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Language" list box relative to the frame.

language_height | int | Number of visible rows for the "Language" list box.

combat_text | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Show combat text" checkbox relative to the frame.

show_fps | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Show FPS" checkbox relative to the frame.

colorblind | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Colorblind Mode" checkbox relative to the frame.

hardware_cursor | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Hardware mouse cursor" checkbox relative to the frame.

dev_mode | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Developer Mode" checkbox relative to the frame.

loot_tooltips | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Always show loot labels" checkbox relative to the frame.

statbar_labels | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Always show stat bar labels" checkbox relative to the frame.

auto_equip | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Automatically equip items" checkbox relative to the frame.

subtitles | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Subtitles" checkbox relative to the frame.

activemods | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Active Mods" list box relative to the frame.

activemods_height | int | Number of visible rows for the "Active Mods" list box.

inactivemods | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Available Mods" list box relative to the frame.

inactivemods_height | int | Number of visible rows for the "Available Mods" list box.

activemods_shiftup | point | Position of the button to shift mods up in "Active Mods" relative to the frame.

activemods_shiftdown | point | Position of the button to shift mods down in "Active Mods" relative to the frame.

activemods_deactivate | point | Position of the "Disable" button relative to the frame.

inactivemods_activate | point | Position of the "Enable" button relative to the frame.


GameStateConfigDesktop

Description of menus/config.txt

renderer | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Renderer" list box relative to the frame.

renderer_height | int | Number of visible rows for the "Renderer" list box.

fullscreen | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Full Screen Mode" checkbox relative to the frame.

mouse_move | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Move hero using mouse" checkbox relative to the frame.

hwsurface | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Hardware surfaces" checkbox relative to the frame.

vsync | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "V-Sync" checkbox relative to the frame.

texture_filter | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Texture Filtering" checkbox relative to the frame.

dpi_scaling | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "DPI scaling" checkbox relative to the frame.

change_gamma | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Allow changing gamma" checkbox relative to the frame.

gamma | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Gamma" slider relative to the frame.

enable_joystick | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Use joystick" checkbox relative to the frame.

joystick_device | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Joystick" list box relative to the frame.

joystick_device_height | int | Number of visible rows for the "Joystick" list box.

mouse_aim | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Mouse aim" checkbox relative to the frame.

no_mouse | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Do not use mouse" checkbox relative to the frame.

joystick_deadzone | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Joystick Deadzone" slider relative to the frame.

secondary_offset | point | Offset of the second (and third) columns of keybinds.

keybinds_bg_color | color | Background color for the keybindings scrollbox.

keybinds_bg_alpha | int | Alpha value for the keybindings scrollbox background color.

scrollpane | rectangle | Position of the keybinding scrollbox relative to the frame.

scrollpane_contents | int | The vertical size of the keybinding scrollbox's contents.

cancel | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Cancel" keybind relative to the keybinding scrollbox.

accept | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Accept" keybind relative to the keybinding scrollbox.

up | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Up" keybind relative to the keybinding scrollbox.

down | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Down" keybind relative to the keybinding scrollbox.

left | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Left" keybind relative to the keybinding scrollbox.

right | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Right" keybind relative to the keybinding scrollbox.

bar1 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar1" keybind relative to the keybinding scrollbox.

bar2 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar2" keybind relative to the keybinding scrollbox.

bar3 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar3" keybind relative to the keybinding scrollbox.

bar4 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar4" keybind relative to the keybinding scrollbox.

bar5 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar5" keybind relative to the keybinding scrollbox.

bar6 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar6" keybind relative to the keybinding scrollbox.

bar7 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar7" keybind relative to the keybinding scrollbox.

Bar8 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar8" keybind relative to the keybinding scrollbox.

bar9 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar9" keybind relative to the keybinding scrollbox.

bar0 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Bar0" keybind relative to the keybinding scrollbox.

main1 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Main1" keybind relative to the keybinding scrollbox.

main2 | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Main2" keybind relative to the keybinding scrollbox.

character | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Character" keybind relative to the keybinding scrollbox.

inventory | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Inventory" keybind relative to the keybinding scrollbox.

powers | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Powers" keybind relative to the keybinding scrollbox.

log | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Log" keybind relative to the keybinding scrollbox.

ctrl | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Ctrl" keybind relative to the keybinding scrollbox.

shift | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Shift" keybind relative to the keybinding scrollbox.

alt | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Alt" keybind relative to the keybinding scrollbox.

delete | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Delete" keybind relative to the keybinding scrollbox.

actionbar | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "ActionBar Accept" keybind relative to the keybinding scrollbox.

actionbar_back | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "ActionBar Left" keybind relative to the keybinding scrollbox.

actionbar_forward | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "ActionBar Right" keybind relative to the keybinding scrollbox.

actionbar_use | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "ActionBar Use" keybind relative to the keybinding scrollbox.

developer_menu | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Developer Menu" keybind relative to the keybinding scrollbox.


Cutscene

Description of cutscenes in cutscenes/

caption_margins | float, float : X margin, Y margin | Percentage-based margins for the caption text based on screen size

caption_background | color, int : Color, Alpha | Color (RGBA) of the caption area background.

vscroll_speed | float | The speed at which elements will scroll in 'vscroll' scenes.

menu_backgrounds | bool | This cutscene will use a random fullscreen background image, like the title screen does

music | filename | The music file that will play during this cutscene.

scene.caption | string | A caption that will be shown.

scene.image | filename, int : Filename, Scaling type | Filename of an image that will be shown. The scaling type is a value between 0-2, corresponding to none, fit height, fit screen.

scene.pause | duration | Pause before next component in 'ms' or 's'. A value of '-1' may be used to pause indefinitely.

scene.soundfx | filename | Filename of a sound that will be played

vscroll.text | string | A single, non-wrapping line of text.

vscroll.image | filename | Filename of an image that will be shown.

vscroll.separator | int | Places an invisible gap of a specified height between elements.


GameStateLoad

Description of menus/gameload.txt

button_new | int, int, alignment : X, Y, Alignment | Position of the "New Game" button.

button_load | int, int, alignment : X, Y, Alignment | Position of the "Load Game" button.

button_delete | int, int, alignment : X, Y, Alignment | Position of the "Delete Save" button.

button_exit | int, int, alignment : X, Y, Alignment | Position of the "Exit to Title" button.

portrait | rectangle | Position and dimensions of the portrait image.

gameslot | rectangle | Position and dimensions of the first game slot.

name | label | The label for the hero's name. Position is relative to game slot position.

level | label | The label for the hero's level. Position is relative to game slot position.

class | label | The label for the hero's class. Position is relative to game slot position.

map | label | The label for the hero's current location. Position is relative to game slot position.

slot_number | label | The label for the save slot index. Position is relative to game slot position.

loading_label | label | The label for the "Entering game world..."/"Loading saved game..." text.

sprite | point | Position for the avatar preview image in each slot

visible_slots | int | The maximum numbers of visible save slots.

text_trim_boundary | int | The position of the right-side boundary where text will be shortened with an ellipsis. Position is relative to game slot position.


GameStateNew: Layout

Description of menus/gamenew.txt

button_prev | int, int, alignment : X, Y, Alignment | Position of button to choose the previous preset hero.

button_next | int, int, alignment : X, Y, Alignment | Position of button to choose the next preset hero.

button_exit | int, int, alignment : X, Y, Alignment | Position of "Cancel" button.

button_create | int, int, alignment : X, Y, Alignment | Position of "Create" button.

button_permadeath | int, int, alignment : X, Y, Alignment | Position of checkbox for toggling permadeath.

bytton_randomize | int, int, alignment : X, Y, Alignment | Position of the "Randomize" button.

name_input | int, int, alignment : X, Y, Alignment | Position of the hero name textbox.

portrait_label | label | Label for the "Choose a Portrait" text.

name_label | label | Label for the "Choose a Name" text.

permadeath_label | label | Label for the "Permadeath?" text.

classlist_label | label | Label for the "Choose a Class" text.

classlist_height | int | Number of visible rows for the class list widget.

portrait | rectangle | Position and dimensions of the portrait image.

class_list | int, int, alignment : X, Y, Alignment | Position of the class list.

show_classlist | bool | Allows hiding the class list.

random_option | bool | Initially picks a random character option (aka portrait/name).

random_class | bool | Initially picks a random character class.


GameStateNew: Hero options

Description of engine/hero_options.txt

option | int, string, string, filename, string : Index, Base, Head, Portrait, Name | A default body, head, portrait, and name for a hero.


GameStatePlay: Titles

Description of engine/titles.txt

title.title | string | The displayed title.

title.level | int | Requires level.

title.power | power_id | Requires power.

title.requires_status | list(string) | Requires status.

title.requires_not_status | list(string) | Requires not status.

title.primary_stat | predefined_string, predefined_string : Primary stat, Lesser primary stat | Required primary stat(s). The lesser stat is optional.


GameStateTitle

Description of menus/gametitle.txt

logo | filename, int, int, alignment : Image file, X, Y, Alignment | Filename and position of the main logo image.

play_pos | int, int, alignment : X, Y, Alignment | Position of the "Play Game" button.

config_pos | int, int, alignment : X, Y, Alignment | Position of the "Configuration" button.

credits_pos | int, int, alignment : X, Y, Alignment | Position of the "Credits" button.

exit_pos | int, int, alignment : X, Y, Alignment | Position of the "Exit Game" button.


GameSwitcher: Default music

Description of engine/default_music.txt

music | filename | Filename of a music file to play during game states that don't already have music.


GameSwitcher: Background images

Description of engine/menu_backgrounds.txt

background | repeatable(filename) | Filename of a background image to be added to the pool of random menu backgrounds


GameSwitcher: FPS counter

Description of menus/fps.txt

position | int, int, alignment : X, Y, Alignment | Position of the fps counter.

color | color | Color of the fps counter text.


IconManager

Description of engine/icons.txt

icon_set | repeatable(icon_id, filename) : First ID, Image file | Defines an icon graphics file to load, as well as the index of the first icon.

text_offset | point | A pixel offset from the top-left to place item quantity text on icons.


InputState: Default Keybindings

Description of engine/default_keybindings.txt. Use -1 for no binding. Keyboard values can be any of the key names listed in the SDL docs. Mouse values are in the format mouse_0. Joystick buttons are in the format joy_0. Joystick axis are in the format axis_0- or axis_0+.

default.cancel | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Cancel".

default.accept | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Accept".

default.up | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Up".

default.down | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Down".

default.left | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Left".

default.right | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Right".

default.bar1 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar1".

default.bar2 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar2".

default.bar3 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar3".

default.bar4 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar4".

default.bar5 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar5".

default.bar6 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar6".

default.bar7 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar7".

default.bar8 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar8".

default.bar9 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar9".

default.bar0 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Bar0".

default.main1 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Main1".

default.main2 | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Main2".

default.character | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Character".

default.inventory | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Inventory".

default.powers | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Powers".

default.log | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Log".

default.ctrl | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Ctrl".

default.shift | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Shift".

default.alt | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Alt".

default.delete | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Delete".

default.actionbar | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Actionbar Accept".

default.actionbar_back | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Actionbar Left".

default.actionbar_forward | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Actionbar Right".

default.actionbar_use | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Actionbar Use".

default.developer_menu | string, string, string : Keyboard/mouse 1, Keyboard/mouse 2, Joystick | Bindings for "Developer Menu".


ItemManager: Items

Description about the class and it usage, items/items.txt...

id | item_id | An uniq id of the item used as reference from other classes.

name | string | Item name displayed on long and short tooltips.

flavor | string | A description of the item.

level | int | The item's level. Has no gameplay impact. (Deprecated?)

icon | icon_id | An id for the icon to display for this item.

book | filename | A book file to open when this item is activated.

quality | predefined_string | Item quality matching an id in items/qualities.txt

item_type | predefined_string | Equipment slot matching an id in items/types.txt

equip_flags | list(predefined_string) | A comma separated list of flags to set when this item is equipped. See engine/equip_flags.txt.

dmg | predefined_string, int, int : Damage type, Min, Max | Defines the item's base damage type and range. Max may be ommitted and will default to Min.

abs | int, int : Min, Max | Defines the item absorb value, if only min is specified the absorb value is fixed.

requires_level | int | The hero's level must match or exceed this value in order to equip this item.

requires_stat | repeatable(predefined_string, int) : Primary stat name, Value | Make item require specific stat level ex. requires_stat=physical,6 will require hero to have level 6 in physical stats

requires_class | predefined_string | The hero's base class (engine/classes.txt) must match for this item to be equipped.

bonus | repeatable(predefined_string, int) : Stat name, Value | Adds a bonus to the item by stat name, example bonus=hp, 50

bonus_power_level | repeatable(power_id, int) : Base power, Bonus levels | Grants bonus levels to a given base power.

soundfx | filename | Sound effect filename to play for the specific item.

gfx | filename | Filename of an animation set to display when the item is equipped.

loot_animation | repeatable(filename, int, int) : Loot image, Min quantity, Max quantity | Specifies the loot animation file for the item. The max quantity, or both quantity values, may be omitted.

power | power_id | Adds a specific power to the item which makes it usable as a power and can be placed in action bar.

replace_power | repeatable(int, int) : Old power, New power | Replaces the old power id with the new power id in the action bar when equipped.

power_desc | string | A string describing the additional power.

price | int | The amount of currency the item costs, if set to 0 the item cannot be sold.

price_per_level | int | Additional price for each player level above 1

price_sell | int | The amount of currency the item is sold for, if set to 0 the sell prices is prices*vendor_ratio.

max_quantity | int | Max item count per stack.

pickup_status | string | Set a campaign status when item is picked up, this is used for quest items.

stepfx | predefined_string | Sound effect when walking, this applies only to armors.

disable_slots | list(predefined_string) | A comma separated list of equip slot types to disable when this item is equipped.

quest_item | bool | If true, this item is a quest item and can not be dropped, stashed, or sold.


ItemManager: Types

Definition of a item types, items/types.txt...

type.id | string | Item type identifier.

type.name | string | Item type name.


ItemManager: Qualities

Definition of a item qualities, items/types.txt...

quality.id | string | Item quality identifier.

quality.name | string | Item quality name.

quality.color | color | Item quality color.

quality.overlay_icon | icon_id | The icon to be used as an overlay.


ItemManager: Sets

Definition of a item sets, items/sets.txt...

id | int | A uniq id for the item set.

name | string | Name of the item set.

items | list(item_id) | List of item id's that is part of the set.

color | color | A specific of color for the set.

bonus | repeatable(int, string, int) : Required set item count, Stat name, Value | Bonus to append to items in the set.

bonus_power_level | repeatable(int, power_id, int) : Required set item count, Base power, Bonus levels | Grants bonus levels to a given base power.


Map

Description of maps/

title | string | Title of map

width | int | Width of map

height | int | Height of map

tileset | filename | Filename of a tileset definition to use for map

music | filename | Filename of background music to use for map

hero_pos | point | The player will spawn in this location if no point was previously given.

parallax_layers | filename | Filename of a parallax layers definition.

background_color | color, int : Color, alpha | Background color for the map.

tilewidth | int | Inherited from Tiled map file. Unused by engine.

tileheight | int | Inherited from Tiled map file. Unused by engine.

layer.type | string | Map layer type.

layer.format | string | Format for map layer, must be 'dec'

layer.data | raw | Raw map layer data

enemygroup.type | string | (IGNORED BY ENGINE) The "type" field, as used by Tiled and other mapping tools.

enemygroup.category | predefined_string | The category of enemies that will spawn in this group.

enemygroup.level | int, int : Min, Max | Defines the level range of enemies in group. If only one number is given, it's the exact level.

enemygroup.location | rectangle | Location area for enemygroup

enemygroup.number | int, int : Min, Max | Defines the range of enemies in group. If only one number is given, it's the exact amount.

enemygroup.chance | int | Percentage of chance

enemygroup.direction | direction | Direction that enemies will initially face.

enemygroup.waypoints | list(point) | Enemy waypoints; single enemy only; negates wander_radius

enemygroup.wander_radius | int | The radius (in tiles) that an enemy will wander around randomly; negates waypoints

enemygroup.requires_status | list(string) | Status required for loading enemies

enemygroup.requires_not_status | list(string) | Status required to be missing for loading enemies

enemygroup.invincible_requires_status | list(string) | Enemies in this group are invincible to hero attacks when these statuses are set.

enemygroup.invincible_requires_not_status | list(string) | Enemies in this group are invincible to hero attacks when these statuses are not set.

npc.type | string | (IGNORED BY ENGINE) The "type" field, as used by Tiled and other mapping tools.

npc.filename | string | Filename of an NPC definition.

npc.requires_status | list(string) | Status required for NPC load. There can be multiple states, separated by comma

npc.requires_not_status | list(string) | Status required to be missing for NPC load. There can be multiple states, separated by comma

npc.location | point | Location of NPC


MapParallax

Description of maps/parallax/

layer.image | filename | Image file to use as a scrolling background.

layer.speed | float | Speed at which the background will move relative to the camera.

layer.fixed_speed | float, float : X speed, Y speed | Speed at which the background will move independent of the camera movement.

layer.map_layer | string | The tile map layer that this parallax layer will be rendered on top of.


MenuActionBar

Description of menus/actionbar.txt

slot | repeatable(int, int, int, bool) : Index, X, Y, Locked | Index (max 10) and position for power slot. If a slot is locked, its Power can't be changed by the player.

slot_M1 | point, bool : Position, Locked | Position for the primary action slot. If the slot is locked, its Power can't be changed by the player.

slot_M2 | point, bool : Position Locked | Position for the secondary action slot. If the slot is locked, its Power can't be changed by the player.

char_menu | point | Position for the Character menu button.

inv_menu | point | Position for the Inventory menu button.

powers_menu | point | Position for the Powers menu button.

log_menu | point | Position for the Log menu button.


MenuActiveEffects

Description of menus/activeeffects.txt

vertical | bool | True is vertical orientation; False is horizontal orientation.


MenuBook

Description of books in books/

close | point | Position of the close button.

background | filename | Filename for the background image.

image.image_pos | point | Position of the image.

image.image | filename | Filename of the image.

image.requires_status | list(string) | Image requires these campaign statuses in order to be visible.

image.requires_not_status | list(string) | Image must not have any of these campaign statuses in order to be visible.

text.text_pos | int, int, int, ["left", "center", "right"] : X, Y, Width, Text justify | Position of the text.

text.text_font | color, string : Font color, Font style | Font color and style.

text.text | string | The text to be displayed.

text.requires_status | list(string) | Text requires these campaign statuses in order to be visible.

text.requires_not_status | list(string) | Text must not have any of these campaign statuses in order to be visible.

button.button_pos | point | Position of the button.

button.button_image | filename | Image file to use for this button. Default is the normal menu button.

button.text | string | Optional text label for the button.


MenuCharacter

Description of menus/character.txt

close | point | Position of the close button.

label_title | label | Position of the "Character" text.

upgrade_primary | predefined_string, point : Primary stat name, Button position | Position of the button used to add a stat point to this primary stat.

statlist | point | Position of the scrollbox containing non-primary stats.

statlist_rows | int | The height of the statlist in rows.

statlist_scrollbar_offset | int | Right margin in pixels for the statlist's scrollbar.

label_name | label | Position of the "Name" text.

label_level | label | Position of the "Level" text.

label_primary | predefined_string, label : Primary stat name, Text positioning | Position of the text label for this primary stat.

name | rectangle | Position of the player's name and dimensions of the tooltip hotspot.

level | rectangle | Position of the player's level and dimensions of the tooltip hotspot.

primary | predefined_string, rectangle : Primary stat name, Hotspot position | Position of this primary stat value display and dimensions of its tooltip hotspot.

unspent | label | Position of the label showing the number of unspent stat points.

show_resists | bool | Hide the elemental "Resistance" stats in the statlist if set to false.

show_stat | predefined_string, bool : Stat name / Damage type, Visible | Hide the matching stat or damage type min/max in the statlist if set to false.

name_max_width | int | The maxiumum width, in pixels, that the character name can occupy until it is abbreviated.


Menu

Description of menus in menus/

pos | rectangle | Menu position and dimensions

align | alignment | Position relative to screen edges

soundfx_open | filename | Filename of a sound to play when opening this menu.

soundfx_close | filename | Filename of a sound to play when closing this menu.


MenuDevConsole

Description of menus/devconsole.txt

close | point | Position of the close button.

label_title | label | Position of the "Developer Console" label.

confirm | point | Position of the "Execute" button.

input | point | Position of the command entry widget.

history | rectangle | Position and dimensions of the command history.


MenuEnemy

Description of menus/enemy.txt

bar_pos | rectangle | Position and dimensions of the health bar.

text_pos | label | Position of the text displaying the enemy's name and level.


MenuExit

Description of menus/exit.txt

title | label | Position of the "Paused" text.

exit | point | Position of the "Save and Exit" button.

continue | point | Position of the "Continue" button.

music_volume | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Music Volume" slider relative to the frame.

sound_volume | int, int, int, int : Label X, Label Y, Widget X, Widget Y | Position of the "Sound Volume" slider relative to the frame.

enable_overlay | bool | If true, shows an overlay of the last message on top of other menus.

start_at_bottom | bool | If true, messages start at the bottom and get pushed up. If false, messages start at the top and get pushed down.

overlay_at_bottom | bool | If true, the overlay message will be at the bottom of the HUD log area. If false, it will be at the top.


MenuInventory

Description of menus/inventory.txt

close | point | Position of the close button.

equipment_slot | repeatable(int, int, string) : X, Y, Slot Type | Position and item type of an equipment slot.

carried_area | point | Position of the first normal inventory slot.

carried_cols | int | The number of columns for the normal inventory.

carried_rows | int | The number of rows for the normal inventory.

label_title | label | Position of the "Inventory" label.

currency | label | Position of the label that displays the total currency being carried.

help | rectangle | A mouse-over area that displays some help text for inventory shortcuts.


MenuLog

Description of menus/log.txt

label_title | label | Position of the "Log" text.

close | point | Position of the close button.

tab_area | rectangle | The position of the row of tabs, followed by the dimensions of the log text area.


MenuMiniMap

Description of menus/minimap.txt

map_pos | rectangle | Position and dimensions of the map.

text_pos | label | Position of the text label with the map name.

background | filename | Optional background image.


MenuNPCActions

Description of menus/npc.txt

background_color | color, int : Color, Alpha | Color and alpha of the menu's background.

topic_normal_color | color | The normal color of a generic topic text.

topic_hilight_color | color | The color of generic topic text when it's hovered over or selected.

vendor_normal_color | color | The normal color of the vendor option text.

vendor_hilight_color | color | The color of vendor option text when it's hovered over or selected.

cancel_normal_color | color | The normal color of the option to close the menu.

cancel_hilight_color | color | The color of the option to close the menu when it's hovered over or selected.


MenuNumPicker

Description of menus/num_picker.txt

label_title | label | Position of the "Enter amount " text.

confirm | point | Position of the "OK" button.

increase | point | Position of the button used to increase the value.

decrease | point | Position of the button used to decrease the value.

close | point | Position of the button used to close the number picker window.

input | point | Position of the text input box.


MenuPowers: Menu layout

Description of menus/powers.txt

label_title | label | Position of the "Powers" text.

unspent_points | label | Position of the text that displays the amount of unused power points.

close | point | Position of the close button.

tab_area | rectangle | Position and dimensions of the tree pages.


MenuPowers: Power tree layout

Description of powers/trees/

background | filename | Filename of the default background image

tab.title | string | The name of this power tree tab

tab.background | filename | Filename of the background image for this tab's power tree

power.id | int | A power id from powers/powers.txt for this slot.

power.tab | int | Tab index to place this power on, starting from 0.

power.position | point | Position of this power icon; relative to MenuPowers "pos".

power.requires_primary | predefined_string, int : Primary stat name, Required value | Power requires this primary stat to be at least the specificed value.

power.requires_point | bool | Power requires a power point to unlock.

power.requires_level | int | Power requires at least this level for the hero.

power.requires_power | power_id | Power requires another power id.

power.visible_requires_status | repeatable(string) | Hide the power if we don't have this campaign status.

power.visible_requires_not_status | repeatable(string) | Hide the power if we have this campaign status.

power.upgrades | list(power_id) | A list of upgrade power ids that this power slot can upgrade to. Each of these powers should have a matching upgrade section.

upgrade.id | int | A power id from powers/powers.txt for this upgrade.

upgrade.requires_primary | predefined_string, int : Primary stat name, Required value | Upgrade requires this primary stat to be at least the specificed value.

upgrade.requires_point | bool | Upgrade requires a power point to unlock.

upgrade.requires_level | int | Upgrade requires at least this level for the hero.

upgrade.requires_power | int | Upgrade requires another power id.

upgrade.visible_requires_status | repeatable(string) | Hide the upgrade if we don't have this campaign status.

upgrade.visible_requires_not_status | repeatable(string) | Hide the upgrade if we have this campaign status.


MenuStash

Description of menus/stash.txt

close | point | Position of the close button.

slots_area | point | Position of the top-left slot.

stash_cols | int | The number of columns for the grid of slots.

stash_rows | int | The number of rows for the grid of slots.

label_title | label | Position of the "Stash" label.

currency | label | Position of the label displaying the amount of currency stored in the stash.


MenuStatBar

Description of menus/hp.txt, menus/mp.txt, menus/xp.txt

bar_pos | rectangle | Position and dimensions of the bar graphics.

text_pos | label | Position of the text displaying the current value of the relevant stat.

orientation | bool | True is vertical orientation; false is horizontal.

bar_gfx | filename | Filename of the image to use for the "fill" of the bar.

bar_gfx_background | filename | Filename of the image to use for the base of the bar.


MenuTalker

Description of menus/talker.txt

close | point | Position of the close button.

advance | point | Position of the button to advance dialog.

dialogbox | rectangle | Position and dimensions of the text box graphics.

dialogtext | rectangle | Rectangle where the dialog text is placed.

text_offset | point | Margins for the left/right and top/bottom of the dialog text.

portrait_he | rectangle | Position and dimensions of the NPC portrait graphics.

portrait_you | rectangle | Position and dimensions of the player's portrait graphics.

font_who | predefined_string | Font style to use for the name of the currently talking person.

font_dialog | predefined_string | Font style to use for the dialog text.


MenuVendor

Description of menus/vendor.txt

close | point | Position of the close button.

slots_area | point | Position of the top-left slot.

vendor_cols | int | The number of columns in the grid of slots.

vendor_rows | int | The number of rows in the grid of slots.

label_title | label | The position of the text that displays the NPC's name.


ModManager

Description of mod settings.txt

description | string | Some text describing the mod.

description_locale | string, string : Language, Translated description | A translated description for a language (specified by 2-letter code).

version | version | The version number of this mod.

requires | list(string) | A comma-separated list of the mods that are required in order to use this mod. The dependency version requirements can also be specified and separated by colons (e.g. fantasycore 0.1 2.0).

game | string | The game which this mod belongs to (e.g. flare-game).

engine_version_min | version | The minimum engine version required to use this mod.

engine_version_max | version | The maximum engine version required to use this mod.


NPC

Description of NPCs in npcs/

dialog.him | repeatable(string) | A line of dialog from the NPC.

dialog.her | repeatable(string) | A line of dialog from the NPC.

dialog.you | repeatable(string) | A line of dialog from the player.

dialog.voice | repeatable(string) | Filename of a voice sound file to play.

dialog.topic | string | The name of this dialog topic. Displayed when picking a dialog tree.

dialog.group | string | Dialog group.

dialog.allow_movement | bool | Restrict the player's mvoement during dialog.

dialog.portrait_him | repeatable(filename) | Filename of a portrait to display for the NPC during this dialog.

dialog.portrait_her | repeatable(filename) | Filename of a portrait to display for the NPC during this dialog.

dialog.portrait_you | repeatable(filename) | Filename of a portrait to display for the player during this dialog.

name | string | NPC's name.

gfx | filename | Filename of an animation definition.

direction | direction | The direction to use for this NPC's stance animation.

talker | bool | Allows this NPC to be talked to.

portrait | filename | Filename of the default portrait image.

vendor | bool | Allows this NPC to buy/sell items.

vendor_requires_status | list(string) | The player must have these statuses in order to use this NPC as a vendor.

vendor_requires_not_status | list(string) | The player must not have these statuses in order to use this NPC as a vendor.

constant_stock | repeatable(list(item_id)) | A list of items this vendor has for sale. Quantity can be specified by appending " Q" to the item_id, where Q is an integer.

status_stock | repeatable(string, list(item_id)) : Required status, Item(s) | A list of items this vendor will have for sale if the required status is met. Quantity can be specified by appending " Q" to the item_id, where Q is an integer.

random_stock | list(loot) | Use a loot table to add random items to the stock; either a filename or an inline definition.

random_stock_count | int, int : Min, Max | Sets the minimum (and optionally, the maximum) amount of random items this npc can have.

vox_intro | repeatable(filename) | Filename of a sound file to play when initially interacting with the NPC.


PowerManager: Effects

Description of powers/effects.txt

effect.id | string | Unique identifier for the effect definition.

effect.type | string | Defines the type of effect

effect.name | string | A displayed name that is shown when hovering the mouse over the effect icon.

effect.icon | icon_id | The icon to visually represent the effect in the status area

effect.animation | filename | The filename of effect animation.

effect.can_stack | bool | Allows multiple instances of this effect

effect.max_stacks | int | Maximum allowed instances of this effect, -1 for no limits

effect.group_stack | bool | For effects that can stack, setting this to true will combine those effects into a single status icon.

effect.render_above | bool | Effect is rendered above

effect.color_mod | color | Changes the color of the afflicted entity.

effect.alpha_mod | int | Changes the alpha of the afflicted entity.

effect.attack_speed_anim | string | If the type of Effect is attack_speed, this defines the attack animation that will have its speed changed.


PowerManager: Powers

Description of powers/powers.txt

power.id | power_id | Uniq identifier for the power definition.

power.type | ["fixed", "missile", "repeater", "spawn", "transform", "block"] | Defines the type of power definiton

power.name | string | The name of the power

power.description | string | Description of the power

power.icon | icon_id | The icon to visually represent the power eg. in skill tree or action bar.

power.new_state | predefined_string | When power is used, hero or enemy will change to this state. Must be one of the states ["instant", user defined]

power.state_duration | duration | Sets the length of time the caster is in their state animation. A time longer than the animation length will cause the animation to pause on the last frame. Times shorter than the state animation length will have no effect.

power.prevent_interrupt | bool | Prevents the caster from being interrupted by a hit when casting this power.

power.face | bool | Power will make hero or enemy to face the target location.

power.source_type | ["hero", "neutral", "enemy"] | Determines which entities the power can effect.

power.beacon | bool | True if enemy is calling its allies.

power.count | int | The count of hazards/effect or spawns to be created by this power.

power.passive | bool | If power is unlocked when the hero or enemy spawns it will be automatically activated.

power.passive_trigger | ["on_block", "on_hit", "on_halfdeath", "on_joincombat", "on_death"] | This will only activate a passive power under a certain condition.

power.meta_power | bool | If true, this power can not be used on it's own. Instead, it should be replaced via an item with a replace_power entry.

power.no_actionbar | bool | If true, this power is prevented from being placed on the actionbar.

power.requires_flags | list(predefined_string) | A comma separated list of equip flags that are required to use this power. See engine/equip_flags.txt

power.requires_mp | int | Restrict power usage to a specified MP level.

power.requires_hp | int | Restrict power usage to a specified HP level.

power.sacrifice | bool | If the power has requires_hp, allow it to kill the caster.

power.requires_los | bool | Requires a line-of-sight to target.

power.requires_empty_target | bool | The power can only be cast when target tile is empty.

power.requires_item | repeatable(item_id, int) : Item, Quantity | Requires a specific item of a specific quantity in inventory. If quantity > 0, then the item will be removed.

power.requires_equipped_item | repeatable(item_id, int) : Item, Quantity | Requires a specific item of a specific quantity to be equipped on hero. If quantity > 0, then the item will be removed.

power.requires_targeting | bool | Power is only used when targeting using click-to-target.

power.requires_spawns | int | The caster must have at least this many summoned creatures to use this power.

power.cooldown | duration | Specify the duration for cooldown of the power in 'ms' or 's'.

power.requires_hpmp_state | ["hp", "mp"], ["percent", "not_percent", "ignore"], int : Stat, Current state, Percentage value | Power can only be used when HP/MP matches the specified state

power.animation | filename | The filename of the power animation.

power.soundfx | filename | Filename of a sound effect to play when the power is used.

power.soundfx_hit | filename | Filename of a sound effect to play when the power's hazard hits a valid target.

power.directional | bool | The animation sprite sheet contains 8 directions, one per row.

power.visual_random | int | The animation sprite sheet contains rows of random options

power.visual_option | int | The animation sprite sheet containers rows of similar effects, use a specific option. If using visual_random, this serves as an offset for the lowest random index.

power.aim_assist | bool | If true, power targeting will be offset vertically by the number of pixels set with "aim_assist" in engine/misc.txt.

power.speed | float | The speed of missile hazard, the unit is defined as map units per frame.

power.lifespan | duration | How long the hazard/animation lasts in 'ms' or 's'.

power.floor | bool | The hazard is drawn between the background and the object layer.

power.complete_animation | bool | For hazards; Play the entire animation, even if the hazard has hit a target.

power.charge_speed | float | Moves the caster at this speed in the direction they are facing until the state animation is finished.

power.attack_speed | int | Changes attack animation speed for this Power. A value of 100 is 100% speed (aka normal speed).

power.use_hazard | bool | Power uses hazard.

power.no_attack | bool | Hazard won't affect other entities.

power.no_aggro | bool | If true, the Hazard won't put its target in a combat state.

power.radius | float | Radius in pixels

power.base_damage | predefined_string : Damage type ID | Determines which damage stat will be used to calculate damage.

power.starting_pos | ["source", "target", "melee"] | Start position for hazard

power.relative_pos | bool | Hazard will move relative to the caster's position.

power.multitarget | bool | Allows a hazard power to hit more than one entity.

power.multihit | bool | Allows a hazard power to hit the same entity more than once.

power.expire_with_caster | bool | If true, hazard will disappear when the caster dies.

power.ignore_zero_damage | bool | If true, hazard can still hit the player when damage is 0, triggering post_power and post_effects.

power.lock_target_to_direction | bool | If true, the target is "snapped" to one of the 8 directions.

power.movement_type | ["ground", "flying", "intangible"] | For moving hazards (missile/repeater), this defines which parts of the map it can collide with. The default is "flying".

power.trait_armor_penetration | bool | Ignores the target's Absorbtion stat

power.trait_avoidance_ignore | bool | Ignores the target's Avoidance stat

power.trait_crits_impaired | int | Increases critical hit percentage for slowed/immobile targets

power.trait_elemental | predefined_string | Damage done is elemental. See engine/elements.txt

power.target_range | float | The distance from the caster that the power can be activated

power.hp_steal | int | Percentage of damage to steal into HP

power.mp_steal | int | Percentage of damage to steal into MP

power.missile_angle | int | Angle of missile

power.angle_variance | int | Percentage of variance added to missile angle

power.speed_variance | float | Percentage of variance added to missile speed

power.delay | duration | Delay between repeats in 'ms' or 's'.

power.transform_duration | duration | Duration for transform in 'ms' or 's'.

power.manual_untransform | bool | Force manual untranform

power.keep_equipment | bool | Keep equipment while transformed

power.untransform_on_hit | bool | Force untransform when the player is hit

power.buff | bool | Power is cast upon the caster.

power.buff_teleport | bool | Power is a teleportation power.

power.buff_party | bool | Power is cast upon party members

power.buff_party_power_id | power_id | Only party members that were spawned with this power ID are affected by "buff_party=true". Setting this to 0 will affect all party members.

power.post_effect | predefined_string, int, duration , int : Effect ID, Magnitude, Duration, Chance to apply | Post effect to apply to target. Duration is in 'ms' or 's'.

power.post_effect_src | predefined_string, int, duration , int : Effect ID, Magnitude, Duration, Chance to apply | Post effect to apply to caster. Duration is in 'ms' or 's'.

power.pre_power | power_id, int : Power, Chance to cast | Trigger a power immediately when casting this one.

power.post_power | power_id, int : Power, Chance to cast | Trigger a power if the hazard did damage.

power.wall_power | power_id, int : Power, Chance to cast | Trigger a power if the hazard hit a wall.

power.wall_reflect | bool | Moving power will bounce off walls and keep going

power.spawn_type | predefined_string | For non-transform powers, an enemy is spawned from this category. For transform powers, the caster will transform into a creature from this category.

power.target_neighbor | int | Target is changed to an adjacent tile within a radius.

power.spawn_limit | ["fixed", "stat", "unlimited"], [int, predefined_string] : Mode, Value | The maximum number of creatures that can be spawned and alive from this power. "fixed" takes an integer. "stat" takes a primary stat as a string (e.g. "physical").

power.spawn_level | ["default", "fixed", "stat", "level"], [int, predefined_string] : Mode, Value | The level of spawned creatures. "fixed" and "level" take an integer. "stat" takes a primary stat as a string (e.g. "physical").

power.target_party | bool | Hazard will only affect party members.

power.target_categories | list(predefined_string) | Hazard will only affect enemies in these categories.

power.modifier_accuracy | ["multiply", "add", "absolute"], int : Mode, Value | Changes this power's accuracy.

power.modifier_damage | ["multiply", "add", "absolute"], int, int : Mode, Min, Max | Changes this power's damage. The "Max" value is ignored, except in the case of "absolute" modifiers.

power.modifier_critical | ["multiply", "add", "absolute"], int : Mode, Value | Changes the chance that this power will land a critical hit.

power.target_movement_normal | bool | Power can affect entities with normal movement (aka walking on ground)

power.target_movement_flying | bool | Power can affect flying entities

power.target_movement_intangible | bool | Power can affect intangible entities

power.walls_block_aoe | bool | When true, prevents hazard aoe from hitting targets that are behind walls/pits.

power.script | ["on_cast", "on_hit", "on_wall"], filename : Trigger, Filename | Loads and executes a script file when the trigger is activated.

power.remove_effect | repeatable(predefined_string, int) : Effect ID, Number of Effect instances | Removes a number of instances of a specific Effect ID. Omitting the number of instances, or setting it to zero, will remove all instances/stacks.

power.replace_by_effect | repeatable(int, predefined_string, int) : Power ID, Effect ID, Number of Effect instances | If the caster has at least the number of instances of the Effect ID, the defined Power ID will be cast instead.

power.requires_corpse | ["consume", bool] | If true, a corpse must be targeted for this power to be used. If "consume", then the corpse is also consumed on Power use.

power.target_nearest | float | Will automatically target the nearest enemy within the specified range.


QuestLog

Description of quest files in quests/

name | string | A displayed name for this quest.

complete_status | string | If this status is set, the quest will be displayed as completed.

quest.requires_status | list(string) | Quest requires this campaign status

quest.requires_not_status | list(string) | Quest requires not having this campaign status.

quest.requires_level | int | Quest requires hero level

quest.requires_not_level | int | Quest requires not hero level

quest.requires_currency | int | Quest requires atleast this much currency

quest.requires_not_currency | int | Quest requires no more than this much currency

quest.requires_item | list(item_id) | Quest requires specific item (not equipped)

quest.requires_not_item | list(item_id) | Quest requires not having a specific item (not equipped)

quest.requires_class | predefined_string | Quest requires this base class

quest.requires_not_class | predefined_string | Quest requires not this base class

quest.quest_text | string | Text that gets displayed in the Quest log when this quest is active.


SDLFontEngine: Font settings

Description of engine/font_settings.txt

font.id | string | An identifier used to reference this font.

font.style | repeatable(["default", predefined_string], filename, int, bool) : Language, Font file, Point size, Blending | Filename, point size, and blend mode of the font to use for this language. Language can be "default" or a 2-letter region code.


StatBlock: Core stats

Description of engine/stats.txt and enemies in enemies/

speed | float | Movement speed

cooldown | int | Cooldown between attacks in 'ms' or 's'.

cooldown_hit | duration | Duration of cooldown after being hit in 'ms' or 's'.

stat | string, int : Stat name, Value | The starting value for this stat.

stat_per_level | predefined_string, int : Stat name, Value | The value for this stat added per level.

stat_per_primary | predefined_string, predefined_string, int : Primary Stat, Stat name, Value | The value for this stat added for every point allocated to this primary stat.

vulnerable | predefined_string, int : Element, Value | Percentage weakness to this element.

power_filter | list(power_id) | Only these powers are allowed to hit this entity.


StatBlock: Sound effects

Description of heroes in engine/avatar/ and enemies in enemies/

sfx_attack | repeatable(predefined_string, filename) : Animation name, Sound file | Filename of sound effect for the specified attack animation.

sfx_hit | repeatable(filename) | Filename of sound effect for being hit.

sfx_die | repeatable(filename) | Filename of sound effect for dying.

sfx_critdie | repeatable(filename) | Filename of sound effect for dying to a critical hit.

sfx_block | repeatable(filename) | Filename of sound effect for blocking an incoming hit.

sfx_levelup | filename | Filename of sound effect for leveling up.


StatBlock: Enemies

Description of enemies in enemies/

name | string | Name

humanoid | bool | This creature gives human traits when transformed into, such as the ability to talk with NPCs.

lifeform | bool | Determines whether or not this entity is referred to as a living thing, such as displaying "Dead" vs "Destroyed" when their HP is 0.

level | int | Level

xp | int | XP awarded upon death.

loot | repeatable(loot) | Possible loot that can be dropped on death.

loot_count | int, int : Min, Max | Sets the minimum (and optionally, the maximum) amount of loot this creature can drop. Overrides the global drop_max setting.

defeat_status | string | Campaign status to set upon death.

convert_status | string | Campaign status to set upon being converted to a player ally.

first_defeat_loot | item_id | Drops this item upon first death.

quest_loot | string, string, item_id : Required status, Required not status, Item | Drops this item when campaign status is met.

flying | bool | Creature can move over gaps/water.

intangible | bool | Creature can move through walls.

facing | bool | Creature can turn to face their target.

waypoint_pause | duration | Duration to wait at each waypoint in 'ms' or 's'.

turn_delay | duration | Duration it takes for this creature to turn and face their target in 'ms' or 's'.

chance_pursue | int | Percentage change that the creature will chase their target.

chance_flee | int | Percentage chance that the creature will run away from their target.

power | ["melee", "ranged", "beacon", "on_hit", "on_death", "on_half_dead", "on_join_combat", "on_debuff"], power_id, int : State, Power, Chance | A power that has a chance of being triggered in a certain state.

passive_powers | list(power_id) | A list of passive powers this creature has.

melee_range | float | Minimum distance from target required to use melee powers.

threat_range | float, float : Engage distance, Stop distance | The first value is the radius of the area this creature will be able to start chasing the hero. The second, optional, value is the radius at which this creature will stop pursuing their target and defaults to double the first value.

flee_range | float | The radius at which this creature will start moving to a safe distance. Defaults to half of the threat_range.

combat_style | ["default", "aggressive", "passive"] | How the creature will enter combat. Default is within range of the hero; Aggressive is always in combat; Passive must be attacked to enter combat.

animations | filename | Filename of an animation definition.

suppress_hp | bool | Hides the enemy HP bar for this creature.

categories | list(string) | Categories that this enemy belongs to.

flee_duration | duration | The minimum amount of time that this creature will flee. They may flee longer than the specified time.

flee_cooldown | duration | The amount of time this creature must wait before they can start fleeing again.


StatBlock: Hero stats

Description of engine/stats.txt

max_points_per_stat | int | Maximum points for each primary stat.

sfx_step | string | An id for a set of step sound effects. See items/step_sounds.txt.

stat_points_per_level | int | The amount of stat points awarded each level.

power_points_per_level | int | The amount of power points awarded each level.


Subtitles

Description of soundfx/subtitles.txt

style.text_pos | label | Position and style of the subtitle text.

style.pos | point | Position of the subtitle text relative to alignment.

style.align | alignment | Alignment of the subtitle text.

style.background_color | color, int : Color, Alpha | Color and alpha of the subtitle background rectangle.

subtitle.id | filename | Filename of the sound file that will trigger this subtitle.

subtitle.text | string | The subtitle text that will be displayed.


TileSet

Description of tilesets in tilesets/

tileset.img | filename | Filename of a tile sheet image.

tileset.tile | int, int, int, int, int, int, int : Index, X, Y, Width, Height, X offset, Y offset | A single tile definition.

tileset.animation | list(int, int, int, duration) : Tile index, X, Y, duration | An animation for a tile. Durations are in 'ms' or 's'.


Predefined Strings

Below are some strings that are used in various attributes.


EffectManager

Description of "type" in powers/effects.txt

death_sentence | Causes sudden death at the end of the effect duration.

damage | Damage per second

damage_percent | Damage per second (percentage of max HP)

hpot | HP restored per second

hpot_percent | HP restored per second (percentage of max HP)

mpot | MP restored per second

mpot_percent | MP restored per second (percentage of max MP)

speed | Changes movement speed. A magnitude of 100 is 100% speed (aka normal speed).

attack_speed | Changes attack speed. A magnitude of 100 is 100% speed (aka normal speed).

immunity | Applies all immunity effects. Magnitude is ignored.

immunity_damage | Removes and prevents damage over time. Magnitude is ignored.

immunity_slow | Removes and prevents slow effects. Magnitude is ignored.

immunity_stun | Removes and prevents stun effects. Magnitude is ignored.

immunity_hp_steal | Prevents HP stealing. Magnitude is ignored.

immunity_mp_steal | Prevents MP stealing. Magnitude is ignored.

immunity_knockback | Removes and prevents knockback effects. Magnitude is ignored.

immunity_damage_reflect | Prevents damage reflection. Magnitude is ignored.

immunity_stat_debuff | Prevents stat value altering effects that have a magnitude less than 0. Magnitude is ignored.

stun | Can't move or attack. Being attacked breaks stun.

revive | Revives the player. Typically attached to a power that triggers when the player dies.

convert | Causes an enemy or an ally to switch allegiance

fear | Causes enemies to run away

knockback | Pushes the target away from the source caster. Speed is the given value divided by the framerate cap.

${STATNAME} | Increases ${STATNAME}, where ${STATNAME} is any of the base stats. Examples: hp, avoidance, xp_gain

${DAMAGE_TYPE} | Increases a damage min or max, where ${DAMAGE_TYPE} is any 'min' or 'max' value found in engine/damage_types.txt. Example: dmg_melee_min

${ELEMENT}_resist | Increase Resistance % to ${ELEMENT}, where ${ELEMENT} is any found in engine/elements.txt. Example: fire_resist

${PRIMARYSTAT} | Increases ${PRIMARYSTAT}, where ${PRIMARYSTAT} is any of the primary stats defined in engine/primary_stats.txt. Example: physical

shield | Create a damage absorbing barrier based on Mental damage stat. Duration is ignored.

heal | Restore HP based on Mental damage stat.


Stats

Description of the base stats, aka "stat name" or ${STATNAME}

hp | Hit points

hp_regen | HP restored per minute

mp | Magic points

mp_regen | MP restored per minute

accuracy | Accuracy %. Higher values mean less likely to miss.

avoidance | Avoidance %. Higher values means more likely to not get hit.

absorb_min | Minimum damage absorption

absorb_max | Maximum damage absorption

crit | Critical hit chance %

xp_gain | Percentage boost to the amount of experience points gained per kill.

currency_find | Percentage boost to the amount of gold dropped per loot event.

item_find | Increases the chance of finding items in loot.

stealth | Decrease the distance required to alert enemies by %

poise | Reduced % chance of entering "hit" animation when damaged

reflect_chance | Percentage chance to reflect missiles

return_damage | Deals a percentage of the damage taken back to the attacker

hp_steal | Percentage of HP stolen when damaging a target

mp_steal | Percentage of MP stolen when damaging a target

hp_percent | Base HP altered by percentage

mp_percent | Base MP altered by percentage

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.