Quasar-RCE - User contributions [en]

Vendetta/neoloader

2025-08-18T03:52:49Z

Luxen: /* For users */ Added ModDB link

[[image:Vendetta-Neobanner.jpg]]
== ==
'''<big><big>Neoloader Pre-execution Library Management Engine (NPLME) is a toolkit for loading and managing mods in Vendetta Online and improving functional usage between them.</big></big>'''

== For users ==
Neoloader is an advanced mod loader for Vendetta Online that sits on top of the existing mod loader. The goal of the Neoloader is to allow in-game management of Vendetta Online's plugins as much as the game engine can allow, and to facilitate a standard through which plugins can communicate with each other.

'''Features:'''
* Load plugins in order of dependencies and registration, instead of alphabetically
* Minimize risk of game crashes during the loading stage by safety-netting the loading process
* Provide management of plugins in-game
* Easy installation and removal of the system, and a guided recovery system in case of failure
* An extensive API to promote mod intercommunication and extensibility

Neoloader can be downloaded from the following locations:
{| border="1"
! Location
! Version
! Notes
|-
| '''[https://www.nexusmods.com/vendettaonline/mods/3 NexusMods]'''
| 6.3.0 (LME 3.12.0)
| This is the preferred location for stable versions of Neoloader
|-
| '''[https://voupr.spenced.com/plugin.php?name=neoloader VOUPR]'''
| 6.3.0 (LME 3.12.0)
|
|-
| '''[https://www.moddb.com/mods/neoloader ModDB]'''
| 6.3.0 (LME 3.12.0)
|
|-
| '''[https://github.com/LuxenDM/Neoloader Github]'''
| 7.0.0 (LME 3.12.0)
| This is a development version and may not be functional or complete
|}

The current version with public support is 6.3.0 providing LME API 3.12.0; the minimum version that will be supported is 6.1.1 providing LME API 3.11.0

Neoloader comes bundled with a few utilities used to interact with the software and manage its settings. These include
* The [[vendetta/neoloader/neomgr|lightweight management interface, neomgr]]
* The [[vendetta/neoloader/neonotif|notification control system, neonotif]]
* A [[vendetta/neoloader/recovery|recovery console]] for plugin errors

To manage non-LME mods, use a tool such as [https://www.nexusmods.com/vendettaonline/mods/2 Neopatcher] to convert mods to a hybrid model capable of being seen and managed by Neoloader.

== For modders ==
* [[vendetta/overview|Developer's overview]] <br />
* [[vendetta/design|Creating or converting a plugin for the LME]] <br />
* [[vendetta/registration|INI registration details]] <br />
* [[vendetta/API|LME API for developers]] <br />

Vendetta/API/update state

2025-08-03T19:57:14Z

Luxen: /* Other notes */ note on name editing a plugin - perfectly fine if used for language edits

=== Definition ===
lib.update_state (string id, string version, table state_data) :: nil

=== Description ===
Allows editing of a plugin's state data post-registration

=== Arguments ===
# string id: name of the mod to be activated
# string version: version of the mod to be activated
# table state_data: settings to adjust in table format. see below.

=== Returns ===
# nil

=== Other notes ===
* Added in LME 3.11.0

valid state data entries:
{| class="wikitable"
! Key !! Description
|-
| '''complete''' || Allows the plugin to trigger its own failure state and prevent any dependent plugins from running if they haven't already.
This cannot unload code that's already running. Use in hybrid mods to disable themselves easily.
Plugins cannot mark themselves as ‘complete’; this value can only be `false` or not exist.
|-
| '''name''' || Allows the plugin to change its registered display name, intended for multilingual language support
|-
| '''link''' || Allows the plugin to change the ‘link’ read from its INI file (or set one, if no link was originally provided).
|-
| '''plugin_name''' || Same as `name`.
|-
| '''plugin_link''' || Same as `link`.
|-
| '''err_details''' || If the plugin is marking itself as incomplete to indicate a self-caught error, this string is added to the LME log display.
|}

Vendetta/API/get state

2025-07-21T20:17:01Z

Luxen: /* Returns */ LME 3.12.x behavior adds statistical reporting of memory and launch time values

=== Definition ===
lib.get_state (id, version) :: mod_state_table

=== Description ===
Retrieves the state information of the selected mod

=== Arguments ===
# string id: name of the mod to be activated
# string version: version of the mod to be activated

=== Returns ===
# table mod_state: A table describing the mod's current state within the Neoloader registry
table definition:
{| class="wikitable"
! Key !! Description
|-
| '''load''' || String `"YES"` or `"NO"` - Indicates whether the mod is set to be loaded when Neoloader starts.
|-
| '''complete''' || Boolean - Indicates whether the mod completed successfully.
|-
| '''dependencies_met''' || Boolean - Determines whether all dependencies declared by the mod are satisfied.
|-
| '''load_position''' || Number - The order in which the mod was loaded compared to all registered mods.
|-
| '''errors''' || Table - List of logs associated with this mod.
|-
| '''latest''' || String - The latest version of this mod.
|-
| '''versions''' || Table - Contains all versions of this mod present in Neoloader.
|-
| '''plugin_id''' || String - The mod's unique ID.
|-
| '''plugin_version''' || String - The current version of the mod.
|-
| '''plugin_type''' || String - Descriptor of the mod, set by the author in the registration file.
(Not used by Neoloader, intended for managers.)
|-
| '''plugin_name''' || String - The public name of the mod.
|-
| '''plugin_author''' || String - The author of this mod.
|-
| '''plugin_link''' || String - A hyperlink to this mod's home page.
|-
| '''plugin_folder''' || String - The file path to the mod's folder.
|-
| '''plugin_ini_file''' || String - The file path to the mod's INI file.
|-
| '''plugin_frozen''' || String `"YES"` or `"NO"` - Determines whether this mod's dependents can execute.
|-
| '''plugin_dependencies''' || Table - A copy of this plugin's dependency list.
|-
| '''stats''' || Table - contains statistical values related to load-time footprint and time taken to load.
|}

=== Other notes ===
* Added in LME 2.x (Neoloader indev)
* Some of these details are not neccesary for Neoloader itself, and are intended to be used by potential mod management front-ends.

Vendetta/API/get path

2025-07-21T20:14:39Z

Luxen: Added LME 3.12.x behavior of get_path

=== Definition ===
lib.get_path (id, version) :: file_path_pointer

=== Description ===
Retrieves the path value of the function that called this function, or if an ID/version pair are provided, returns the path to the installed mod

=== Arguments ===
# string id: name of the mod to be retrieved
# string version: version of the mod to be retrieved

=== Returns ===
If called with no arguments (or invalid arguments)
* string file_path: The path to the folder of the file that called this function
OR, if string id/version are provided:
* string file_path: The path to the mod's folder; example: "plugins/Neomanager/"

=== Other notes ===
* Added in LME 3.1.x
* Updated in LME 3.12.0: Now can return the path to the file that executed this function
* (with an ID/Version pair) This path is based on the location of the mod's INI registration file

Vendetta/neoloader

2025-07-14T05:09:36Z

Luxen: /* For users */ updated version and support information for new release v6.3.0

[[image:Vendetta-Neobanner.jpg]]
== ==
'''<big><big>Neoloader Pre-execution Library Management Engine (NPLME) is a toolkit for loading and managing mods in Vendetta Online and improving functional usage between them.</big></big>'''

== For users ==
Neoloader is an advanced mod loader for Vendetta Online that sits on top of the existing mod loader. The goal of the Neoloader is to allow in-game management of Vendetta Online's plugins as much as the game engine can allow, and to facilitate a standard through which plugins can communicate with each other.

'''Features:'''
* Load plugins in order of dependencies and registration, instead of alphabetically
* Minimize risk of game crashes during the loading stage by safety-netting the loading process
* Provide management of plugins in-game
* Easy installation and removal of the system, and a guided recovery system in case of failure
* An extensive API to promote mod intercommunication and extensibility

Neoloader can be downloaded from the following locations:
{| border="1"
! Location
! Version
! Notes
|-
| '''[https://www.nexusmods.com/vendettaonline/mods/3 NexusMods]'''
| 6.3.0 (LME 3.12.0)
| This is the preferred location for stable versions of Neoloader
|-
| '''[https://voupr.spenced.com/plugin.php?name=neoloader VOUPR]'''
| 6.3.0 (LME 3.12.0)
|
|-
| '''[https://github.com/LuxenDM/Neoloader Github]'''
| 7.0.0 (LME 3.12.0)
| This is a development version and may not be functional or complete
|}

The current version with public support is 6.3.0 providing LME API 3.12.0; the minimum version that will be supported is 6.1.1 providing LME API 3.11.0

Neoloader comes bundled with a few utilities used to interact with the software and manage its settings. These include
* The [[vendetta/neoloader/neomgr|lightweight management interface, neomgr]]
* The [[vendetta/neoloader/neonotif|notification control system, neonotif]]
* A [[vendetta/neoloader/recovery|recovery console]] for plugin errors

To manage non-LME mods, use a tool such as [https://www.nexusmods.com/vendettaonline/mods/2 Neopatcher] to convert mods to a hybrid model capable of being seen and managed by Neoloader.

== For modders ==
* [[vendetta/overview|Developer's overview]] <br />
* [[vendetta/design|Creating or converting a plugin for the LME]] <br />
* [[vendetta/registration|INI registration details]] <br />
* [[vendetta/API|LME API for developers]] <br />

Vendetta/API/get latest

2025-06-11T03:23:09Z

Luxen: reformatted wording and better clarified behavior of function and its min/max filtering

=== Definition ===
lib.get_latest (id, [min, max]) :: mod_version

=== Description ===
Retrieves the latest version of an enabled mod, or the latest within a range of versions that is installed

=== Arguments ===
# string id: name of the mod to look up
# (optional) string min: minimum version to limit the range to
# (optional) string max: maximum version to limit the range to

=== Returns ===
# string mod_version: the latest version of the installed mod, or the latest installed within the provided range. If no version satisfies the provided range, returns "?".

=== Other notes ===
* Added in LME 3.x.x
** Changed in 3.8.x: Added support for min/max version filtering
* Other API functions, when given mod version "0", use this function to resolve the appropriate version.
* This function prioritizes the latest active version. If none are active, then retrieves latest installed version.
* Both min and max must be provided for version range filtering to apply.
* Unlike most LME functions, "0" is not treated as a placeholder for "latest" within the min/max filter (this function does not call itself).
** To filter from a minimum version without defining a real maximum, first call lib.get_latest(id) to obtain the latest available, to get the current latest, then pass that as max

Vendetta/helium/api

2025-06-05T20:50:18Z

Luxen: /* Async functions */ fixed tween value link text

All API functions for the Helium library are listed below.

== Utility functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Provides functions for operating on iup objects, but don't create iup objects themselves.
|-
! Function !! Description
|-
| [[vendetta/helium/api/map_dialog|map_dialog]] || Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.
|-
| [[vendetta/helium/api/index_container|index_container]] || Iterates over an iup tree and returns the lua table equivilant. Intended for debugging use only.
|-
| [[vendetta/helium/api/iup_prepend|iup_prepend]] || Intended to behave like iup.Append(), but the child is put before instead of after other children
|-
| [[vendetta/helium/api/iup_insert|iup_insert]] || Intended to behave like iup.Append(), but the child can be inserted at an arbitrary location
|-
| [[vendetta/helium/api/is_iup|is_iup]] || Behaves similarly to iup.IsValid(), but only checks if the object is an iup element.
|-
| [[vendetta/helium/api/get_mouse_abs_pos|get_mouse_abs_pos]] || Retrieves the pixel coordinates of the mouse position. Used internally to place subdialogs.
|-
| [[vendetta/helium/api/scale_size|scale_size]] || Using the known scaling value of Font.Default, applies a consistant scale to the provided value
|-
| [[vendetta/helium/api/scale_2x|scale_2x]] || A preset function wrapper around scale_size to provide an iup size attribute's expected format.
|-
| [[vendetta/helium/api/iter_nums_from_string|iter_nums_from_string]] || A function to split numbers from a non-numerically delimited string, returned as a table. When used with an iup size attribute, returns the values {x, y}
|}

== Async functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These are asynchronous variants of the utility functions
|-
! Function !! Description
|-
| [[vendetta/helium/api/async.map_dialog|async map_dialog]] || asynchronous method to map a dialog and execute all embedded map_cb. triggers callback on complete
|-
| [[vendetta/helium/api/async.index_container|async index_container]] || asynchronous method to index an iup container, getting a table representation on callback
|-
| [[vendetta/helium/api/async.prepend|async prepend]] || asynchronous method to add an element to the top of an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.insert|async insert]] || asynchronous method to insert an element in an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.tween_value|tween value]] || Tween from one value to another over time with ease-in-out
|}

== Primitive objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These provide preset singular iup objects for building basic interface objects with more easily.
|-
! Function !! Description
|-
| [[vendetta/helium/api/clearframe|clearframe]] || A frame preset with no image and no border; should be visually invisible.
|-
| [[vendetta/helium/api/solidframe|solidframe]] || A frame preset with a thin border.
|-
| [[vendetta/helium/api/borderframe|borderframe]] || Description
|-
| [[vendetta/helium/api/highlite_panel|highlite_panel]] || An image used internally for 'highlite on mouse hover' behavior.
|-
| [[vendetta/helium/api/page_rule|page rule]] || Inserts a border into the frame similar to an html page rule
|-
| [[vendetta/helium/api/progressbar|progressbar]] || A set of basic preset values for an iup.progressbar
|-
| [[vendetta/helium/api/hslider|hslider]] || A horizontal scroll bar object
|-
| [[vendetta/helium/api/vslider|vslider]] || A vertical scroll bar object
|-
| [[vendetta/helium/api/cyclebutton|cyclebutton]] || A button that changes its contents every press, cycling through indexed options.
|}

== Constructed objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Constructs are functions that create multiple iup objects contained within a frame parent.
|-
! Function !! Description
|-
| [[vendetta/helium/api/hexpandbox|hexpandbox]] || A frame-style object that operates like a horizontal 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vexpandbox|vexpandbox]] || A frame-style object that operates like a vertical 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vscroll|vscroll]] || A frame-style object that allows its contents to be scrolled vertically. This does NOT rely on a 'control' list or iup.matrix
|-
| [[vendetta/helium/api/hscroll|hscroll]] || A frame-style object that allows its contents to be scrolled horizontally. This does NOT rely on an iup.matrix
|-
| [[vendetta/helium/api/ascroll|ascroll]] || A freely controlled viewport area.
|-
| [[vendetta/helium/api/hbuttonlist|hbuttonlist]] || A frame containing a horizontal list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/vbuttonlist|vbuttonlist]] || A frame containing a vertical list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || This hides an invisible button over the child element, providing on-click functionality to non-clickable objects and frames
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || Like a coverbutton, but all attributes are passed to the core button object for more advanced control
|-
| [[vendetta/helium/api/select_text|select_text]] || A preset of coverbutton over a label element
|-
| [[vendetta/helium/api/link_text|link_text]] || A preset of select_text that mimics a hyperlink to open a webpage
|-
| [[vendetta/helium/api/ticker|ticker]] || Two buttons and a field for inputting and editing a numeric entry
|-
| [[vendetta/helium/api/slide_toggle|slide_toggle]] || A "toggle" object that mimics the popular mobile switch style
|-
| [[vendetta/helium/api/multi_button|multi_button]] || A three-button setup; two to navigate left and right through options, and a central button to activate the displayed item
|-
| [[vendetta/helium/api/bg_frame|bg_frame]] || Acts like a background element handler
|-
| [[vendetta/helium/api/shrink_label|shrink_label]] || A text element that automatically handles word-wrapping functionality
|}

== Preset dialogs ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Presets are full dialogs worth of items, with completely custom behaviors and purpose-built uses.
|-
! Function !! Description
|-
| [[vendetta/helium/api/subdialog|subdialog]] || Creates a modal-style dialog that can be positioned on the screen (defaults to center).
|-
| [[vendetta/helium/api/context_menu|context_menu]] || Creates a preset of the subdialog that mimics the behavior of a single-layer context menu.
|-
| [[vendetta/helium/api/alert_dialog|alert box]] || Creates a very simple subdialog at center screen to show the user a single message.
|-
| [[vendetta/helium/api/choice_dialog|choice box]] || Creates a very simple subdialog for prompting the user to make a selection of two options.
|-
| [[vendetta/helium/api/list_dialog|list box]] || Creates a very simple subdialog for prompting the user to make a selection from a list.
|-
| [[vendetta/helium/api/reader_dialog|reader]] || Creates a large subdialog for displaying a large amount of text in a multiline element.
|-
| [[vendetta/helium/api/input_dialog|input box]] || Creates a very simple subdialog for prompting the user to enter a string.
|}

== Drag-and-drop functionality ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy drag and drop functionality.
|-
! Function !! Description
|-
| [[vendetta/helium/api/drag_item|drag_item]] || Creates a transparent field above the target object. this has a drag behavior associated with it. Intended to be paired with a drag_target object.
|-
| [[vendetta/helium/api/drag_target|drag_target]] || Creates a transparent field above the target objects. this has a drop behavior associated with it. Intended to be paired with a drag_item object.
|}

== Color and paint submodule ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy methods to select both RGB and indexed ship colors.
|-
| colspan="2" style="background:#f2f2f2;" | The paint module is currently not implemented; these are features targeting helium v1.1.0
|-
! Function !! Description
|-
| [[vendetta/helium/api/paint_panel|paint_panel]] || Creates a single color thumbnail for ship paint colors.
|-
| [[vendetta/helium/api/color_panel|color_panel]] || Creates a single color thumbnail for RGB color selection.
|-
| [[vendetta/helium/api/paint_select|paint_select]] || A full palette list for user selection. Each vertical column lists a general color, with indexes from light to dark.
|-
| [[vendetta/helium/api/color_select|color_select]] || Contains RGB color finding controls.
|-
| [[vendetta/helium/api/color_picker|color_picker]] || A custom dialog that allows the user to select from a palette list, recent selections, or use a color finder.
|}

== Preset widgets ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | End-result items used for single-function purpose that don't fit in other categories are kept in the widgets table.
|-
| colspan="2" style="background:#f2f2f2;" | The widgets table is currently not implemented; these are features targeting helium v1.1.0
|-
! Function !! Description
|-
| [[vendetta/helium/api/widget.clock|clock]] || A preset clock widget with timezone selection and 12/24 hour display.
|-
| [[vendetta/helium/api/widgets.stopwatch|stopwatch]] || A preset stopwatch widget. action returns either _start or _stop, <time in ms>.
|-
| [[vendetta/helium/api/widgets.numpad|numpad]] || A preset number pad entry widget.
|-
| [[vendetta/helium/api/widgets.marquee_text|marquee_text]] || A preset label display that scrolls its contents. Uses multiple labels to give the semblance of continuous scrolling
|-
| [[vendetta/helium/api/widgets.marquee_obj|marquee_obj]] || A preset display that scrolls its contents. Must be provided with a generator to duplicate displayed contents.
|}

Vendetta/helium/api/scale size

2025-06-05T20:47:19Z

Luxen: created helium.util.scale_size

Using the font default size, which is based on the user's vertical screen height, this function lets a number be scaled up when provided with the original value on the development system.

=== Definition ===
helium.util.scale_size(value_to_change, base_size) -> changed_value

=== Arguments ===
value_to_change: type number: The value that needs to be scaled up
base_size: type number: This is the Font.Default value on the development system. If not provided, 24 is the default.

=== Returns ===
changed_value: type number: the output value after scaling.

=== Notes ===

Vendetta/helium/api/get mouse abs pos

2025-06-05T18:44:39Z

Luxen: created get_mouse_abs_pos

Obtains the pixel coordinates of the user's mouse within the game

=== Definition ===
helium.util.get_mouse_abs_pos(offset_x, offset_y) -> pos_x, pos_y

=== Arguments ===
offset_x: type number: optional offset from actual mouse x position
offset_y: type number: optional offset from actual mouse y position

=== Returns ===
pos_x: type number: x coordinate of mouse (+ x_offset if provided)
pos_y: type number: y coordinate of mouse (+ y_offset if provided)

=== Notes ===
(Not yet implemented): This function will use the last user touch/control press as the mouse coordinates on mobile/VR

Vendetta/helium/api/is iup

2025-06-05T18:38:48Z

Luxen: created helium.util.is_iup

Tests if an element is an iup object. Does not check if the element is a VALID iup object, however. Instead, use iup.IsValid().

=== Definition ===
helium.util.is_iup(ihandle) -> iup_flag

=== Arguments ===
ihandle: type *iup_object: Provide any iup userdata

=== Returns ===
iup_flag: type boolean: true if the item is an iup userdata, false if it is not

=== Notes ===
This function was copied from Draugath before iup.IsValid was discovered, and is kept for posterity.

Vendetta/helium/api/iup insert

2025-06-05T18:14:08Z

Luxen: created helium.util.insert

Intended to behave like iup.Append(), but the child is put within an arbitrary location instead of after other children.

=== Definition ===
helium.util.iup_insert(root_ihandle, child_ihandle, position) -> nil

=== Arguments ===
root_ihandle: type *iup_object: dialog or other iup element item to add the child into.
child_ihandle: type *iup_object: iup element item to be inserted at top of the root object's stack.
position: type number: index of target placement of the child.

=== Notes ===
* In order to insert elements, this function iterates and detaches all existing items before adding the new element, and then re-attaches all the other elements in order. As such, extremely large iup structures may be expensive to insert items into; if inserting elements into a long list of items, consider using the asynchronous version of this function to retain client functionality.
* Similar to table.insert, positive numbers index from the start of the iup children list, while negative numbers index from the end of the list. If an item is out of bounds, it is inserted at the relevant end of the list.

Vendetta/helium/api

2025-06-05T18:10:46Z

Luxen: noted paint and widgets modules for being unimplemented currently

All API functions for the Helium library are listed below.

== Utility functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Provides functions for operating on iup objects, but don't create iup objects themselves.
|-
! Function !! Description
|-
| [[vendetta/helium/api/map_dialog|map_dialog]] || Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.
|-
| [[vendetta/helium/api/index_container|index_container]] || Iterates over an iup tree and returns the lua table equivilant. Intended for debugging use only.
|-
| [[vendetta/helium/api/iup_prepend|iup_prepend]] || Intended to behave like iup.Append(), but the child is put before instead of after other children
|-
| [[vendetta/helium/api/iup_insert|iup_insert]] || Intended to behave like iup.Append(), but the child can be inserted at an arbitrary location
|-
| [[vendetta/helium/api/is_iup|is_iup]] || Behaves similarly to iup.IsValid(), but only checks if the object is an iup element.
|-
| [[vendetta/helium/api/get_mouse_abs_pos|get_mouse_abs_pos]] || Retrieves the pixel coordinates of the mouse position. Used internally to place subdialogs.
|-
| [[vendetta/helium/api/scale_size|scale_size]] || Using the known scaling value of Font.Default, applies a consistant scale to the provided value
|-
| [[vendetta/helium/api/scale_2x|scale_2x]] || A preset function wrapper around scale_size to provide an iup size attribute's expected format.
|-
| [[vendetta/helium/api/iter_nums_from_string|iter_nums_from_string]] || A function to split numbers from a non-numerically delimited string, returned as a table. When used with an iup size attribute, returns the values {x, y}
|}

== Async functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These are asynchronous variants of the utility functions
|-
! Function !! Description
|-
| [[vendetta/helium/api/async.map_dialog|async map_dialog]] || asynchronous method to map a dialog and execute all embedded map_cb. triggers callback on complete
|-
| [[vendetta/helium/api/async.index_container|async index_container]] || asynchronous method to index an iup container, getting a table representation on callback
|-
| [[vendetta/helium/api/async.prepend|async prepend]] || asynchronous method to add an element to the top of an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.insert|async insert]] || asynchronous method to insert an element in an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.tween_value]] || Tween from one value to another over time with ease-in-out
|}

== Primitive objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These provide preset singular iup objects for building basic interface objects with more easily.
|-
! Function !! Description
|-
| [[vendetta/helium/api/clearframe|clearframe]] || A frame preset with no image and no border; should be visually invisible.
|-
| [[vendetta/helium/api/solidframe|solidframe]] || A frame preset with a thin border.
|-
| [[vendetta/helium/api/borderframe|borderframe]] || Description
|-
| [[vendetta/helium/api/highlite_panel|highlite_panel]] || An image used internally for 'highlite on mouse hover' behavior.
|-
| [[vendetta/helium/api/page_rule|page rule]] || Inserts a border into the frame similar to an html page rule
|-
| [[vendetta/helium/api/progressbar|progressbar]] || A set of basic preset values for an iup.progressbar
|-
| [[vendetta/helium/api/hslider|hslider]] || A horizontal scroll bar object
|-
| [[vendetta/helium/api/vslider|vslider]] || A vertical scroll bar object
|-
| [[vendetta/helium/api/cyclebutton|cyclebutton]] || A button that changes its contents every press, cycling through indexed options.
|}

== Constructed objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Constructs are functions that create multiple iup objects contained within a frame parent.
|-
! Function !! Description
|-
| [[vendetta/helium/api/hexpandbox|hexpandbox]] || A frame-style object that operates like a horizontal 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vexpandbox|vexpandbox]] || A frame-style object that operates like a vertical 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vscroll|vscroll]] || A frame-style object that allows its contents to be scrolled vertically. This does NOT rely on a 'control' list or iup.matrix
|-
| [[vendetta/helium/api/hscroll|hscroll]] || A frame-style object that allows its contents to be scrolled horizontally. This does NOT rely on an iup.matrix
|-
| [[vendetta/helium/api/ascroll|ascroll]] || A freely controlled viewport area.
|-
| [[vendetta/helium/api/hbuttonlist|hbuttonlist]] || A frame containing a horizontal list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/vbuttonlist|vbuttonlist]] || A frame containing a vertical list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || This hides an invisible button over the child element, providing on-click functionality to non-clickable objects and frames
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || Like a coverbutton, but all attributes are passed to the core button object for more advanced control
|-
| [[vendetta/helium/api/select_text|select_text]] || A preset of coverbutton over a label element
|-
| [[vendetta/helium/api/link_text|link_text]] || A preset of select_text that mimics a hyperlink to open a webpage
|-
| [[vendetta/helium/api/ticker|ticker]] || Two buttons and a field for inputting and editing a numeric entry
|-
| [[vendetta/helium/api/slide_toggle|slide_toggle]] || A "toggle" object that mimics the popular mobile switch style
|-
| [[vendetta/helium/api/multi_button|multi_button]] || A three-button setup; two to navigate left and right through options, and a central button to activate the displayed item
|-
| [[vendetta/helium/api/bg_frame|bg_frame]] || Acts like a background element handler
|-
| [[vendetta/helium/api/shrink_label|shrink_label]] || A text element that automatically handles word-wrapping functionality
|}

== Preset dialogs ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Presets are full dialogs worth of items, with completely custom behaviors and purpose-built uses.
|-
! Function !! Description
|-
| [[vendetta/helium/api/subdialog|subdialog]] || Creates a modal-style dialog that can be positioned on the screen (defaults to center).
|-
| [[vendetta/helium/api/context_menu|context_menu]] || Creates a preset of the subdialog that mimics the behavior of a single-layer context menu.
|-
| [[vendetta/helium/api/alert_dialog|alert box]] || Creates a very simple subdialog at center screen to show the user a single message.
|-
| [[vendetta/helium/api/choice_dialog|choice box]] || Creates a very simple subdialog for prompting the user to make a selection of two options.
|-
| [[vendetta/helium/api/list_dialog|list box]] || Creates a very simple subdialog for prompting the user to make a selection from a list.
|-
| [[vendetta/helium/api/reader_dialog|reader]] || Creates a large subdialog for displaying a large amount of text in a multiline element.
|-
| [[vendetta/helium/api/input_dialog|input box]] || Creates a very simple subdialog for prompting the user to enter a string.
|}

== Drag-and-drop functionality ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy drag and drop functionality.
|-
! Function !! Description
|-
| [[vendetta/helium/api/drag_item|drag_item]] || Creates a transparent field above the target object. this has a drag behavior associated with it. Intended to be paired with a drag_target object.
|-
| [[vendetta/helium/api/drag_target|drag_target]] || Creates a transparent field above the target objects. this has a drop behavior associated with it. Intended to be paired with a drag_item object.
|}

== Color and paint submodule ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy methods to select both RGB and indexed ship colors.
|-
| colspan="2" style="background:#f2f2f2;" | The paint module is currently not implemented; these are features targeting helium v1.1.0
|-
! Function !! Description
|-
| [[vendetta/helium/api/paint_panel|paint_panel]] || Creates a single color thumbnail for ship paint colors.
|-
| [[vendetta/helium/api/color_panel|color_panel]] || Creates a single color thumbnail for RGB color selection.
|-
| [[vendetta/helium/api/paint_select|paint_select]] || A full palette list for user selection. Each vertical column lists a general color, with indexes from light to dark.
|-
| [[vendetta/helium/api/color_select|color_select]] || Contains RGB color finding controls.
|-
| [[vendetta/helium/api/color_picker|color_picker]] || A custom dialog that allows the user to select from a palette list, recent selections, or use a color finder.
|}

== Preset widgets ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | End-result items used for single-function purpose that don't fit in other categories are kept in the widgets table.
|-
| colspan="2" style="background:#f2f2f2;" | The widgets table is currently not implemented; these are features targeting helium v1.1.0
|-
! Function !! Description
|-
| [[vendetta/helium/api/widget.clock|clock]] || A preset clock widget with timezone selection and 12/24 hour display.
|-
| [[vendetta/helium/api/widgets.stopwatch|stopwatch]] || A preset stopwatch widget. action returns either _start or _stop, <time in ms>.
|-
| [[vendetta/helium/api/widgets.numpad|numpad]] || A preset number pad entry widget.
|-
| [[vendetta/helium/api/widgets.marquee_text|marquee_text]] || A preset label display that scrolls its contents. Uses multiple labels to give the semblance of continuous scrolling
|-
| [[vendetta/helium/api/widgets.marquee_obj|marquee_obj]] || A preset display that scrolls its contents. Must be provided with a generator to duplicate displayed contents.
|}

Vendetta/helium/api

2025-06-05T00:52:51Z

Luxen: partially updated to cover v1.0.0 release API

All API functions for the Helium library are listed below.

== Utility functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Provides functions for operating on iup objects, but don't create iup objects themselves.
|-
! Function !! Description
|-
| [[vendetta/helium/api/map_dialog|map_dialog]] || Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.
|-
| [[vendetta/helium/api/index_container|index_container]] || Iterates over an iup tree and returns the lua table equivilant. Intended for debugging use only.
|-
| [[vendetta/helium/api/iup_prepend|iup_prepend]] || Intended to behave like iup.Append(), but the child is put before instead of after other children
|-
| [[vendetta/helium/api/iup_insert|iup_insert]] || Intended to behave like iup.Append(), but the child can be inserted at an arbitrary location
|-
| [[vendetta/helium/api/is_iup|is_iup]] || Behaves similarly to iup.IsValid(), but only checks if the object is an iup element.
|-
| [[vendetta/helium/api/get_mouse_abs_pos|get_mouse_abs_pos]] || Retrieves the pixel coordinates of the mouse position. Used internally to place subdialogs.
|-
| [[vendetta/helium/api/scale_size|scale_size]] || Using the known scaling value of Font.Default, applies a consistant scale to the provided value
|-
| [[vendetta/helium/api/scale_2x|scale_2x]] || A preset function wrapper around scale_size to provide an iup size attribute's expected format.
|-
| [[vendetta/helium/api/iter_nums_from_string|iter_nums_from_string]] || A function to split numbers from a non-numerically delimited string, returned as a table. When used with an iup size attribute, returns the values {x, y}
|}

== Async functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These are asynchronous variants of the utility functions
|-
! Function !! Description
|-
| [[vendetta/helium/api/async.map_dialog|async map_dialog]] || asynchronous method to map a dialog and execute all embedded map_cb. triggers callback on complete
|-
| [[vendetta/helium/api/async.index_container|async index_container]] || asynchronous method to index an iup container, getting a table representation on callback
|-
| [[vendetta/helium/api/async.prepend|async prepend]] || asynchronous method to add an element to the top of an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.insert|async insert]] || asynchronous method to insert an element in an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.tween_value]] || Tween from one value to another over time with ease-in-out
|}

== Primitive objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These provide preset singular iup objects for building basic interface objects with more easily.
|-
! Function !! Description
|-
| [[vendetta/helium/api/clearframe|clearframe]] || A frame preset with no image and no border; should be visually invisible.
|-
| [[vendetta/helium/api/solidframe|solidframe]] || A frame preset with a thin border.
|-
| [[vendetta/helium/api/borderframe|borderframe]] || Description
|-
| [[vendetta/helium/api/highlite_panel|highlite_panel]] || An image used internally for 'highlite on mouse hover' behavior.
|-
| [[vendetta/helium/api/page_rule|page rule]] || Inserts a border into the frame similar to an html page rule
|-
| [[vendetta/helium/api/progressbar|progressbar]] || A set of basic preset values for an iup.progressbar
|-
| [[vendetta/helium/api/hslider|hslider]] || A horizontal scroll bar object
|-
| [[vendetta/helium/api/vslider|vslider]] || A vertical scroll bar object
|-
| [[vendetta/helium/api/cyclebutton|cyclebutton]] || A button that changes its contents every press, cycling through indexed options.
|}

== Constructed objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Constructs are functions that create multiple iup objects contained within a frame parent.
|-
! Function !! Description
|-
| [[vendetta/helium/api/hexpandbox|hexpandbox]] || A frame-style object that operates like a horizontal 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vexpandbox|vexpandbox]] || A frame-style object that operates like a vertical 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vscroll|vscroll]] || A frame-style object that allows its contents to be scrolled vertically. This does NOT rely on a 'control' list or iup.matrix
|-
| [[vendetta/helium/api/hscroll|hscroll]] || A frame-style object that allows its contents to be scrolled horizontally. This does NOT rely on an iup.matrix
|-
| [[vendetta/helium/api/ascroll|ascroll]] || A freely controlled viewport area.
|-
| [[vendetta/helium/api/hbuttonlist|hbuttonlist]] || A frame containing a horizontal list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/vbuttonlist|vbuttonlist]] || A frame containing a vertical list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || This hides an invisible button over the child element, providing on-click functionality to non-clickable objects and frames
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || Like a coverbutton, but all attributes are passed to the core button object for more advanced control
|-
| [[vendetta/helium/api/select_text|select_text]] || A preset of coverbutton over a label element
|-
| [[vendetta/helium/api/link_text|link_text]] || A preset of select_text that mimics a hyperlink to open a webpage
|-
| [[vendetta/helium/api/ticker|ticker]] || Two buttons and a field for inputting and editing a numeric entry
|-
| [[vendetta/helium/api/slide_toggle|slide_toggle]] || A "toggle" object that mimics the popular mobile switch style
|-
| [[vendetta/helium/api/multi_button|multi_button]] || A three-button setup; two to navigate left and right through options, and a central button to activate the displayed item
|-
| [[vendetta/helium/api/bg_frame|bg_frame]] || Acts like a background element handler
|-
| [[vendetta/helium/api/shrink_label|shrink_label]] || A text element that automatically handles word-wrapping functionality
|}

== Preset dialogs ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Presets are full dialogs worth of items, with completely custom behaviors and purpose-built uses.
|-
! Function !! Description
|-
| [[vendetta/helium/api/subdialog|subdialog]] || Creates a modal-style dialog that can be positioned on the screen (defaults to center).
|-
| [[vendetta/helium/api/context_menu|context_menu]] || Creates a preset of the subdialog that mimics the behavior of a single-layer context menu.
|-
| [[vendetta/helium/api/alert_dialog|alert box]] || Creates a very simple subdialog at center screen to show the user a single message.
|-
| [[vendetta/helium/api/choice_dialog|choice box]] || Creates a very simple subdialog for prompting the user to make a selection of two options.
|-
| [[vendetta/helium/api/list_dialog|list box]] || Creates a very simple subdialog for prompting the user to make a selection from a list.
|-
| [[vendetta/helium/api/reader_dialog|reader]] || Creates a large subdialog for displaying a large amount of text in a multiline element.
|-
| [[vendetta/helium/api/input_dialog|input box]] || Creates a very simple subdialog for prompting the user to enter a string.
|}

== Drag-and-drop functionality ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy drag and drop functionality.
|-
! Function !! Description
|-
| [[vendetta/helium/api/drag_item|drag_item]] || Creates a transparent field above the target object. this has a drag behavior associated with it. Intended to be paired with a drag_target object.
|-
| [[vendetta/helium/api/drag_target|drag_target]] || Creates a transparent field above the target objects. this has a drop behavior associated with it. Intended to be paired with a drag_item object.
|}

== Color and paint submodule ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy methods to select both RGB and indexed ship colors.
|-
! Function !! Description
|-
| [[vendetta/helium/api/paint_panel|paint_panel]] || Creates a single color thumbnail for ship paint colors.
|-
| [[vendetta/helium/api/color_panel|color_panel]] || Creates a single color thumbnail for RGB color selection.
|-
| [[vendetta/helium/api/paint_select|paint_select]] || A full palette list for user selection. Each vertical column lists a general color, with indexes from light to dark.
|-
| [[vendetta/helium/api/color_select|color_select]] || Contains RGB color finding controls.
|-
| [[vendetta/helium/api/color_picker|color_picker]] || A custom dialog that allows the user to select from a palette list, recent selections, or use a color finder.
|}

== Preset widgets ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | End-result items used for single-function purpose that don't fit in other categories are kept in the widgets table.
|-
! Function !! Description
|-
| [[vendetta/helium/api/widget.clock|clock]] || A preset clock widget with timezone selection and 12/24 hour display.
|-
| [[vendetta/helium/api/widgets.stopwatch|stopwatch]] || A preset stopwatch widget. action returns either _start or _stop, <time in ms>.
|-
| [[vendetta/helium/api/widgets.numpad|numpad]] || A preset number pad entry widget.
|-
| [[vendetta/helium/api/widgets.marquee_text|marquee_text]] || A preset label display that scrolls its contents. Uses multiple labels to give the semblance of continuous scrolling
|-
| [[vendetta/helium/api/widgets.marquee_obj|marquee_obj]] || A preset display that scrolls its contents. Must be provided with a generator to duplicate displayed contents.
|}

Vendetta/neoloader

2025-05-13T01:32:37Z

Luxen: updated versions listed with recent maintenance update

[[image:Vendetta-Neobanner.jpg]]
== ==
'''<big><big>Neoloader Pre-execution Library Management Engine (NPLME) is a toolkit for loading and managing mods in Vendetta Online and improving functional usage between them.</big></big>'''

== For users ==
Neoloader is an advanced mod loader for Vendetta Online that sits on top of the existing mod loader. The goal of the Neoloader is to allow in-game management of Vendetta Online's plugins as much as the game engine can allow, and to facilitate a standard through which plugins can communicate with each other.

'''Features:'''
* Load plugins in order of dependencies and registration, instead of alphabetically
* Minimize risk of game crashes during the loading stage by safety-netting the loading process
* Provide management of plugins in-game
* Easy installation and removal of the system, and a guided recovery system in case of failure
* An extensive API to promote mod intercommunication and extensibility

Neoloader can be downloaded from the following locations:
{| border="1"
! Location
! Version
! Notes
|-
| '''[https://www.nexusmods.com/vendettaonline/mods/3 NexusMods]'''
| 6.2.0 (LME 3.11.0)
| This is the preferred location for stable versions of Neoloader
|-
| '''[https://voupr.spenced.com/plugin.php?name=neoloader VOUPR]'''
| 6.2.0 (LME 3.11.0)
|
|-
| '''[https://github.com/LuxenDM/Neoloader Github]'''
| 6.2.0 (LME 3.11.0)
| Development versions may be available here
|}

The current version with public support is 6.2.0 providing LME API 3.11.0; the minimum version that will be supported is 6.1.1 providing LME API 3.11.0

Neoloader comes bundled with a few utilities used to interact with the software and manage its settings. These include
* The [[vendetta/neoloader/neomgr|lightweight management interface, neomgr]]
* The [[vendetta/neoloader/neonotif|notification control system, neonotif]]
* A [[vendetta/neoloader/recovery|recovery console]] for plugin errors

To manage non-LME mods, use a tool such as [https://www.nexusmods.com/vendettaonline/mods/2 Neopatcher] to convert mods to a hybrid model capable of being seen and managed by Neoloader.

== For modders ==
* [[vendetta/overview|Developer's overview]] <br />
* [[vendetta/design|Creating or converting a plugin for the LME]] <br />
* [[vendetta/registration|INI registration details]] <br />
* [[vendetta/API|LME API for developers]] <br />

Fate/instruct API

2025-04-17T03:40:17Z

Luxen: /* What is the instruct file */ added link to Nexus, because figuring out file sharing is too annoying to do locally

== What is the instruct file ==
Every FPX mod requires a patch.json file in its root directory, which defines the mod and contains the instructions on how to apply it. It does follow [https://www.json.org/json-en.html normal JSON formatting standards]. This json file is the 'instruct' file, as it literally instructs the Fate Patcher in how to apply files. An "empty" mod to use as a starting template can be downloaded [https://www.nexusmods.com/fate/mods/21?tab=files from the optional files section on the NexusMods mirror].

== General data ==
The instruct file will generally start with the following information. Only the bold entries are required; the rest are optional, but will be useful for users managing their mods with the GUI front-end eventually distributed with FPX. Unless otherwise mentioned, assume all elements are strings.

{|border="1"
| '''name''' || Name of your mod
|-
| '''version''' || Version of your mod. Supports advanced versioning*
|-
| author || Primary mod author or team name
|-
| web || URL to be opened if the user is checking for updates
|-
| description || Describe the mod in a sentence or two
|-
| contributors || List of individual contributors/authors, if multiple.
|}

Following these informational elements, you provide the actual 'instructive' content that defines how your mod is set up. This content includes one or more of six possible 'operations'. Below lists each possible operation. Where a ellipses (…) occurs in the script file, is where something (can) continue/repeat in the given sequence.

=== Index operations ===
Index operations are key/value pairs that "index" a file under a given name, making it patchable. Most OG *.dat files are indexed by default.
<syntaxhighlight lang="json" line>
"index": {
"INDEX_NAME": "Path/to/file in the FATE game directory",
...repeat for every index being added
},
</syntaxhighlight>

=== Copy operations ===
Given a folder destination and a series of files, the Copy operation copies those files into the destination. This is used to provide assets which are referenced by patch data.
<syntaxhighlight lang="json" line>
"copy": [
{
"folder": "Path/to/file in the FATE game directory",
"content": [
"path/to/file from your mod folder, to your asset being deployed",
...repeat per asset being deployed to the destination
],
},
...repeat the {} per destination folder
],
</syntaxhighlight>

=== Patch operations ===
Given a valid index, the Patch operation adds new file contents to the end of the original indexed file, in effect adding new content to the game.
<syntaxhighlight lang="json" line>
"patch": [
{
"container": "valid index name",
"content": [
"path/to/file from your mod folder, to your text file containing the data to append",
...
],
},
...repeat the {} per index being patched
],
</syntaxhighlight>

=== Sequence operations ===
Sequence operations are similar to a copy operation, but allows the file name to be sequentially generated at deployment. This will mostly only be used when adding new music to the game.
<syntaxhighlight lang="json" line>
"sequence": [
{
"folder": "Path/to/file in the FATE game directory",
"file": "destination file name",
"content": [
"path/to/file from your mod folder, to your asset being deployed",
...
],
},
...repeat the {} per destination folder and/or file
],
</syntaxhighlight>

=== Filter operations ===
The most powerful yet complex operation, Filters are when you attach a lua file to a given index. This is executed at the end of mod deployment. Refer to the filter script lua API.
<syntaxhighlight lang="json" line>
"script": [
{
"container": "valid index",
"file": "path/to/file.lua from your mod directory",
},
...repeat {} per index and/or filter script to apply
],
</syntaxhighlight>
''note'': Filter scripts may execute lua direclty, but they are limited within a sandbox for security purposes. They can only write directly to the file they are operating on, and can only see your game and your mod files only.

=== Override operations ===
Override operations tell FPX to NOT grab the master copy of a file during the patch process. This is useful if you have overwritten a file that is usually indexed and exists within the base game.
<syntaxhighlight lang="json" line>
"override": [
"valid index name",
...repeat for every overridden indexes
],
</syntaxhighlight>

== Example instruct file ==
This is part of the instruct file for the Dungeonology expansion, a mod that adds multiple assets across the entire game.

<syntaxhighlight lang="json" line>
{
"name": "Dungeonology Expansion",
"version": "1.0.0",
"author": "Luxen De'Mark",
"web": "https://www.nexusmods.com/fate/mods/20",
"description": "A massive dungeon expansion to FATE",
"index": {
"TEMPLATES_MASTER": "TEMPLATES\\manifest.dat",
},
"sequence": [
{
"folder": "MUSIC",
"file": "dungeon?.ogg",
"content": [
"Music\\imposing.ogg",
"Music\\unsettled house.ogg",
"Music\\Fog under the second street light.ogg",
"Music\\Aquarinonu.ogg",
"Music\\Apocalypse.ogg",
],
},
{
"folder": "MUSIC",
"file": "town?.ogg",
"content": [
"Music\\Green-fields.ogg",
"Music\\Pho Magic.ogg",
"Music\\Wild waters in the woods.ogg",
],
},
],
"copy": [
{
"folder": "SOUNDS",
"content": [
"Props\\ice_crystal\\crystal_ting.wav",
],
},
{
"folder": "PROPS",
"content": [
"Props\\lush_leaf\\lushleaf_obj.MDL",
"Props\\lush_leaf\\lushleaf_alpha.png",
"Props\\lush_leaf\\lushleaf_color.png",
],
},
{
"folder": "ICONS",
"content": [
"Items\\Windlass\\windlass_alpha.png",
"Items\\Windlass\\windlass_color.png",
],
},
{
"folder": "ITEMS",
"content": [
"Items\\Windlass\\windlass_obj.mdl",
"Items\\Windlass\\windlass_obj_color.png",
"Items\\Windlass\\windlass_obj_ref.png",
],
},
],
"patch": [
{
"container": "ITEMS_US",
"content": [
"Items\\Spellbooks\\spellbook_items.txt",
"Items\\Gems\\Amber.txt",
"Items\\Compass\\compass_item.txt",
"Items\\Totem Rod\\totem_rod.txt",
"Items\\Bamboo Rod\\bamboo_rod.txt",
],
},
{
"container": "TEMPLATES_MASTER",
"content": [
"Dungeons\\manifest_patch.txt",
],
},
],
}
</syntaxhighlight>

== Additional notes ==
* File paths must use a double-backslash. A single backslash is used as an [https://en.wikipedia.org/wiki/Escape_character escape character] in lua, which FPX is written in.

Firefly/ff engine

2025-04-06T17:28:32Z

Luxen: Added a few actions

= Firefly engine =
[[image:ff_engine_icon.png|left|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
<br />

== Properties ==
todo:
* show examples to the right or underneath each sub-section as necessary?
* Better define what each individual option does, and specify what 'index' it is if set through an action

=== Start engine at start ===
This is a toggle that controls whether the Firefly engine itself will initialize immediately when the frame starts. If you have to configure certain engine settings, or manipulate the engine such as resizing the engine frame, then this should be toggled off, and use an action to trigger the engine to start when you are ready.

=== Device Driver ===
Allows you to select the rendering pipeline Firefly will run with. The available options and limitations of each are labeled below:
{|border="1"
! Index
! Driver
! Description
|-
| 0 || Software || A very primitive rendering pipeline on the CPU with no support for shaders, lighting, and does not render any vertices outside of the camera's field of view. Available as a last-available-option renderer.
|-
| 1 || Software2 || A performance-poor rendering pipeline on the CPU with no support for shaders or lighting. Use only if DirectX or OpennGL are not available.
|-
| 2 || Direct3D8|| Does not load at all - possibly because Irrlicht (the 3d engine firefly is based on) dropped support for this pipeline?
|-
| 3 || Direct3D9 || Uses the DirectX standard pipeline for rendering on the GPU. Does not support the engine's lighting, but supports HLSL shaders and has good performance.
|-
| 4 || OpenGL || Uses the OpenGL standard pipeline for rendering on the GPU. Shaders do not have correct vertex information (Needs verification) but supports engine lighting and has good performance.
|}

=== Anti Alias ===
Controls how much anti-aliasing the engine uses globally. Antialiasing is a software technique for diminishing jagged edges that occur on objects not aligned with the pixels of a display - stairstep-like lines that should be smooth. These jagged edges occur because the monitor doesn't have a high enough resolution to represent a smooth line. Antialiasing reduces the prominence of these jagged edges by surrounding the stairsteps with intermediate shades of color. Although this reduces the jagged appearance of the lines, it also makes them blurry. You can decide whether the effect is off, x2, x4, x6 or x8.

=== Background color ===
This RGB selection controls the color for empty space regions in the final rendered image of the 3D environment.

=== Ambient Light Color ===
This RGB selection controls the global light source color. Set to full white to make everything in the scene fully lit. This is ignored in DirectX mode, where light sources are not functional.

=== Render speed ===
This percentage controls (effectively) the balance between the fusion engine and the firefly engine. If Fusion is running at 60fps, setting this to 50 will make Firefly run at 30fps. Firefly can "eat" control input when used with certain other objects on screen during a frame update, so adjusting this to near-zero or setting to completely zero when off screen can help minimize or prevent this issue.

=== Travel Distance ===
...to do.

=== Fog color ===
Materials that have fog rendering enabled will fade out based on the object distance and the fog start/end values. This is the color they will fade out to.

=== Fog start distance ===
this controls how many units of space before world fog starts to be rendered on supported materials.

=== Fog end distance ===
This controls how many units of space before world fog is rendered at 100% opacity on supported materials.

=== Cast Shadows toggle ===
...to do. Requires OpenGL and in-engine lighting nodes.

=== Shadow color ===
This RGB selection controls the color of the shadows that are rendered.

== Actions ==

=== Start Engine ===
Start the rendering engine with its current settings.

=== Stop Engine ===
Stop the rendering engine so you can change settings.

=== Set Engine Resolution ===
Sets the internal resolution of the rendering engine.
* This should be set to match the size of the object, or certain rendering functionality may behave incorrectly (example: drawing 3d lines)
* This action has no effect if the engine is running (verify)

=== Engine Setup ===
These options control the rendering pipeline and cannot be used while the engine is running.

==== Device Driver ====
Sets the rendering pipeline to be used by the firefly object. If using the 'set' dialog option instead of a predefined selection, index starts at zero. See "Device Driver" properties above (todo: bookmark links to scroll page for user)

==== Anti Alias ====
Sets the global anti-aliasing level to be used by the engine. If using the 'set' dialog option instead of a predefined selection, index starts at zero.

* Set Engine Background Color
* Set Engine Fog Color
* Set Fog Start Distance
* Set Fog End Distance
* Load Resource Package
* Collisions
** Set required travel distance
** Manually detect collisions
** Scene collisions
* On Draw
** Render to texture
** Draw 3D Line
** Draw 3D Triangle
** Draw 3D Box
** Draw Pixel
** Draw Texture

== Conditions ==
list - show conditions and define what triggers them

== Expressions ==
list - show expressions and what they define

== Additional notes ==
details on functionality and limitations

Firefly/ff engine

2025-03-27T00:06:32Z

Luxen: /* Device Driver */ Added action selection index to table

= Firefly engine =
[[image:ff_engine_icon.png|left|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
<br />

== Properties ==
todo:
* show examples to the right or underneath each sub-section as necessary?
* Better define what each individual option does, and specify what 'index' it is if set through an action

=== Start engine at start ===
This is a toggle that controls whether the Firefly engine itself will initialize immediately when the frame starts. If you have to configure certain engine settings, or manipulate the engine such as resizing the engine frame, then this should be toggled off, and use an action to trigger the engine to start when you are ready.

=== Device Driver ===
Allows you to select the rendering pipeline Firefly will run with. The available options and limitations of each are labeled below:
{|border="1"
! Index
! Driver
! Description
|-
| 0 || Software || A very primitive rendering pipeline on the CPU with no support for shaders, lighting, and does not render any vertices outside of the camera's field of view. Available as a last-available-option renderer.
|-
| 1 || Software2 || A performance-poor rendering pipeline on the CPU with no support for shaders or lighting. Use only if DirectX or OpennGL are not available.
|-
| 2 || Direct3D8|| Does not load at all - possibly because Irrlicht (the 3d engine firefly is based on) dropped support for this pipeline?
|-
| 3 || Direct3D9 || Uses the DirectX standard pipeline for rendering on the GPU. Does not support the engine's lighting, but supports HLSL shaders and has good performance.
|-
| 4 || OpenGL || Uses the OpenGL standard pipeline for rendering on the GPU. Shaders do not have correct vertex information (Needs verification) but supports engine lighting and has good performance.
|}

=== Anti Alias ===
Controls how much anti-aliasing the engine uses globally. Antialiasing is a software technique for diminishing jagged edges that occur on objects not aligned with the pixels of a display - stairstep-like lines that should be smooth. These jagged edges occur because the monitor doesn't have a high enough resolution to represent a smooth line. Antialiasing reduces the prominence of these jagged edges by surrounding the stairsteps with intermediate shades of color. Although this reduces the jagged appearance of the lines, it also makes them blurry. You can decide whether the effect is off, x2, x4, x6 or x8.

=== Background color ===
This RGB selection controls the color for empty space regions in the final rendered image of the 3D environment.

=== Ambient Light Color ===
This RGB selection controls the global light source color. Set to full white to make everything in the scene fully lit. This is ignored in DirectX mode, where light sources are not functional.

=== Render speed ===
This percentage controls (effectively) the balance between the fusion engine and the firefly engine. If Fusion is running at 60fps, setting this to 50 will make Firefly run at 30fps. Firefly can "eat" control input when used with certain other objects on screen during a frame update, so adjusting this to near-zero or setting to completely zero when off screen can help minimize or prevent this issue.

=== Travel Distance ===
...to do.

=== Fog color ===
Materials that have fog rendering enabled will fade out based on the object distance and the fog start/end values. This is the color they will fade out to.

=== Fog start distance ===
this controls how many units of space before world fog starts to be rendered on supported materials.

=== Fog end distance ===
This controls how many units of space before world fog is rendered at 100% opacity on supported materials.

=== Cast Shadows toggle ===
...to do. Requires OpenGL and in-engine lighting nodes.

=== Shadow color ===
This RGB selection controls the color of the shadows that are rendered.

== Actions ==
* Start Engine
* Stop Engine
* Set Engine Resolution
* Engine Setup
** Device Driver
** Anti Aliasing
* Set Engine Background Color
* Set Engine Fog Color
* Set Fog Start Distance
* Set Fog End Distance
* Load Resource Package
* Collisions
** Set required travel distance
** Manually detect collisions
** Scene collisions
* On Draw
** Render to texture
** Draw 3D Line
** Draw 3D Triangle
** Draw 3D Box
** Draw Pixel
** Draw Texture

== Conditions ==
list - show conditions and define what triggers them

== Expressions ==
list - show expressions and what they define

== Additional notes ==
details on functionality and limitations

Firefly/ff engine

2025-03-27T00:05:13Z

Luxen: /* Properties */ Reformatted page to use subsections instead of lists (can now be navigated), and added additional information present in the outdated clickteam online documentation.

= Firefly engine =
[[image:ff_engine_icon.png|left|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
<br />

== Properties ==
todo:
* show examples to the right or underneath each sub-section as necessary?
* Better define what each individual option does, and specify what 'index' it is if set through an action

=== Start engine at start ===
This is a toggle that controls whether the Firefly engine itself will initialize immediately when the frame starts. If you have to configure certain engine settings, or manipulate the engine such as resizing the engine frame, then this should be toggled off, and use an action to trigger the engine to start when you are ready.

=== Device Driver ===
Allows you to select the rendering pipeline Firefly will run with. The available options and limitations of each are labeled below:
{|border="1"
! Driver || Description
|-
| Software || A very primitive rendering pipeline on the CPU with no support for shaders, lighting, and does not render any vertices outside of the camera's field of view. Available as a last-available-option renderer.
|-
| Software2 || A performance-poor rendering pipeline on the CPU with no support for shaders or lighting. Use only if DirectX or OpennGL are not available.
|-
| Direct3D8|| Does not load at all - possibly because Irrlicht (the 3d engine firefly is based on) dropped support for this pipeline?
|-
| Direct3D9 || Uses the DirectX standard pipeline for rendering on the GPU. Does not support the engine's lighting, but supports HLSL shaders and has good performance.
|-
| OpenGL || Uses the OpenGL standard pipeline for rendering on the GPU. Shaders do not have correct vertex information (Needs verification) but supports engine lighting and has good performance.
|}

=== Anti Alias ===
Controls how much anti-aliasing the engine uses globally. Antialiasing is a software technique for diminishing jagged edges that occur on objects not aligned with the pixels of a display - stairstep-like lines that should be smooth. These jagged edges occur because the monitor doesn't have a high enough resolution to represent a smooth line. Antialiasing reduces the prominence of these jagged edges by surrounding the stairsteps with intermediate shades of color. Although this reduces the jagged appearance of the lines, it also makes them blurry. You can decide whether the effect is off, x2, x4, x6 or x8.

=== Background color ===
This RGB selection controls the color for empty space regions in the final rendered image of the 3D environment.

=== Ambient Light Color ===
This RGB selection controls the global light source color. Set to full white to make everything in the scene fully lit. This is ignored in DirectX mode, where light sources are not functional.

=== Render speed ===
This percentage controls (effectively) the balance between the fusion engine and the firefly engine. If Fusion is running at 60fps, setting this to 50 will make Firefly run at 30fps. Firefly can "eat" control input when used with certain other objects on screen during a frame update, so adjusting this to near-zero or setting to completely zero when off screen can help minimize or prevent this issue.

=== Travel Distance ===
...to do.

=== Fog color ===
Materials that have fog rendering enabled will fade out based on the object distance and the fog start/end values. This is the color they will fade out to.

=== Fog start distance ===
this controls how many units of space before world fog starts to be rendered on supported materials.

=== Fog end distance ===
This controls how many units of space before world fog is rendered at 100% opacity on supported materials.

=== Cast Shadows toggle ===
...to do. Requires OpenGL and in-engine lighting nodes.

=== Shadow color ===
This RGB selection controls the color of the shadows that are rendered.

== Actions ==
* Start Engine
* Stop Engine
* Set Engine Resolution
* Engine Setup
** Device Driver
** Anti Aliasing
* Set Engine Background Color
* Set Engine Fog Color
* Set Fog Start Distance
* Set Fog End Distance
* Load Resource Package
* Collisions
** Set required travel distance
** Manually detect collisions
** Scene collisions
* On Draw
** Render to texture
** Draw 3D Line
** Draw 3D Triangle
** Draw 3D Box
** Draw Pixel
** Draw Texture

== Conditions ==
list - show conditions and define what triggers them

== Expressions ==
list - show expressions and what they define

== Additional notes ==
details on functionality and limitations

Firefly/ff engine

2025-03-26T22:37:54Z

Luxen: /* Actions */ Just grabbed a bunch of actions from the clickteam online 'help' document as placeholders

Firefly/ff engine

2025-03-24T01:35:43Z

Luxen: /* Properties */ Added the engine properties. might reformat this later.

Firefly/ff engine

2025-03-23T19:59:37Z

Luxen: /* Firefly engine */ removed 'thumb' notation to fix size

Firefly/ff engine

2025-03-23T19:58:47Z

Luxen: /* Firefly engine */ changed icon file name

= Firefly engine =
[[image:ff_engine_icon.png|thumb|left|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
<br />

== Properties ==
list - show properties and explain their behaviors

== Actions ==
list - show actions and define their effects, with descriptions for arguments when needed

== Conditions ==
list - show conditions and define what triggers them

== Expressions ==
list - show expressions and what they define

== Additional notes ==
details on functionality and limitations

File:Ff engine icon.png

2025-03-23T19:58:14Z

Luxen: Base icon for firefly engine

== Summary ==
Base icon for firefly engine

Firefly/ff engine

2025-03-23T19:46:39Z

Luxen: Placeholder page for base firefly engine

= Firefly engine =
[[image:ff_engine.jpg|thumb|left|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
<br />

== Properties ==
list - show properties and explain their behaviors

== Actions ==
list - show actions and define their effects, with descriptions for arguments when needed

== Conditions ==
list - show conditions and define what triggers them

== Expressions ==
list - show expressions and what they define

== Additional notes ==
details on functionality and limitations

Firefly/ff ray

2025-03-23T19:29:35Z

Luxen: Added placeholder page for the raycasting node

The node described on this page is not available in the publicly released version of Firefly, and has only been teased on the clickteam community discord for an upcoming release of Firefly. This page is only a placeholder until the object's details are publicly available.

=== Usage ===
A/C/Es of this object are not known at this time, although it has been mentioned that the raycasting features of the camera node would be moved over to this object for simplicity.

Firefly

2025-03-23T19:25:27Z

Luxen: filled out the object documentation list

Firefly is a set of extensions for Clickteam's Fusion game engine that lets you design 3D games and apps, based on the [https://en.wikipedia.org/wiki/Irrlicht_Engine Irrlicht Engine].

<div style="text-align: left; font-size:94%; width:100%;"> 

<div style="display: flex; justify-content: space-between; width: 100%;"> 
<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Using Firefly</div>
These short tutorials cover the minimal basics of using individual objects. <br />
[[firefly/basics_start|Start here]] - Learn the basics on how to add firefly to an empty project <br />
[[firefly/basics_modelload|Loading a model]] - Get a model into your 3d world <br />
[[firefly/basics_movement|Moving objects]] - Make objects move within your world <br />
[[firefly/basics_collisions|Object collision basics]] - Making objects collide together <br />
[[firefly/basics_raycasting|What is raycasting]] - Make objects see each other <br />
[[firefly/basics_animations|Animating an object]] - Make an object do things <br />
[[firefly/basics_oncall|Creating and managing objects]] - Handling object creation at runtime <br />
</div>
</div>

<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Documentation</div>
These pages fully document every object and their A/C/Es. <br />
[[firefly/ff_engine|Firefly engine]] - The core system for Firefly <br />
[[firefly/ff_camera|Firefly camera]] - The camera serves as a window into the 3d world <br />
[[firefly/ff_material|Firefly material cache]] - The material cache stores the textures used by Firefly <br />
[[firefly/ff_static|Firefly static node]] - The static object is used to load most 3d meshes that construct your world <br />
[[firefly/ff_2dtext|Firefly 2D Text]] - Creates a string object on top of your engine's viewport <br />
[[firefly/ff_image|Firefly image]] - Creates an image to display on top of your engine's viewport <br />
[[firefly/ff_movement|Firefly Movement object]] - This helps with handling object movement of other firefly nodes <br />
[[firefly/ff_dummy|Firefly Dummy node]] - This is an empty, representative-less node with many uses <br />
[[firefly/ff_light|Firefly Light]] - Places a light source within your scene <br />
[[firefly/ff_particle|Firefly Particle System]] - Helps with creating and managing particle effects <br />
[[firefly/ff_text|Firefly Text node]] - Inserts a string inside of the 3d world itself <br />
[[firefly/ff_skybox|Firefly Skybox]] - Creates a skybox/sphere within your 3d world <br />
[[firefly/ff_water|Firefly Water object]] - Assists with creating a water surface <br />
[[firefly/ff_terrain|Firefly Terrain node]] - Creates and manages terrain in your worldspace with a working LOD algorithm <br />
[[firefly/ff_billboard|Firefly Billboard node]] - Adds a 2d sprite within your 3d environment <br />
[[firefly/ff_primitive|Firefly Primitive node]] - Adds an object from a preset list of basic elements to your scene <br />
[[firefly/ff_static|Firefly static mesh node]] - Adds a 3d mesh into your scene <br />
[[firefly/ff_animated|Firefly animated mesh node]] - Adds a 3d mesh with animation controls to your scene <br />
[[firefly/ff_ray|Firefly raycasting node]] - A node to help with raycasting (in future versions) <br />
</div>
</div>
</div> 

<div style="display: flex; justify-content: space-between; width: 100%;"> 
<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Tutorials</div>
These are full tutorials you can follow to create a game. <br />
(Beginner) [[firefly/tutorial_chocobreak|Chocobreak]] - The classic chocobreak tutorial in 3D <br />
(Beginner) [[firefly/tutorial_dueltanks|Dueling tanks]] - A simple tutorial for a basic tank fighting game <br />
(Intermediate) [[firefly/tutorial_fps|First Person Shooter tutorial]] - How to create a first-person shooter <br />
(Intermediate) [[firefly/tutorial_tprog|Third person exploration tutorial]] - How to create a third-person adventure <br />
</div>
</div>

<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Community Extras</div>
[[firefly/bugtracker|Firefly Bug Tracker]] - Tracks all known bugs with the public version of Firefly (and if they've been fixed in upcoming releases) <br />
[[firefly/useful_tutorials|Additional tutorials]] - Tutorials not found on this site, including some for general modeling and software use. <br />
</div>
</div>
</div> 

</div>

Firefly

2025-03-23T19:07:10Z

Luxen: Adding an on-call page to the firefly basics section

Firefly is a set of extensions for Clickteam's Fusion game engine that lets you design 3D games and apps, based on the [https://en.wikipedia.org/wiki/Irrlicht_Engine Irrlicht Engine].

<div style="text-align: left; font-size:94%; width:100%;"> 

<div style="display: flex; justify-content: space-between; width: 100%;"> 
<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Using Firefly</div>
These short tutorials cover the minimal basics of using individual objects. <br />
[[firefly/basics_start|Start here]] - Learn the basics on how to add firefly to an empty project <br />
[[firefly/basics_modelload|Loading a model]] - Get a model into your 3d world <br />
[[firefly/basics_movement|Moving objects]] - Make objects move within your world <br />
[[firefly/basics_collisions|Object collision basics]] - Making objects collide together <br />
[[firefly/basics_raycasting|What is raycasting]] - Make objects see each other <br />
[[firefly/basics_animations|Animating an object]] - Make an object do things <br />
[[firefly/basics_oncall|Creating and managing objects]] - Handling object creation at runtime <br />
</div>
</div>

<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Documentation</div>
These pages fully document every object and their A/C/Es. <br />
[[firefly/ff_engine|Firefly engine]] - The core system for Firefly<br />
[[firefly/ff_camera|Firefly camera]] - The camera serves as a window into the 3d world<br />
[[firefly/ff_material|Firefly material cache]] - The material cache stores the textures used by Firefly<br />
[[firefly/ff_static|Firefly static object]] - The static object is used to load most 3d meshes that construct your world<br />
...More to come
</div>
</div>
</div> 

<div style="display: flex; justify-content: space-between; width: 100%;"> 
<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Tutorials</div>
These are full tutorials you can follow to create a game. <br />
(Beginner) [[firefly/tutorial_chocobreak|Chocobreak]] - The classic chocobreak tutorial in 3D <br />
(Beginner) [[firefly/tutorial_dueltanks|Dueling tanks]] - A simple tutorial for a basic tank fighting game <br />
(Intermediate) [[firefly/tutorial_fps|First Person Shooter tutorial]] - How to create a first-person shooter <br />
(Intermediate) [[firefly/tutorial_tprog|Third person exploration tutorial]] - How to create a third-person adventure <br />
</div>
</div>

<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Community Extras</div>
[[firefly/bugtracker|Firefly Bug Tracker]] - Tracks all known bugs with the public version of Firefly (and if they've been fixed in upcoming releases) <br />
[[firefly/useful_tutorials|Additional tutorials]] - Tutorials not found on this site, including some for general modeling and software use. <br />
</div>
</div>
</div> 

</div>

Firefly

2025-03-23T19:05:50Z

Luxen: removed brackets from irrlicht wiki link

Firefly

2025-03-23T18:28:48Z

Luxen: Created firefly front page

Firefly is a set of extensions for Clickteam's Fusion game engine that lets you design 3D games and apps, based on the [[https://en.wikipedia.org/wiki/Irrlicht_Engine Irrlicht Engine]].

<div style="text-align: left; font-size:94%; width:100%;"> 

<div style="display: flex; justify-content: space-between; width: 100%;"> 
<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Using Firefly</div>
These short tutorials cover the minimal basics of using individual objects. <br />
[[firefly/basics_start|Start here]] - Learn the basics on how to add firefly to an empty project <br />
[[firefly/basics_modelload|Loading a model]] - Get a model into your 3d world <br />
[[firefly/basics_movement|Moving objects]] - Make objects move within your world <br />
[[firefly/basics_collisions|Object collision basics]] - Making objects collide together <br />
[[firefly/basics_raycasting|What is raycasting]] - Make objects see each other <br />
[[firefly/basics_animations|Animating an object]] - Make an object do things <br />
</div>
</div>

<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Documentation</div>
These pages fully document every object and their A/C/Es. <br />
[[firefly/ff_engine|Firefly engine]] - The core system for Firefly<br />
[[firefly/ff_camera|Firefly camera]] - The camera serves as a window into the 3d world<br />
[[firefly/ff_material|Firefly material cache]] - The material cache stores the textures used by Firefly<br />
[[firefly/ff_static|Firefly static object]] - The static object is used to load most 3d meshes that construct your world<br />
...More to come
</div>
</div>
</div> 

<div style="display: flex; justify-content: space-between; width: 100%;"> 
<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Tutorials</div>
These are full tutorials you can follow to create a game. <br />
(Beginner) [[firefly/tutorial_chocobreak|Chocobreak]] - The classic chocobreak tutorial in 3D <br />
(Beginner) [[firefly/tutorial_dueltanks|Dueling tanks]] - A simple tutorial for a basic tank fighting game <br />
(Intermediate) [[firefly/tutorial_fps|First Person Shooter tutorial]] - How to create a first-person shooter <br />
(Intermediate) [[firefly/tutorial_tprog|Third person exploration tutorial]] - How to create a third-person adventure <br />
</div>
</div>

<div style="width: 49%;"> 
<div style="border: solid #aaa 1px; margin-bottom:1em; background: #EDFEFE; padding: 4px; spacing: 0px;">
<div style="font-size:115%;border-bottom:1px dotted gray;">Community Extras</div>
[[firefly/bugtracker|Firefly Bug Tracker]] - Tracks all known bugs with the public version of Firefly (and if they've been fixed in upcoming releases) <br />
[[firefly/useful_tutorials|Additional tutorials]] - Tutorials not found on this site, including some for general modeling and software use. <br />
</div>
</div>
</div> 

</div>

Vendetta/helium/api/iup prepend

2025-03-15T17:14:26Z

Luxen: created helium's iup_prepend page

Intended to behave like iup.Append(), but the child is put before instead of after other children.

=== Definition ===
helium.util.iup_prepend(root_ihandle, child_ihandle) -> nil

=== Arguments ===
root_ihandle: type *iup_object: dialog or other iup element item to add the child into.
child_ihandle: type *iup_object: iup element item to be inserted at top of the root object's stack.

=== Notes ===
In order to insert elements, this function iterates and detaches all existing items before adding the new element, and then re-attaches all the other elements in order. As such, extremely large iup structures may be expensive to insert items into; if inserting elements into a long list of items, consider using the asynchronous version of this function to retain client functionality.

Vendetta/helium/api/map dialog

2025-03-15T17:03:22Z

Luxen: created helium's map_dialog page

Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.

=== Definition ===
helium.util.map_dialog(ihandle) -> nil

=== Arguments ===
ihandle: type *iup_object: dialog or other iup element item to be mapped. All children in the entire iup tree will be iterated over and all map_cb found will be executed.

=== Notes ===
The reason most helium objects require this variant of iup.map() is due to the resizable nature of many of the elements. The code to manage the appropriate size of these elements is triggered within map_cb, which is only called on the root dialog when using standard iup.map().

Vendetta/neoloader

2025-03-15T16:21:04Z

Luxen: base links for included utilities

[[image:Vendetta-Neobanner.jpg]]
== ==
'''<big><big>Neoloader Pre-execution Library Management Engine (NPLME) is a toolkit for loading and managing mods in Vendetta Online and improving functional usage between them.</big></big>'''

== For users ==
Neoloader is an advanced mod loader for Vendetta Online that sits on top of the existing mod loader. The goal of the Neoloader is to allow in-game management of Vendetta Online's plugins as much as the game engine can allow, and to facilitate a standard through which plugins can communicate with each other.

'''Features:'''
* Load plugins in order of dependencies and registration, instead of alphabetically
* Minimize risk of game crashes during the loading stage by safety-netting the loading process
* Provide management of plugins in-game
* Easy installation and removal of the system, and a guided recovery system in case of failure
* An extensive API to promote mod intercommunication and extensibility

Neoloader can be downloaded from the following locations:
{| border="1"
! Location
! Version
! Notes
|-
| '''[https://www.nexusmods.com/vendettaonline/mods/3 NexusMods]'''
| 6.1.1 (LME 3.11.0)
| This is the preferred location for stable versions of Neoloader
|-
| '''[https://voupr.spenced.com/plugin.php?name=neoloader VOUPR]'''
| 6.1.1 (LME 3.11.0)
|
|-
| '''[https://github.com/LuxenDM/Neoloader Github]'''
| 6.1.1 (LME 3.11.0)
| Development versions may be available here
|}

Neoloader comes bundled with a few utilities used to interact with the software and manage its settings. These include
* The [[vendetta/neoloader/neomgr|lightweight management interface, neomgr]]
* The [[vendetta/neoloader/neonotif|notification control system, neonotif]]
* A [[vendetta/neoloader/recovery|recovery console]] for plugin errors

To manage non-LME mods, use a tool such as [https://www.nexusmods.com/vendettaonline/mods/2 Neopatcher] to convert mods to a hybrid model capable of being seen and managed by Neoloader.

== For modders ==
* [[vendetta/overview|Developer's overview]] <br />
* [[vendetta/design|Creating or converting a plugin for the LME]] <br />
* [[vendetta/registration|INI registration details]] <br />
* [[vendetta/API|LME API for developers]] <br />

Vendetta/babel

2025-03-14T02:51:00Z

Luxen: Updated links to repositories containing Babel library

'''Babel is a lightweight library that helps plugins provide easy dictionary-based translation to their interfaces''' <br />
If a mod provides a table of translations for a provided language and references each line by key, it can provide a language selection for the user. If the requested language module is not available for the given plugin, or if babel is not present, it falls back to the default language contained within the plugin. In this way, Babel is an optional feature for users, but a powerful benefit to multi-lingual players.

You can download this application at the following locations
{| class="wikitable"
| '''NexusMods''' || [https://www.nexusmods.com/vendettaonline/mods/11 v1.1.1]
|-
| '''VOUPR''' || [https://voupr.spenced.com/plugin.php?name=babel v1.1.1]
|-
| '''Github''' || [https://github.com/LuxenDM/Babel v1.2.0] (in-development)
|}

== For users ==
Babel can be installed like any LME plugin. By default, it internally only supports EN, ES, FR, and PT languages. These languages can be easily expanded with additional addons. Plugins must also support the language being used, but this can likewise be expanded easily.

Once added to your game, verify it is enabled. The first time it is ever run, it will try to default to the user's selected game locale, or use english. To select another language to use in Babel and all supported plugins, open the configuration interface with the command /babel, or by using the config option in your LME manager; the language options will be visible in a drop-down.

== For modders ==

=== Using Babel ===
Babel provides a small API that provides simplified table translation to any plugin, and only minimal setup is required in a plugin's code to access this functionality. While Babel **could** be listed as a hard dependency in a plugin's declaration file, the documentation on this page will assume Babel is being listed as an **optional** feature. The actual API is listed at the bottom of this page.

* First, construct the placeholder functions and requirements to use if Babel is not yet loaded or is not on the user's system:
<syntaxhighlight lang="lua">
local babel, lang_key
local bstr = function(id, val)
return val
end
</syntaxhighlight>

* Next, add the function to update the local babel values when Babel is loaded:
<syntaxhighlight lang="lua">
local babel_func = function()
babel = lib.get_class("babel", "0")
lang_key = babel.register(<your plugins path> .. "lang/", {'en', 'es', 'fr', 'pt'}) --<or whatever list of languages you directly support>

bstr = function(id, val)
return babel.fetch(lang_key, id, val)
end

--<optional, but add this to your public-facing LME class table to let others add new languages to your plugin>
public.add_translation = function(path, lang_code)
babel.add_new_lang(lang_key, path, lang_code)
end

--or whatever you do to update your class table. This will re-trigger it, but now bstr() will pass translated strings
update_class()
end

--actually add this to the queue for when Babel is loaded. Will load immediately if Babel loaded already! Will NEVER load if Babel is not loaded.
lib.require({{name = "babel", version = "0"}}, babel_func)
</syntaxhighlight>

Once those two are set up, you simply call bstr(index, string) when accessing any and all strings (or at least the parts you want translated).
Since bstr() will always pass the default value until Babel is loaded, make sure your plugin loads strings or generates interface elements only after Babel has been given the chance to load, or add additional functionality to update interfaces post-creation.

==== Babel Terminology ====
Internally, Babel uses a few terms when referencing parts of translations. These aren't specifically important to know or use Babel, but referencing them as such can help improve readability when sharing code.

{|border="1",
| Shelf || A shelf is an individual plugin's 'space' where all translations are stored.
|-
| Book || A book is a single translation provided for a shelf. For instance, one 'book' would provide 'english' as a language for a particular shelf.
|-
| Tower || The tower is the container of all individual shelves.
|}

=== Language table ===
Language tables are INI files, and should be named as <language_code>.ini. For instance, per the [https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes ISO 639 two-letter set-1 standard], a table that represents the english language would be 'en', so 'en.ini', where spanish would be 'es', so 'es.ini'. All primary supported languages should be put in the same folder and loaded when using the register function. While standard languages should follow the ISO 639 standard for consistancy, non-standard languages (such as 'pirate speak', 'klingon', 'elvish', or some other unusual language) are up to the community to support.

<syntaxhighlight lang="ini" line="yes">
[babel]
0=<language long name>
flag=<path/to/language's/flag.png>
1=translated line 1
2=translated line 2
...
</syntaxhighlight>

* Key 0 is used by Babel to display the language that this file represents in the primary interface - you only need to include this if you are adding additional language support to Babel, not adding a translation to your own plugin.
* flag is likewise an optional key only used for languages being added to Babel itself, and is used for the visual language selector. If a flag option is not present, a placeholder is used instead.
* All numemric key indexes contain actual translated lines, and should be a complete numeric series from 1 till the last entry. While Babel will not fail to obtain numbers that are not in a series, it will prevent pre-caching for users who select that option.

=== Modding usage (as a hybrid plugin) ===
Babel, as documented in the example above, should be easily converted to work in a hybrid plugin. All elements that require an LME to be present can be stuck inside the standard check for LME existence. If they are never run, then the function 'bstr' would never be updated to do anything except pass along the default entry. The [[vendetta/babel/hybrid_example|example file provided here]] can be a starting point for developing hybrid plugins with Babel support.

=== Modding API ===
{| class="wikitable"
|-
! Function || Input arguments || Output values || Description
|-
| add_translation || babel.add_translation(string file_path, string lang_code) || returns nil || Registers a new language to be used with Babel's interface and language selector.
|-
| register_custom_lang || babel.register_custom_lang(string file_path, string lang_code) || returns nil || v1.0.x name of the 'add_translation' function. This keyword will be deprecated eventually.
|-
| add_new_lang || babel.add_new_lang(*type shelf_reference, string file_path, string language_code || return boolean status || Registers an additional translation 'book' to an existing 'shelf', providing new translations. Usually used as a way for mods using Babel to allow external additions to their supported languages
|-
| register || babel.register(string folder_path, table language_code_list) || return *type shelf_reference || Creates a new shelf and preloads it with translation 'books' provided by the language code list.
|-
| fetch || babel.fetch(*type shelf_reference, number string_id, string default_text) || return string output_text || Looks up and provides the translation for the provided line number.
|-
| get_user_lang || babel.get_user_lang (nil) || return string user_locale || Returns the language code the user has selected. If no locale is set by the user, the game locale will be passed.
|-
| get_langs_on_shelf || babel.get_langs_on_shelf (*type shelf_reference) || return table existing_language_codes || Returns the language codes supported by the provided shelf reference. If the shelf reference is nil, Babel's own language support is provided instead.
|-
| get_lang_flag || babel.get_lang_flag (string lang_code) || return string file_path || Returns a country or language flag image file associated with the provided language, if one exists.
|-
| get_config || babel.get_config (string option_to_retrieve) || return string option_current_value || Gets the current configuration setting for the specified value
|-
| set_config || babel.set_config (string option_to_modify, string new_value) || return nil || Writes the new configuration value. Some changes may require the interface to reload.
|}

Vendetta/babel

2025-03-14T02:42:13Z

Luxen: Finished Babel documentation

'''Babel is a lightweight library that helps plugins provide easy dictionary-based translation to their interfaces''' <br />
If a mod provides a table of translations for a provided language and references each line by key, it can provide a language selection for the user. If the requested language module is not available for the given plugin, or if babel is not present, it falls back to the default language contained within the plugin. In this way, Babel is an optional feature for users, but a powerful benefit to multi-lingual players.

You can download this application at the following locations
'''These links are incorrect, and will be updated shortly!!!'''
{| class="wikitable"
| '''NexusMods''' || [https://www.nexusmods.com/Vendetta/mods/5 v1.1.0]
|-
| '''VOUPR''' || [http://voupr.spenced.com/plugin=?babel v1.1.0]
|-
| '''Github''' || [https://github.com/LuxenDM/Babel v1.1.0] (in-development)
|}

== For users ==
Babel can be installed like any LME plugin. By default, it internally only supports EN, ES, FR, and PT languages. These languages can be easily expanded with additional addons. Plugins must also support the language being used, but this can likewise be expanded easily.

Once added to your game, verify it is enabled. The first time it is ever run, it will try to default to the user's selected game locale, or use english. To select another language to use in Babel and all supported plugins, open the configuration interface with the command /babel, or by using the config option in your LME manager; the language options will be visible in a drop-down.

== For modders ==

=== Using Babel ===
Babel provides a small API that provides simplified table translation to any plugin, and only minimal setup is required in a plugin's code to access this functionality. While Babel **could** be listed as a hard dependency in a plugin's declaration file, the documentation on this page will assume Babel is being listed as an **optional** feature. The actual API is listed at the bottom of this page.

* First, construct the placeholder functions and requirements to use if Babel is not yet loaded or is not on the user's system:
<syntaxhighlight lang="lua">
local babel, lang_key
local bstr = function(id, val)
return val
end
</syntaxhighlight>

* Next, add the function to update the local babel values when Babel is loaded:
<syntaxhighlight lang="lua">
local babel_func = function()
babel = lib.get_class("babel", "0")
lang_key = babel.register(<your plugins path> .. "lang/", {'en', 'es', 'fr', 'pt'}) --<or whatever list of languages you directly support>

bstr = function(id, val)
return babel.fetch(lang_key, id, val)
end

--<optional, but add this to your public-facing LME class table to let others add new languages to your plugin>
public.add_translation = function(path, lang_code)
babel.add_new_lang(lang_key, path, lang_code)
end

--or whatever you do to update your class table. This will re-trigger it, but now bstr() will pass translated strings
update_class()
end

--actually add this to the queue for when Babel is loaded. Will load immediately if Babel loaded already! Will NEVER load if Babel is not loaded.
lib.require({{name = "babel", version = "0"}}, babel_func)
</syntaxhighlight>

Once those two are set up, you simply call bstr(index, string) when accessing any and all strings (or at least the parts you want translated).
Since bstr() will always pass the default value until Babel is loaded, make sure your plugin loads strings or generates interface elements only after Babel has been given the chance to load, or add additional functionality to update interfaces post-creation.

==== Babel Terminology ====
Internally, Babel uses a few terms when referencing parts of translations. These aren't specifically important to know or use Babel, but referencing them as such can help improve readability when sharing code.

{|border="1",
| Shelf || A shelf is an individual plugin's 'space' where all translations are stored.
|-
| Book || A book is a single translation provided for a shelf. For instance, one 'book' would provide 'english' as a language for a particular shelf.
|-
| Tower || The tower is the container of all individual shelves.
|}

=== Language table ===
Language tables are INI files, and should be named as <language_code>.ini. For instance, per the [https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes ISO 639 two-letter set-1 standard], a table that represents the english language would be 'en', so 'en.ini', where spanish would be 'es', so 'es.ini'. All primary supported languages should be put in the same folder and loaded when using the register function. While standard languages should follow the ISO 639 standard for consistancy, non-standard languages (such as 'pirate speak', 'klingon', 'elvish', or some other unusual language) are up to the community to support.

<syntaxhighlight lang="ini" line="yes">
[babel]
0=<language long name>
flag=<path/to/language's/flag.png>
1=translated line 1
2=translated line 2
...
</syntaxhighlight>

* Key 0 is used by Babel to display the language that this file represents in the primary interface - you only need to include this if you are adding additional language support to Babel, not adding a translation to your own plugin.
* flag is likewise an optional key only used for languages being added to Babel itself, and is used for the visual language selector. If a flag option is not present, a placeholder is used instead.
* All numemric key indexes contain actual translated lines, and should be a complete numeric series from 1 till the last entry. While Babel will not fail to obtain numbers that are not in a series, it will prevent pre-caching for users who select that option.

=== Modding usage (as a hybrid plugin) ===
Babel, as documented in the example above, should be easily converted to work in a hybrid plugin. All elements that require an LME to be present can be stuck inside the standard check for LME existence. If they are never run, then the function 'bstr' would never be updated to do anything except pass along the default entry. The [[vendetta/babel/hybrid_example|example file provided here]] can be a starting point for developing hybrid plugins with Babel support.

=== Modding API ===
{| class="wikitable"
|-
! Function || Input arguments || Output values || Description
|-
| add_translation || babel.add_translation(string file_path, string lang_code) || returns nil || Registers a new language to be used with Babel's interface and language selector.
|-
| register_custom_lang || babel.register_custom_lang(string file_path, string lang_code) || returns nil || v1.0.x name of the 'add_translation' function. This keyword will be deprecated eventually.
|-
| add_new_lang || babel.add_new_lang(*type shelf_reference, string file_path, string language_code || return boolean status || Registers an additional translation 'book' to an existing 'shelf', providing new translations. Usually used as a way for mods using Babel to allow external additions to their supported languages
|-
| register || babel.register(string folder_path, table language_code_list) || return *type shelf_reference || Creates a new shelf and preloads it with translation 'books' provided by the language code list.
|-
| fetch || babel.fetch(*type shelf_reference, number string_id, string default_text) || return string output_text || Looks up and provides the translation for the provided line number.
|-
| get_user_lang || babel.get_user_lang (nil) || return string user_locale || Returns the language code the user has selected. If no locale is set by the user, the game locale will be passed.
|-
| get_langs_on_shelf || babel.get_langs_on_shelf (*type shelf_reference) || return table existing_language_codes || Returns the language codes supported by the provided shelf reference. If the shelf reference is nil, Babel's own language support is provided instead.
|-
| get_lang_flag || babel.get_lang_flag (string lang_code) || return string file_path || Returns a country or language flag image file associated with the provided language, if one exists.
|-
| get_config || babel.get_config (string option_to_retrieve) || return string option_current_value || Gets the current configuration setting for the specified value
|-
| set_config || babel.set_config (string option_to_modify, string new_value) || return nil || Writes the new configuration value. Some changes may require the interface to reload.
|}

Vendetta/babel/hybrid example

2025-03-14T02:13:52Z

Luxen: Created example hybrid + babel plugin

This is an example of how a hybrid plugin can be designed to optionally support the Babel library.

<syntaxhighlight lang="lua" line="yes">
--[[
[modreg]
id=bhybridtest
version=1.0.0
name=Babel hybrid example
author=Luxen
]]--

--public class table to contain entry points to other LME plugins
local public = {}

--function called to edit functions and strings, and push table to LME
local update_public

--babel values for plugin
local babel, lang_key
local bstr = function(id, val)
return val
end

--LME check and execution
if type(lib) == "table" and lib[0] == "LME" then
--register plugin to LME
local plugin_path = "plugins/test/"
local plugin_main = plugin_path .. "main.lua"

lib.register(plugin_main)

--halt execution if plugin is disabled in LME
if not lib.is_ready(plugin_main) then
return --the plugin is disabled, stop here
end

--create and/or update plugin's common content description
update_class = function()
local class = {
CCD1 = true,
smart_config = {
title = "Babel hybrid example",
action = function() end,
description_label = {
type = "text",
display = bstr(1, "This is an example hybrid plugin demonstrating Babel usage"),
},
"description_label",
},
description = bstr(1, "This is an example hybrid plugin demonstrating Babel usage"),
commands = {},
manifest = {
"plugins/dummy/main.lua",
"plugins/dummy/lang/en.ini",
"plugins/dummy/lang/es.ini",
"plugins/dummy/lang/fr.ini",
"plugins/dummy/lang/pt.ini",
},
}

for k, v in pairs(class) do
public[k] = v
end

lib.set_class("bhybridtest", "1.0.0")
end

--update Babel functionality now
local babel_func = function()
babel = lib.get_class("babel", "0")
lang_key = babel.register(plugin_path .. "lang/", {'en', 'es', 'fr', 'pt'})

bstr = function(id, val)
return babel.fetch(lang_key, id, val)
end

public.add_translation = function(path, lang_code)
babel.add_new_lang(lang_key, path, lang_code)
end

update_public()
end

lib.require({{name = "babel", version = "0"}}, babel_func)

--[[
Any LME-specific code here
]]--

--OR call this at the end of the plugin inside its own LME check
lib.set_class("bhybridtest", "1.0.0")
end

--[[
Your plugin here
]]--

</syntaxhighlight>

Vendetta/babel

2025-03-13T00:14:06Z

Luxen: updated to include current v1.2.0 api, work in progress

Vendetta/babel

2025-03-07T16:49:18Z

Luxen: Created Babel page. links and api are placeholder.

Vendetta/helium/api

2025-03-06T17:41:24Z

Luxen: /* Constructed objects */ ascroll is adaptive, nscroll is exposed

All API functions for the Helium library are listed below.

== Utility functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Provides functions for operating on iup objects, but don't create iup objects themselves.
|-
! Function !! Description
|-
| [[vendetta/helium/api/map_dialog|map_dialog]] || Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.
|-
| [[vendetta/helium/api/trigger_on_show|trigger_on_show]] || overrides the default show_cb behavior of a dialog to also call a specific child's show_cb function.
|-
| [[vendetta/helium/api/index_container|index_container]] || Iterates over an iup tree and returns the lua table equivilant. Intended for debugging use only.
|-
| [[vendetta/helium/api/iup_prepend|iup_prepend]] || Intended to behave like iup.Append(), but the child is put before instead of after other children
|-
| [[vendetta/helium/api/iup_insert|iup_insert]] || Intended to behave like iup.Append(), but the child can be inserted at an arbitrary location
|-
| [[vendetta/helium/api/is_iup|is_iup]] || Behaves similarly to iup.IsValid(), but only checks if the object is an iup element.
|-
| [[vendetta/helium/api/get_mouse_abs_pos|get_mouse_abs_pos]] || Retrieves the pixel coordinates of the mouse position. Used internally to place subdialogs.
|-
| [[vendetta/helium/api/scale_size|scale_size]] || Using the known scaling value of Font.Default, applies a consistant scale to the provided value
|-
| [[vendetta/helium/api/scale_2x|scale_2x]] || A preset function wrapper around scale_size to provide an iup size attribute's expected format.
|-
| [[vendetta/helium/api/iter_nums_from_string|iter_nums_from_string]] || A function to split numbers from a non-numerically delimited string, returned as a table. When used with an iup size attribute, returns the values {x, y}
|}

== Async functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These are asynchronous variants of the utility functions
|-
! Function !! Description
|-
| [[vendetta/helium/api/async.map_dialog|async map_dialog]] || asynchronous method to map a dialog and execute all embedded map_cb. triggers callback on complete
|-
| [[vendetta/helium/api/async.index_container|async index_container]] || asynchronous method to index an iup container, getting a table representation on callback
|-
| [[vendetta/helium/api/async.prepend|async prepend]] || asynchronous method to add an element to the top of an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.insert|async insert]] || asynchronous method to insert an element in an iup struc. triggers callback on complete
|}

== Primitive objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These provide preset singular iup objects for building basic interface objects with more easily.
|-
! Function !! Description
|-
| [[vendetta/helium/api/clearframe|clearframe]] || A frame preset with no image and no border; should be visually invisible.
|-
| [[vendetta/helium/api/solidframe|solidframe]] || A frame preset with a thin border.
|-
| [[vendetta/helium/api/borderframe|borderframe]] || Description
|-
| [[vendetta/helium/api/highlite_panel|highlite_panel]] || An image used internally for 'highlite on mouse hover' behavior.
|-
| [[vendetta/helium/api/progressbar|progressbar]] || A set of basic preset values for an iup.progressbar
|-
| [[vendetta/helium/api/hslider|hslider]] || A horizontal scroll bar object
|-
| [[vendetta/helium/api/vslider|vslider]] || A vertical scroll bar object
|-
| [[vendetta/helium/api/cyclebutton|cyclebutton]] || A button that changes its contents every press, cycling through indexed options.
|}

== Constructed objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Constructs are functions that create multiple iup objects contained within a frame parent.
|-
! Function !! Description
|-
| [[vendetta/helium/api/hexpandbox|hexpandbox]] || A frame-style object that operates like a horizontal 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vexpandbox|vexpandbox]] || A frame-style object that operates like a vertical 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vscroll|vscroll]] || A frame-style object that allows its contents to be scrolled vertically. This does NOT rely on a 'control' list or iup.matrix
|-
| [[vendetta/helium/api/hscroll|hscroll]] || A frame-style object that allows its contents to be scrolled horizontally. This does NOT rely on an iup.matrix
|-
| [[vendetta/helium/api/ascroll|ascroll]] || A frame style object that adaptively shows or hides vertical and horizontal scroll bars as needed
|-
| [[vendetta/helium/api/ascroll|nscroll]] || A frame style object that exposes scrolling mechanics as functions but provides no scrolling elements natively and is instead controlled by the caller to set the scrolling target.
|-
| [[vendetta/helium/api/hbuttonlist|hbuttonlist]] || A frame containing a horizontal list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/vbuttonlist|vbuttonlist]] || A frame containing a vertical list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || This hides an invisible button over the child element, providing on-click functionality to non-clickable objects and frames
|-
| [[vendetta/helium/api/select_text|select_text]] || A preset of coverbutton over a label element
|-
| [[vendetta/helium/api/link_text|link_text]] || A preset of select_text that mimics a hyperlink to open a webpage
|-
| [[vendetta/helium/api/ticker|ticker]] || Two buttons and a field for inputting and editing a numeric entry
|-
| [[vendetta/helium/api/slide_toggle|slide_toggle]] || A "toggle" object that mimics the popular mobile switch style
|-
| [[vendetta/helium/api/multi_button|multi_button]] || A three-button setup; two to navigate left and right through options, and a central button to activate the displayed item
|-
| [[vendetta/helium/api/radio_collect|radio_collect]] || A collection of linked toggle options that may be duplicate of existing iup.radio behavior, may be deprecated
|-
| [[vendetta/helium/api/bg_frame|bg_frame]] || Acts like a background element handler
|}

== Preset dialogs ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Presets are full dialogs worth of items, with completely custom behaviors and purpose-built uses.
|-
! Function !! Description
|-
| [[vendetta/helium/api/subdialog|subdialog]] || Creates a modal-style dialog that can be positioned on the screen (defaults to center).
|-
| [[vendetta/helium/api/context_menu|context_menu]] || Creates a preset of the subdialog that mimics the behavior of a single-layer context menu.
|-
| [[vendetta/helium/api/alert|alert]] || Creates a very simple subdialog at center screen to show the user a single message.
|-
| [[vendetta/helium/api/reader|reader]] || Creates a large subdialog for displaying a large amount of text in a multiline element.
|}

== Drag-and-drop functionality ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy drag and drop functionality.
|-
! Function !! Description
|-
| [[vendetta/helium/api/drag_item|drag_item]] || Creates a transparent field above the target object. this has a drag behavior associated with it. Intended to be paired with a drag_target object.
|-
| [[vendetta/helium/api/drag_target|drag_target]] || Creates a transparent field above the target objects. this has a drop behavior associated with it. Intended to be paired with a drag_item object.
|}

== Color and paint submodule ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy methods to select both RGB and indexed ship colors.
|-
! Function !! Description
|-
| [[vendetta/helium/api/paint_panel|paint_panel]] || Creates a single color thumbnail for ship paint colors.
|-
| [[vendetta/helium/api/color_panel|color_panel]] || Creates a single color thumbnail for RGB color selection.
|-
| [[vendetta/helium/api/paint_select|paint_select]] || A full palette list for user selection. Each vertical column lists a general color, with indexes from light to dark.
|-
| [[vendetta/helium/api/color_select|color_select]] || Contains RGB color finding controls.
|-
| [[vendetta/helium/api/color_picker|color_picker]] || A custom dialog that allows the user to select from a palette list, recent selections, or use a color finder.
|}

== Preset widgets ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | End-result items used for single-function purpose that don't fit in other categories are kept in the widgets table.
|-
! Function !! Description
|-
| [[vendetta/helium/api/widget.clock|clock]] || A preset clock widget with timezone selection and 12/24 hour display.
|-
| [[vendetta/helium/api/widgets.stopwatch|stopwatch]] || A preset stopwatch widget. action returns either _start or _stop, <time in ms>.
|-
| [[vendetta/helium/api/widgets.numpad|numpad]] || A preset number pad entry widget.
|-
| [[vendetta/helium/api/widgets.marquee_text|marquee_text]] || A preset label display that scrolls its contents. Uses multiple labels to give the semblance of continuous scrolling
|-
| [[vendetta/helium/api/widgets.marquee_obj|marquee_obj]] || A preset display that scrolls its contents. Must be provided with a generator to duplicate displayed contents.
|}

Vendetta/helium/api

2025-03-06T17:37:11Z

Luxen: Seperated individual tables for navigation

All API functions for the Helium library are listed below.

== Utility functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Provides functions for operating on iup objects, but don't create iup objects themselves.
|-
! Function !! Description
|-
| [[vendetta/helium/api/map_dialog|map_dialog]] || Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.
|-
| [[vendetta/helium/api/trigger_on_show|trigger_on_show]] || overrides the default show_cb behavior of a dialog to also call a specific child's show_cb function.
|-
| [[vendetta/helium/api/index_container|index_container]] || Iterates over an iup tree and returns the lua table equivilant. Intended for debugging use only.
|-
| [[vendetta/helium/api/iup_prepend|iup_prepend]] || Intended to behave like iup.Append(), but the child is put before instead of after other children
|-
| [[vendetta/helium/api/iup_insert|iup_insert]] || Intended to behave like iup.Append(), but the child can be inserted at an arbitrary location
|-
| [[vendetta/helium/api/is_iup|is_iup]] || Behaves similarly to iup.IsValid(), but only checks if the object is an iup element.
|-
| [[vendetta/helium/api/get_mouse_abs_pos|get_mouse_abs_pos]] || Retrieves the pixel coordinates of the mouse position. Used internally to place subdialogs.
|-
| [[vendetta/helium/api/scale_size|scale_size]] || Using the known scaling value of Font.Default, applies a consistant scale to the provided value
|-
| [[vendetta/helium/api/scale_2x|scale_2x]] || A preset function wrapper around scale_size to provide an iup size attribute's expected format.
|-
| [[vendetta/helium/api/iter_nums_from_string|iter_nums_from_string]] || A function to split numbers from a non-numerically delimited string, returned as a table. When used with an iup size attribute, returns the values {x, y}
|}

== Async functions ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These are asynchronous variants of the utility functions
|-
! Function !! Description
|-
| [[vendetta/helium/api/async.map_dialog|async map_dialog]] || asynchronous method to map a dialog and execute all embedded map_cb. triggers callback on complete
|-
| [[vendetta/helium/api/async.index_container|async index_container]] || asynchronous method to index an iup container, getting a table representation on callback
|-
| [[vendetta/helium/api/async.prepend|async prepend]] || asynchronous method to add an element to the top of an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.insert|async insert]] || asynchronous method to insert an element in an iup struc. triggers callback on complete
|}

== Primitive objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | These provide preset singular iup objects for building basic interface objects with more easily.
|-
! Function !! Description
|-
| [[vendetta/helium/api/clearframe|clearframe]] || A frame preset with no image and no border; should be visually invisible.
|-
| [[vendetta/helium/api/solidframe|solidframe]] || A frame preset with a thin border.
|-
| [[vendetta/helium/api/borderframe|borderframe]] || Description
|-
| [[vendetta/helium/api/highlite_panel|highlite_panel]] || An image used internally for 'highlite on mouse hover' behavior.
|-
| [[vendetta/helium/api/progressbar|progressbar]] || A set of basic preset values for an iup.progressbar
|-
| [[vendetta/helium/api/hslider|hslider]] || A horizontal scroll bar object
|-
| [[vendetta/helium/api/vslider|vslider]] || A vertical scroll bar object
|-
| [[vendetta/helium/api/cyclebutton|cyclebutton]] || A button that changes its contents every press, cycling through indexed options.
|}

== Constructed objects ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Constructs are functions that create multiple iup objects contained within a frame parent.
|-
! Function !! Description
|-
| [[vendetta/helium/api/hexpandbox|hexpandbox]] || A frame-style object that operates like a horizontal 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vexpandbox|vexpandbox]] || A frame-style object that operates like a vertical 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vscroll|vscroll]] || A frame-style object that allows its contents to be scrolled vertically. This does NOT rely on a 'control' list or iup.matrix
|-
| [[vendetta/helium/api/hscroll|hscroll]] || A frame-style object that allows its contents to be scrolled horizontally. This does NOT rely on an iup.matrix
|-
| [[vendetta/helium/api/ascroll|ascroll]] || A frame style object that exposes scrolling mechanics as functions but provides no scrolling elements natively. The preset vscroll/hscroll provide their own scroll bars and can be scrolled directly, but aren't set up to scroll both directions. This 'adaptive' scrolling panel is instead controlled by the caller to set the scrolling target.
|-
| [[vendetta/helium/api/hbuttonlist|hbuttonlist]] || A frame containing a horizontal list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/vbuttonlist|vbuttonlist]] || A frame containing a vertical list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || This hides an invisible button over the child element, providing on-click functionality to non-clickable objects and frames
|-
| [[vendetta/helium/api/select_text|select_text]] || A preset of coverbutton over a label element
|-
| [[vendetta/helium/api/link_text|link_text]] || A preset of select_text that mimics a hyperlink to open a webpage
|-
| [[vendetta/helium/api/ticker|ticker]] || Two buttons and a field for inputting and editing a numeric entry
|-
| [[vendetta/helium/api/slide_toggle|slide_toggle]] || A "toggle" object that mimics the popular mobile switch style
|-
| [[vendetta/helium/api/multi_button|multi_button]] || A three-button setup; two to navigate left and right through options, and a central button to activate the displayed item
|-
| [[vendetta/helium/api/radio_collect|radio_collect]] || A collection of linked toggle options that may be duplicate of existing iup.radio behavior, may be deprecated
|-
| [[vendetta/helium/api/bg_frame|bg_frame]] || Acts like a background element handler
|}

== Preset dialogs ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Presets are full dialogs worth of items, with completely custom behaviors and purpose-built uses.
|-
! Function !! Description
|-
| [[vendetta/helium/api/subdialog|subdialog]] || Creates a modal-style dialog that can be positioned on the screen (defaults to center).
|-
| [[vendetta/helium/api/context_menu|context_menu]] || Creates a preset of the subdialog that mimics the behavior of a single-layer context menu.
|-
| [[vendetta/helium/api/alert|alert]] || Creates a very simple subdialog at center screen to show the user a single message.
|-
| [[vendetta/helium/api/reader|reader]] || Creates a large subdialog for displaying a large amount of text in a multiline element.
|}

== Drag-and-drop functionality ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy drag and drop functionality.
|-
! Function !! Description
|-
| [[vendetta/helium/api/drag_item|drag_item]] || Creates a transparent field above the target object. this has a drag behavior associated with it. Intended to be paired with a drag_target object.
|-
| [[vendetta/helium/api/drag_target|drag_target]] || Creates a transparent field above the target objects. this has a drop behavior associated with it. Intended to be paired with a drag_item object.
|}

== Color and paint submodule ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy methods to select both RGB and indexed ship colors.
|-
! Function !! Description
|-
| [[vendetta/helium/api/paint_panel|paint_panel]] || Creates a single color thumbnail for ship paint colors.
|-
| [[vendetta/helium/api/color_panel|color_panel]] || Creates a single color thumbnail for RGB color selection.
|-
| [[vendetta/helium/api/paint_select|paint_select]] || A full palette list for user selection. Each vertical column lists a general color, with indexes from light to dark.
|-
| [[vendetta/helium/api/color_select|color_select]] || Contains RGB color finding controls.
|-
| [[vendetta/helium/api/color_picker|color_picker]] || A custom dialog that allows the user to select from a palette list, recent selections, or use a color finder.
|}

== Preset widgets ==
{| class="wikitable"
| colspan="2" style="background:#f2f2f2;" | End-result items used for single-function purpose that don't fit in other categories are kept in the widgets table.
|-
! Function !! Description
|-
| [[vendetta/helium/api/widget.clock|clock]] || A preset clock widget with timezone selection and 12/24 hour display.
|-
| [[vendetta/helium/api/widgets.stopwatch|stopwatch]] || A preset stopwatch widget. action returns either _start or _stop, <time in ms>.
|-
| [[vendetta/helium/api/widgets.numpad|numpad]] || A preset number pad entry widget.
|-
| [[vendetta/helium/api/widgets.marquee_text|marquee_text]] || A preset label display that scrolls its contents. Uses multiple labels to give the semblance of continuous scrolling
|-
| [[vendetta/helium/api/widgets.marquee_obj|marquee_obj]] || A preset display that scrolls its contents. Must be provided with a generator to duplicate displayed contents.
|}

Vendetta/helium/api

2025-03-06T17:27:45Z

Luxen: Added async functions to table

All API functions for the Helium library are listed below.

{| class="wikitable"
! colspan="2" style="background:#f2f2f2;" | '''Utility functions'''
|-
| colspan="2" style="background:#f2f2f2;" | Provides functions for operating on iup objects, but don't create iup objects themselves.
|-
! Function !! Description
|-
| [[vendetta/helium/api/map_dialog|map_dialog]] || Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.
|-
| [[vendetta/helium/api/trigger_on_show|trigger_on_show]] || overrides the default show_cb behavior of a dialog to also call a specific child's show_cb function.
|-
| [[vendetta/helium/api/index_container|index_container]] || Iterates over an iup tree and returns the lua table equivilant. Intended for debugging use only.
|-
| [[vendetta/helium/api/iup_prepend|iup_prepend]] || Intended to behave like iup.Append(), but the child is put before instead of after other children
|-
| [[vendetta/helium/api/iup_insert|iup_insert]] || Intended to behave like iup.Append(), but the child can be inserted at an arbitrary location
|-
| [[vendetta/helium/api/is_iup|is_iup]] || Behaves similarly to iup.IsValid(), but only checks if the object is an iup element.
|-
| [[vendetta/helium/api/get_mouse_abs_pos|get_mouse_abs_pos]] || Retrieves the pixel coordinates of the mouse position. Used internally to place subdialogs.
|-
| [[vendetta/helium/api/scale_size|scale_size]] || Using the known scaling value of Font.Default, applies a consistant scale to the provided value
|-
| [[vendetta/helium/api/scale_2x|scale_2x]] || A preset function wrapper around scale_size to provide an iup size attribute's expected format.
|-
| [[vendetta/helium/api/iter_nums_from_string|iter_nums_from_string]] || A function to split numbers from a non-numerically delimited string, returned as a table. When used with an iup size attribute, returns the values {x, y}
|-
! colspan="2" style="background:#f2f2f2;" | '''Async functions'''
|-
| colspan="2" style="background:#f2f2f2;" | These are asynchronous variants of the utility functions
|-
! Function !! Description
|-
| [[vendetta/helium/api/async.map_dialog|async map_dialog]] || asynchronous method to map a dialog and execute all embedded map_cb. triggers callback on complete
|-
| [[vendetta/helium/api/async.index_container|async index_container]] || asynchronous method to index an iup container, getting a table representation on callback
|-
| [[vendetta/helium/api/async.prepend|async prepend]] || asynchronous method to add an element to the top of an iup struc. triggers callback on complete
|-
| [[vendetta/helium/api/async.insert|async insert]] || asynchronous method to insert an element in an iup struc. triggers callback on complete
|-
! colspan="2" style="background:#f2f2f2;" | '''Primitive objects'''
|-
| colspan="2" style="background:#f2f2f2;" | These provide preset singular iup objects for building basic interface objects with more easily.
|-
! Function !! Description
|-
| [[vendetta/helium/api/clearframe|clearframe]] || A frame preset with no image and no border; should be visually invisible.
|-
| [[vendetta/helium/api/solidframe|solidframe]] || A frame preset with a thin border.
|-
| [[vendetta/helium/api/borderframe|borderframe]] || Description
|-
| [[vendetta/helium/api/highlite_panel|highlite_panel]] || An image used internally for 'highlite on mouse hover' behavior.
|-
| [[vendetta/helium/api/progressbar|progressbar]] || A set of basic preset values for an iup.progressbar
|-
| [[vendetta/helium/api/hslider|hslider]] || A horizontal scroll bar object
|-
| [[vendetta/helium/api/vslider|vslider]] || A vertical scroll bar object
|-
| [[vendetta/helium/api/cyclebutton|cyclebutton]] || A button that changes its contents every press, cycling through indexed options.
|-
! colspan="2" style="background:#f2f2f2;" | '''Constructed objects'''
|-
| colspan="2" style="background:#f2f2f2;" | Constructs are functions that create multiple iup objects contained within a frame parent.
|-
! Function !! Description
|-
| [[vendetta/helium/api/hexpandbox|hexpandbox]] || A frame-style object that operates like a horizontal 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vexpandbox|vexpandbox]] || A frame-style object that operates like a vertical 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vscroll|vscroll]] || A frame-style object that allows its contents to be scrolled vertically. This does NOT rely on a 'control' list or iup.matrix
|-
| [[vendetta/helium/api/hscroll|hscroll]] || A frame-style object that allows its contents to be scrolled horizontally. This does NOT rely on an iup.matrix
|-
| [[vendetta/helium/api/ascroll|ascroll]] || A frame style object that exposes scrolling mechanics as functions but provides no scrolling elements natively. The preset vscroll/hscroll provide their own scroll bars and can be scrolled directly, but aren't set up to scroll both directions. This 'adaptive' scrolling panel is instead controlled by the caller to set the scrolling target.
|-
| [[vendetta/helium/api/hbuttonlist|hbuttonlist]] || A frame containing a horizontal list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/vbuttonlist|vbuttonlist]] || A frame containing a vertical list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || This hides an invisible button over the child element, providing on-click functionality to non-clickable objects and frames
|-
| [[vendetta/helium/api/select_text|select_text]] || A preset of coverbutton over a label element
|-
| [[vendetta/helium/api/link_text|link_text]] || A preset of select_text that mimics a hyperlink to open a webpage
|-
| [[vendetta/helium/api/ticker|ticker]] || Two buttons and a field for inputting and editing a numeric entry
|-
| [[vendetta/helium/api/slide_toggle|slide_toggle]] || A "toggle" object that mimics the popular mobile switch style
|-
| [[vendetta/helium/api/multi_button|multi_button]] || A three-button setup; two to navigate left and right through options, and a central button to activate the displayed item
|-
| [[vendetta/helium/api/radio_collect|radio_collect]] || A collection of linked toggle options that may be duplicate of existing iup.radio behavior, may be deprecated
|-
| [[vendetta/helium/api/bg_frame|bg_frame]] || Acts like a background element handler
|-
! colspan="2" style="background:#f2f2f2;" | '''Preset Dialogs'''
|-
| colspan="2" style="background:#f2f2f2;" | Presets are full dialogs worth of items, with completely custom behaviors and purpose-built uses.
|-
! Function !! Description
|-
| [[vendetta/helium/api/subdialog|subdialog]] || Creates a modal-style dialog that can be positioned on the screen (defaults to center).
|-
| [[vendetta/helium/api/context_menu|context_menu]] || Creates a preset of the subdialog that mimics the behavior of a single-layer context menu.
|-
| [[vendetta/helium/api/alert|alert]] || Creates a very simple subdialog at center screen to show the user a single message.
|-
| [[vendetta/helium/api/reader|reader]] || Creates a large subdialog for displaying a large amount of text in a multiline element.
|-
! colspan="2" style="background:#f2f2f2;" | '''Drag-and-drop functionality'''
|-
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy drag and drop functionality.
|-
! Function !! Description
|-
| [[vendetta/helium/api/drag_item|drag_item]] || Creates a transparent field above the target object. this has a drag behavior associated with it. Intended to be paired with a drag_target object.
|-
| [[vendetta/helium/api/drag_target|drag_target]] || Creates a transparent field above the target objects. this has a drop behavior associated with it. Intended to be paired with a drag_item object.
|-
! colspan="2" style="background:#f2f2f2;" | '''Color and paint submodule'''
|-
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy methods to select both RGB and indexed ship colors.
|-
! Function !! Description
|-
| [[vendetta/helium/api/paint_panel|paint_panel]] || Creates a single color thumbnail for ship paint colors.
|-
| [[vendetta/helium/api/color_panel|color_panel]] || Creates a single color thumbnail for RGB color selection.
|-
| [[vendetta/helium/api/paint_select|paint_select]] || A full palette list for user selection. Each vertical column lists a general color, with indexes from light to dark.
|-
| [[vendetta/helium/api/color_select|color_select]] || Contains RGB color finding controls.
|-
| [[vendetta/helium/api/color_picker|color_picker]] || A custom dialog that allows the user to select from a palette list, recent selections, or use a color finder.
|-
! colspan="2" style="background:#f2f2f2;" | '''Preset widgets'''
|-
| colspan="2" style="background:#f2f2f2;" | End-result items used for single-function purpose that don't fit in other categories are kept in the widgets table.
|-
! Function !! Description
|-
| [[vendetta/helium/api/widget.clock|clock]] || A preset clock widget with timezone selection and 12/24 hour display.
|-
| [[vendetta/helium/api/widgets.stopwatch|stopwatch]] || A preset stopwatch widget. action returns either _start or _stop, <time in ms>.
|-
| [[vendetta/helium/api/widgets.numpad|numpad]] || A preset number pad entry widget.
|-
| [[vendetta/helium/api/widgets.marquee_text|marquee_text]] || A preset label display that scrolls its contents. Uses multiple labels to give the semblance of continuous scrolling
|-
| [[vendetta/helium/api/widgets.marquee_obj|marquee_obj]] || A preset display that scrolls its contents. Must be provided with a generator to duplicate displayed contents.
|}

Vendetta/helium

2025-03-06T17:23:40Z

Luxen: Created helium start page

Helium is an interface control and generation library for use in Vendetta Online. It is a distributable library, intended to be included with other plugins as a sub-module and loaded via the LME provider. On its own, this library will not do anything, but can greatly assist in the construction of interfaces used in other plugins.

Some of the features Helium provides include:

* Scrolling frames, without the use of a control list or iup.matrix element
* iup.map() wrapper which calls all defined map_cb elements in the dialog tree
* prepend and insert iup elements into existing iup trees
* simple scaling functions to keep interfaces consistent across multiple resolutions
* preset primitive elements for easier access
* common gui elements such as a spin dial, multi-select button, mobile-style toggle switches, and simple color access dialog
* basic asynchronous editions of certain utility functions

[[vendetta/helium/api|See the API here]]

Vendetta/helium/api

2025-03-06T17:21:10Z

Luxen: Created API table for helium

All API functions for the Helium library are listed below.

{| class="wikitable"
! colspan="2" style="background:#f2f2f2;" | '''Utility functions'''
|-
| colspan="2" style="background:#f2f2f2;" | Provides functions for operating on iup objects, but don't create iup objects themselves.
|-
! Function !! Description
|-
| [[vendetta/helium/api/map_dialog|map_dialog]] || Similar to iup's :map(), but recursively activates all map_cb() functions in every child iup object. Many helium objects require this to render correctly.
|-
| [[vendetta/helium/api/trigger_on_show|trigger_on_show]] || overrides the default show_cb behavior of a dialog to also call a specific child's show_cb function.
|-
| [[vendetta/helium/api/index_container|index_container]] || Iterates over an iup tree and returns the lua table equivilant. Intended for debugging use only.
|-
| [[vendetta/helium/api/iup_prepend|iup_prepend]] || Intended to behave like iup.Append(), but the child is put before instead of after other children
|-
| [[vendetta/helium/api/iup_insert|iup_insert]] || Intended to behave like iup.Append(), but the child can be inserted at an arbitrary location
|-
| [[vendetta/helium/api/is_iup|is_iup]] || Behaves similarly to iup.IsValid(), but only checks if the object is an iup element.
|-
| [[vendetta/helium/api/get_mouse_abs_pos|get_mouse_abs_pos]] || Retrieves the pixel coordinates of the mouse position. Used internally to place subdialogs.
|-
| [[vendetta/helium/api/scale_size|scale_size]] || Using the known scaling value of Font.Default, applies a consistant scale to the provided value
|-
| [[vendetta/helium/api/scale_2x|scale_2x]] || A preset function wrapper around scale_size to provide an iup size attribute's expected format.
|-
| [[vendetta/helium/api/iter_nums_from_string|iter_nums_from_string]] || A function to split numbers from a non-numerically delimited string, returned as a table. When used with an iup size attribute, returns the values {x, y}
|-
! colspan="2" style="background:#f2f2f2;" | '''Primitive objects'''
|-
| colspan="2" style="background:#f2f2f2;" | These provide preset singular iup objects for building basic interface objects with more easily.
|-
! Function !! Description
|-
| [[vendetta/helium/api/clearframe|clearframe]] || A frame preset with no image and no border; should be visually invisible.
|-
| [[vendetta/helium/api/solidframe|solidframe]] || A frame preset with a thin border.
|-
| [[vendetta/helium/api/borderframe|borderframe]] || Description
|-
| [[vendetta/helium/api/highlite_panel|highlite_panel]] || An image used internally for 'highlite on mouse hover' behavior.
|-
| [[vendetta/helium/api/progressbar|progressbar]] || A set of basic preset values for an iup.progressbar
|-
| [[vendetta/helium/api/hslider|hslider]] || A horizontal scroll bar object
|-
| [[vendetta/helium/api/vslider|vslider]] || A vertical scroll bar object
|-
| [[vendetta/helium/api/cyclebutton|cyclebutton]] || A button that changes its contents every press, cycling through indexed options.
|-
! colspan="2" style="background:#f2f2f2;" | '''Constructed objects'''
|-
| colspan="2" style="background:#f2f2f2;" | Constructs are functions that create multiple iup objects contained within a frame parent.
|-
! Function !! Description
|-
| [[vendetta/helium/api/hexpandbox|hexpandbox]] || A frame-style object that operates like a horizontal 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vexpandbox|vexpandbox]] || A frame-style object that operates like a vertical 'drawer'; when open, the contents are seen. when closed, the contents are hidden.
|-
| [[vendetta/helium/api/vscroll|vscroll]] || A frame-style object that allows its contents to be scrolled vertically. This does NOT rely on a 'control' list or iup.matrix
|-
| [[vendetta/helium/api/hscroll|hscroll]] || A frame-style object that allows its contents to be scrolled horizontally. This does NOT rely on an iup.matrix
|-
| [[vendetta/helium/api/ascroll|ascroll]] || A frame style object that exposes scrolling mechanics as functions but provides no scrolling elements natively. The preset vscroll/hscroll provide their own scroll bars and can be scrolled directly, but aren't set up to scroll both directions. This 'adaptive' scrolling panel is instead controlled by the caller to set the scrolling target.
|-
| [[vendetta/helium/api/hbuttonlist|hbuttonlist]] || A frame containing a horizontal list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/vbuttonlist|vbuttonlist]] || A frame containing a vertical list of buttons, intended for use as a tab row
|-
| [[vendetta/helium/api/coverbutton|coverbutton]] || This hides an invisible button over the child element, providing on-click functionality to non-clickable objects and frames
|-
| [[vendetta/helium/api/select_text|select_text]] || A preset of coverbutton over a label element
|-
| [[vendetta/helium/api/link_text|link_text]] || A preset of select_text that mimics a hyperlink to open a webpage
|-
| [[vendetta/helium/api/ticker|ticker]] || Two buttons and a field for inputting and editing a numeric entry
|-
| [[vendetta/helium/api/slide_toggle|slide_toggle]] || A "toggle" object that mimics the popular mobile switch style
|-
| [[vendetta/helium/api/multi_button|multi_button]] || A three-button setup; two to navigate left and right through options, and a central button to activate the displayed item
|-
| [[vendetta/helium/api/radio_collect|radio_collect]] || A collection of linked toggle options that may be duplicate of existing iup.radio behavior, may be deprecated
|-
| [[vendetta/helium/api/bg_frame|bg_frame]] || Acts like a background element handler
|-
! colspan="2" style="background:#f2f2f2;" | '''Preset Dialogs'''
|-
| colspan="2" style="background:#f2f2f2;" | Presets are full dialogs worth of items, with completely custom behaviors and purpose-built uses.
|-
! Function !! Description
|-
| [[vendetta/helium/api/subdialog|subdialog]] || Creates a modal-style dialog that can be positioned on the screen (defaults to center).
|-
| [[vendetta/helium/api/context_menu|context_menu]] || Creates a preset of the subdialog that mimics the behavior of a single-layer context menu.
|-
| [[vendetta/helium/api/alert|alert]] || Creates a very simple subdialog at center screen to show the user a single message.
|-
| [[vendetta/helium/api/reader|reader]] || Creates a large subdialog for displaying a large amount of text in a multiline element.
|-
! colspan="2" style="background:#f2f2f2;" | '''Drag-and-drop functionality'''
|-
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy drag and drop functionality.
|-
! Function !! Description
|-
| [[vendetta/helium/api/drag_item|drag_item]] || Creates a transparent field above the target object. this has a drag behavior associated with it. Intended to be paired with a drag_target object.
|-
| [[vendetta/helium/api/drag_target|drag_target]] || Creates a transparent field above the target objects. this has a drop behavior associated with it. Intended to be paired with a drag_item object.
|-
! colspan="2" style="background:#f2f2f2;" | '''Color and paint submodule'''
|-
| colspan="2" style="background:#f2f2f2;" | Helium provides these to create easy methods to select both RGB and indexed ship colors.
|-
! Function !! Description
|-
| [[vendetta/helium/api/paint_panel|paint_panel]] || Creates a single color thumbnail for ship paint colors.
|-
| [[vendetta/helium/api/color_panel|color_panel]] || Creates a single color thumbnail for RGB color selection.
|-
| [[vendetta/helium/api/paint_select|paint_select]] || A full palette list for user selection. Each vertical column lists a general color, with indexes from light to dark.
|-
| [[vendetta/helium/api/color_select|color_select]] || Contains RGB color finding controls.
|-
| [[vendetta/helium/api/color_picker|color_picker]] || A custom dialog that allows the user to select from a palette list, recent selections, or use a color finder.
|-
! colspan="2" style="background:#f2f2f2;" | '''Preset widgets'''
|-
| colspan="2" style="background:#f2f2f2;" | End-result items used for single-function purpose that don't fit in other categories are kept in the widgets table.
|-
! Function !! Description
|-
| [[vendetta/helium/api/widget.clock|clock]] || A preset clock widget with timezone selection and 12/24 hour display.
|-
| [[vendetta/helium/api/widgets.stopwatch|stopwatch]] || A preset stopwatch widget. action returns either _start or _stop, <time in ms>.
|-
| [[vendetta/helium/api/widgets.numpad|numpad]] || A preset number pad entry widget.
|-
| [[vendetta/helium/api/widgets.marquee_text|marquee_text]] || A preset label display that scrolls its contents. Uses multiple labels to give the semblance of continuous scrolling
|-
| [[vendetta/helium/api/widgets.marquee_obj|marquee_obj]] || A preset display that scrolls its contents. Must be provided with a generator to duplicate displayed contents.
|}

Vendetta/overview

2025-03-01T20:08:51Z

Luxen: Imported overview page from wiki.js instance. needs to be edited, as some details have significantly changed since this was first written.

Neoloader provides a number of benefits to the Vendetta Online modding environment. These include:

a system that introduces dependency-based load ordering
in-game toolset for enabling and disabling mods loaded through Neoloader
an API that promotes inter-mod communication and expandability, including with Neoloader itself
Currently, no alternative exists for Vendetta Online. Plugins could be (and historically have been) designed for the ASCII-betical plugin loader. Neoloader doesn't replace this, but runs before it using built-in game mechanics to provide its extended functionality without need for exploits.

LME and NPLME (Neoloader):

It is important for plugin developers to note that Neoloader itself is an implementation of a "Library Management Engine". The public-facing API could be seen as LME, where how that API is implemented is Neoloader. This distinction is important in the event that a new tool supercedes Neoloader in the future while providing the same features. For a game like Vendetta Online, which is undergoing active development to this day, this distinction helps future-proof plugins as the game changes. Indeed, as long as the API itself remains untouched, how that API is implemented should not matter.

Startup Process:

Neoloader loads itself as Vendetta Online's interface, using the if= option in config.ini. As such, it will always be the first plugin to be loaded. Neoloader first sets up basic functionality and builds the API in the public "lib" table, before entering "Init", or loader phase. This is the phase that handles loading and executing existing compatible mods. This Init process is described in the image below.

A flowchart representing Neoloader's initialization procedures, designed before version 6.x.x; it mostly holds accurate.
When sorting mods into their dependent orders, it is important to note a few exceptions to this rule due to how the process works. When a plugin is registered in Neoloader, it is given a "Load State" which determines whether the plugin should be allowed to load or not, and under what circumstances.

Possible Load States for plugins:
NO
This plugin will not load

YES
This plugin will load using normal rules

FORCE
This plugin will load even if its dependencies are not met

AUTH
This plugin will be given Neoloader's auth key when it loads

Normally, the YES/NO load states will be the only ones available; the FORCE and AUTH load states are intended for plugin developers to use.

Once the Init phase is complete, it assigns a few events and commands, before completing. At this point, the standard client takes back over and begins the normal mod loading procedure.

Checking for Neoloader's existence:

Before executing any LME functions, mods should check for the existence of Neoloader. This can be done with two various bits of code.

The first option is to check for the public boolean "NEO_EXISTS". When Neoloader starts, it assigns this boolean value. However, this is not the preferred method for checking for Neoloader's existence; your plugin would become reliant on Neoloader specifically. The API is designed to be 'generic' - that is, an alternative resource could provide the same API. As such, the preferred method is to check for both 'lib' and 'lib[0]', as defined below:

if (type(lib) == "table") and (lib[0] == "LME")) then
--LME API functions here
end

You can explore how this used in some of the plugins located in the examples folder provided with this documentation (todo). The Design page also describes how to set up specific files to make your plugin ready for management through Neoloader.

Vendetta/neoloader

2025-03-01T14:59:01Z

Luxen: Landing page

Neoloader Pre-execution Library Management Engine (NPLME) is a toolkit for managing mods in Vendetta Online and improving function usage between them.

This is the Modder's Documentation for Neoloader.

[[vendetta/overview|Overview]] <br />
[[vendetta/design|Creating or converting a plugin for the LME]] <br />
[[vendetta/registration|INI registration details]] <br />
[[vendetta/API|LME API for developers]] <br />

File:Vendetta-Neobanner.jpg

2025-03-01T14:53:00Z

Luxen: Neoloader banner image

== Summary ==
Neoloader banner image