Iron Realms Nexus Client Documentation - User contributions [en]

Simple Scripting Conversion

2023-07-08T02:24:47Z

Argwin:

The Nexus client includes two methods of creating [Reflexes], [Simplified Scripting], and [JavaScript]. While JavaScript allows you to create complex, sophisticated reflex packages, Simplified Scripting allows you to create reflexes without any knowledge of how to write code. However, the day may come when you're ready to make the jump from Simplified Scripting to JavaScript. This guide attempts to serve as a way to bridge that gap more easily.

=== Send Command ===
send_command(<command>);

Example:

send_command("put gold in pack");

=== Show Notice ===
display_notice(<text>, <fg color>, <bg color>[, <more text>, <fg>, <bg>, ...]);

Example:

display_notice("This will be colored blue.", "blue");

display_notice("This is black on a white background.", "black", "white");

display_notice("This will be red, ", "red", "", "while this is green, ", "green", "", "and this is orange on a blue background.", "orange", "blue");

=== Modify Variable ===
Variables are a bit more complicated, but we'll take it one step at a time...

==== Variable Scope ====
In Simplified Scripting, all variables basically have what's called Global Scope, meaning they can be used anywhere. In JavaScript variables can have different scope, so some are available anywhere (Global variables) and some can only be used in the specific block of code where they're defined (Local variables). Local variables are considered better because you cannot accidentally reference a variable in the wrong spot.
==== Local Variables ====
There are two kinds of local variables, constant and non-constant:

<code>const myName = "Sarapis";</code>

This declares a constant variable, one that won't change, and sets it to "Sarapis". The quotes tell us that the variable is a String, in other words it's text. To refer to this variable later you can use the variable name on its own, myName.

<code>let myHealth = 2000;</code>

This declares a non-constant variable and sets it to the number 2000. Because the value is a number and not text it doesn't need quotes. To change the variable later, you refer to the variable only and don't include 'let'. Note - you will only use the keyword 'let' when you declare the variable for the first time. If you use the keyword 'let' again after that you will re-declare the variable and erase any value that it holds.
==== Global/Session Variables ====
<code>myArea = "New Thera";</code>

This declares a non-constant variable with Global scope, so it can be used anywhere in your code. However, when you log off and close the browser or browser tab the variable will be deleted. Some people refer to these as Session variables, since they will only last during the current session.
==== Global/Nexus Variables ====
<code>set_variable("myClass", "Jester");</code>

If you want a variable to last beyond the current session, you have to save it as a Nexus variable. These are the variables that you can see in the Variables section of the settings. Actually, if you visit that Variables tab, you'll see that there are a lot of variables already created for you, and they're automatically updated too, like my_hp and my_mp.

<code>let myHealth = get_variable("my_hp");</code>

And this is how you access those variables when you need them. Note - If you try to get a variable that has not been set yet, you will see a bright red error and your script will not work.

Simple Scripting Conversion

2023-07-06T18:03:40Z

Argwin:

Simple Scripting Conversion

2023-07-06T17:51:35Z

Argwin: Created page with "The Nexus client includes two methods of creating [Reflexes], [Simplified Scripting], and [JavaScript]. While JavaScript allows you to create complex, sophisticated reflex packages, Simplified Scripting allows you to create reflexes without any knowledge of how to write code. However, the day may come when you're ready to make the jump from Simplified Scripting to JavaScript. This guide attempts to serve as a way to bridge that gap more easily. === Send Command === <pre..."

Functions

2023-03-29T02:00:34Z

Argwin:

Functions and scripts are the most powerful option that the client has to offer, but also one that is most difficult to use. Functions and scripts are programmed in the [[Javascript]] language.

While we won't be covering how to code in JavaScript in this section, we'll cover some of the built-in functions and how to build your own custom code to further expand your reflexes.

==== Scripts vs. Functions ====
* Scripts are specific code blocks that are fired as a result of a reflex being fired. This can be a trigger, alias, or keybind.
* Functions are re-usable code blocks that can be called from scripts or directly from the client's input.

==== Calling functions ====
Functions can be called from scripts by using '''run_function(name, args, package)'''. As mentioned above, they can also be called directly from the client's input, so you'll want to make sure your functions are named in such a way that they do not overlap with in-game commands you may wish to use.

==== Variables ====
Scripts and functions are generally self-contained, variables are local to the code block and are cleared when the script or function finishes. To interact with variables used in the [SimplifiedScripting] system, you'll want to use the built-in modules: get_variable, set_variable etc.
* Functions called in a trigger receive information about the match: '''args.text, args.match, args.prefix, args.suffix, args.backrefs[1] ...'''
* Scripts receive the backrefs ('''args[0]., args[1],. args[2], ...''') and the current_package variable indicating the active package.

==== Built-in modules ====

===== Commands =====
* '''send_command(input, no_expansion)''' - Send a command to the game. Set no_expansion to 1 to send the exact string to the game without expansion.
* '''display_notice(text, fgcolor, bgcolor)''' - display a notice on the output screen.

===== Variables =====
* '''get_variable(name)''' - Retrieve the value of a variable from the client's simplified scripting system.
* '''set_variable(name, val)''' - Set a variable for the client's simplified scripting system.
* '''delete_variable(name)''' - Delete a variable from the client's simplified scripting system.
* '''inc_variable(name, by)''' - Increment a variable from the client's simplified scripting system.
* '''dec_variable(name, by)''' - Decrement a variable from the client's simplified scripting system.
* '''mul_variable(name, by)''' - Multiply a variable from the client's simplified scripting system.
* '''div_variable(name, by)''' - Divide a variable from the client's simplified scripting system.

===== Reflex Manipulation =====
* '''reflex_find_by_name(type, name, case_sensitive, enabled_only, package))''' - Search for a specific reflex.
** ''type'' - Type of reflex: 'alias', 'trigger', 'keybind', ...
** ''name'' - Name to search for
** ''case_sensitive'' - Whether the name needs to match case exactly
** ''enabled_only'' - Set if disabled reflexes (including reflexes in disabled groups) should be ignored
** ''package'' - Name if a package to search in; omit if searching in the main list
* '''reflex_enable(reflex)''' - Enable a reflex (reflex is as returned by reflex_find_by_name above).
* '''reflex_disable(reflex)''' - Enable a reflex (reflex is as returned by reflex_find_by_name above).

===== Output Manipulation (Trigger Scripts)=====
* '''current_text()''' - An unformatted version of the line that fired the trigger.
* '''gag_current_line()''' - Hide the line that fired the trigger from the output window.
* '''colorize_current_line(start, length, fgcolor, bgcolor)''' - Colorize/highlight a specified part of the line that fired the trigger.
* '''replace_current_line(start, length, newtext, fgcolor, bgcolor)''' - Replace a party of the current line with the specified text and color.

===== UI Manipulation =====
* '''client.register_custom_tab(tab,container_id)''' - Make a custom UI tab. ''Please note, this is unsupported.''

===== Buttons =====
* '''buttons_set_label(id, text)''' - Set the text label on a button.
* '''buttons_set_commands(id, cmds)''' - Sets the command sent to the game when the button is pressed.
* '''buttons_set_highlight(id, on_off)''' - Set whether the button is highlighted or not.
* '''buttons_set_default(id)''' - Reset a button to the default value.

===== Misc. =====
* '''to_number(val)''' - Convert a string number to a value.
* '''send_GMCP(message, arguments)''' - Sends a GMCP message to the game. Arguments are an object or string, depending on the GMCP call used - see the GMCP documentation for more information.

==== Default functions ====
There are three functions which are called automatically by the client. These are '''onLoad''', called when the settings are loaded, '''onGMCP''', called upon receiving a GMCP message, and '''onBlock''', called upon receiving each text block, allowing you to perform manipulations on it, or kickstart functionality that you want to execute on every prompt.
The function does not receive any data.

The onGMCP function receives two arguments - '''args.gmcp_method''' is the GMCP message name, '''args.gmcp_args''' are the parameters (if any).

The onBlock function can make use of the current_block variable, which holds the individual lines (current_block[0] is the first one, current_block[1] is the second one, and so on). The manipulation methods described with triggers are all applicable on these as well.
*Nexus 3 uses nexusclient.current_block instead of current_block

==== Examples ====
For some examples of functions, read the [[examples]] page.

Main Page N3

2023-02-08T16:40:26Z

Argwin:

__NOTOC__
<table>
<div class="row">
<div class="large-8 columns">

=== The Iron Realms Nexus Client ===

Welcome to the official documentation wiki for the Iron Realms Nexus client: the world's best truly cross-platform MUD client!

{{#evt:
service=youtube
|id=https://youtu.be/dQTrmHtS0K8
|description='''Recommended for new players'''. A just under 7-minute tutorial thoroughly covering all the features of the client accessible from the main page. Does not include much about the extensive Settings window.
}}

'''Core Features include:'''

* '''[[Windows_and_Tabs|Windowed output]]'''. Separate windows for main output, inventory, communication, graphical map, and more!
** Windows auto-resize based on browser window size.

* '''[[Configuration_Options|Highly customizable]]'''. You can get rid of windows or create new ones, move tabs from one window to another, resize windows, change colors, fonts, and more. Go full-screen! Turn music off but keep sound effects on!
** Change your layout, tab location, and windows sizes with intuitive drag and drop UI editing.

* '''Truly cross-platform'''. The Nexus webclient works on Windows, Mac, and Linux, and there are apps for both iOS and Android!
** Nexus will automatically resize windows depending on your device.
** In order to assist with movement, there’s a compass in the mobile version letting you move around the world with the tap of your finger, vs bringing up the keyboard to type a direction, with a toggle in the settings for lefthanded players.

* '''Cross-device functionality'''. Save a macro or trigger you’ve written in Nexus and it’ll be available for you no matter what device you log that character in with! Use your desktop triggers on your mobile device!

* '''[[F-Keys,_Gauges,_and_Avatars|Graphical UI elements]]''' include graphical character creation, health and mana bars, icons that light up when you have common afflictions, balance and equilibrium icons, and more.

* '''Two kinds of scripting''' – Simplified and Advanced.
** [[Advanced_Scripting|Advanced scripting]] is done in Javascript, with an API via the use of General Mud Communication Protocol (GMCP) that lets you track things like inventory, health, room items, and more from within your scripts.
** [[Simplified_Scripting|Simplified Scripting]] can be used by anyone without any coding knowledge at all.
** Easily create powerful keybindings/macros and aliases with no prior experience.

* '''Thorough documentation''' including videos, examples, and more, here on this site.

==== More Tutorial Videos ====

{{#evt:
service=youtube
|id=https://youtu.be/eol8F8b_9sk
|description=A just over 2 minute tutorial for experienced MUDers, running down some of the client features that may not be immediately obvious, such as how to turn off the gauges, using tab-targeting, adding extra communication tabs, and reconfiguring the layout of windows and tabs.
}}

{{#evt:
service=youtube
|id=https://youtu.be/6zVe7q0xF30
|description=A 2.5 minute overview of the Display and Color tabs in the settings window.
}}

==== Screenshots ====

<ul class="small-block-grid-3">
<li>[[File:Client_main_page_-_1280x1024_75p.jpg|thumb|Main Client default skin.]]</li>
<li>[[File:Client_main_page_-_minimal_-_1280x1024.jpg|thumb|Main Client minimal skin.]]</li>
<li>[[File:Settings.png|thumb|Settings Window.]]</li>
<li>[[File:Floating-Help.png|thumb|Floating Help Window.]]</li>
<li>[[File:Floating-room.png|thumb|Room Information.]]</li>
<li>[[File:Floating-map.png|thumb|Map Window]]</li>
<li>[[File:Floating-quests.png|thumb|Quest Information.]]</li>
</ul>

</div>

<div class="large-4 columns">

==== Need Help? ====

Our games can be confusing for new players at first. If you need help, you can ask right in the game on the newbie channel. Just type the command '''newbie''', followed by your question.

For example: '''newbie Can someone help me?'''

Each of the games has people who are there specifically to help new players, so feel free to ask whatever you need to on the newbie channel. If those dedicated helpers aren't around, other players in the game will see any questions you enter here and will normally be more then happy to assist you.

If that doesn't work, you might try asking on the forums for that game (see below).

And of course, you can always look for the answer in our extensive HELP systems. Just type HELP to see the directory and instructions.

====Game Clients====
* [http://play.achaea.com Play Achaea]
* [http://play.aetolia.com Play Aetolia]
* [http://play.imperian.com Play Imperian]
* [http://play.lusternia.com Play Lusternia]
* [http://play.starmourn.com Play Starmourn]

====Game Forums====
Need more help? Try asking on the forums.
* [http://forums.achaea.com Achaea Forums]
* [http://forums.aetolia.com Aetolia Forums]
* [http://forums.imperian.com Imperian Forums]
* [http://forums.lusternia.com Lusternia Forums]
* [http://forums.starmourn.com Starmourn Forums]

====Game Websites====
You can also explore the individual game websites.
* [http://www.achaea.com www.Achaea.com]
* [http://www.aetolia.com www.Aetolia.com]
* [http://www.imperian.com www.Imperian.com]
* [http://www.lusternia.com www.Lusternia.com]
* [http://www.starmourn.com www.Starmourn.com]

</div>
</div>
</table>

Main Page N3

2023-02-07T17:58:21Z

Argwin: Initial page creation

__NOTOC__
<table>
<div class="row">
<div class="large-8 columns">

=== The Iron Realms Nexus Client ===

Welcome to the official documentation wiki for the Iron Realms Nexus client: the world's best truly cross-platform MUD client!

{{#evt:
service=youtube
|id=https://youtu.be/dQTrmHtS0K8
|description='''Recommended for new players'''. A just under 7-minute tutorial thoroughly covering all the features of the client accessible from the main page. Does not include much about the extensive Settings window.
}}

'''Core Features include:'''

* '''[[Windows_and_Tabs|Windowed output]]'''. Separate windows for main output, inventory, communication, graphical map, and more!
** Windows auto-resize based on browser window size.

* '''[[Configuration_Options|Highly customizable]]'''. You can get rid of windows or create new ones, move tabs from one window to another, resize windows, switch the entire client skin, change colors, fonts, and more. Go full-screen! Turn music off but keep sound effects on!

* '''Truly cross-platform'''. Nexus works on Windows, Mac, Linux, iOS, and Android!
** Nexus will lay itself out intelligently depending on your device.
** For instance, on mobile it will default to a single column (rather than three as is the default on desktop), allowing you to swipe left/right to see the other columns.
** In order to assist with movement, there’s a compass in the mobile version letting you move around the world with the tap of your finger, vs bringing up the keyboard to type a direction.

* '''Cross-device functionality'''. Save a macro or trigger you’ve written in Nexus and it’ll be available for you no matter what device you log that character in with! Use your desktop triggers on your mobile device!

* '''[[F-Keys,_Gauges,_and_Avatars|Graphical UI elements]]''' include graphical character creation, health and mana bars, icons that light up when you have common afflictions, balance and equilibrium icons, and more.

* '''Two kinds of scripting''' – Simplified and Advanced.
** [[Advanced_Scripting|Advanced scripting]] is done in Javascript, with an API via the use of General Mud Communication Protocol (GMCP) that lets you track things like inventory, health, room items, and more from within your scripts.
** [[Simplified_Scripting|Simplified Scripting]] can be used by anyone without any coding knowledge at all.
** Easily create powerful keybindings/macros and aliases with no prior experience.

* '''Thorough documentation''' including videos, examples, and more, here on this site.

==== More Tutorial Videos ====

{{#evt:
service=youtube
|id=https://youtu.be/eol8F8b_9sk
|description=A just over 2 minute tutorial for experienced MUDers, running down some of the client features that may not be immediately obvious, such as how to turn off the gauges, using tab-targeting, adding extra communication tabs, and reconfiguring the layout of windows and tabs.
}}

{{#evt:
service=youtube
|id=https://youtu.be/6zVe7q0xF30
|description=A 2.5 minute overview of the Display and Color tabs in the settings window.
}}

==== Screenshots ====

<ul class="small-block-grid-3">
<li>[[File:Client_main_page_-_1280x1024_75p.jpg|thumb|Main Client default skin.]]</li>
<li>[[File:Client_main_page_-_minimal_-_1280x1024.jpg|thumb|Main Client minimal skin.]]</li>
<li>[[File:Settings.png|thumb|Settings Window.]]</li>
<li>[[File:Floating-Help.png|thumb|Floating Help Window.]]</li>
<li>[[File:Floating-room.png|thumb|Room Information.]]</li>
<li>[[File:Floating-map.png|thumb|Map Window]]</li>
<li>[[File:Floating-quests.png|thumb|Quest Information.]]</li>
</ul>

</div>

<div class="large-4 columns">

==== Need Help? ====

Our games can be confusing for new players at first. If you need help, you can ask right in the game on the newbie channel. Just type the command '''newbie''', followed by your question.

For example: '''newbie Can someone help me?'''

Each of the games has people who are there specifically to help new players, so feel free to ask whatever you need to on the newbie channel. If those dedicated helpers aren't around, other players in the game will see any questions you enter here and will normally be more then happy to assist you.

If that doesn't work, you might try asking on the forums for that game (see below).

And of course, you can always look for the answer in our extensive HELP systems. Just type HELP to see the directory and instructions.

====Game Clients====
* [http://play.achaea.com Play Achaea]
* [http://play.aetolia.com Play Aetolia]
* [http://play.imperian.com Play Imperian]
* [http://play.lusternia.com Play Lusternia]
* [http://play.starmourn.com Play Starmourn]

====Game Forums====
Need more help? Try asking on the forums.
* [http://forums.achaea.com Achaea Forums]
* [http://forums.aetolia.com Aetolia Forums]
* [http://forums.imperian.com Imperian Forums]
* [http://forums.lusternia.com Lusternia Forums]
* [http://forums.starmourn.com Starmourn Forums]

====Game Websites====
You can also explore the individual game websites.
* [http://www.achaea.com www.Achaea.com]
* [http://www.aetolia.com www.Aetolia.com]
* [http://www.imperian.com www.Imperian.com]
* [http://www.lusternia.com www.Lusternia.com]
* [http://www.starmourn.com www.Starmourn.com]

</div>
</div>
</table>

Migration Guide

2022-08-03T15:26:11Z

Argwin:

The following is intended to aid in the transition from Nexus 2 to Nexus 3.

You may notice that many of the settings and layouts of Nexus 3 are close enough to Nexus 2 that it seems familiar, but different. Most of the settings will have copied over from Nexus 2, and modifying them works much the same way it did before. The biggest differences occur in reflexes, or scripting. The following chart lists the most common changes that will break existing scripts or cause errors. In most cases searching for the Nexus 2 command and replacing it with the Nexus 3 command will solve the problem.

=Scripting Notes:=
Most of the most common functions that were used in Nexus 2 have been renamed or moved into a new namespace in Nexus 3. However, aliases have been set up in the client so that you can continue using the functions as you did before. The drawback to this is that the aliases only work in the client. If you're working in the dev console or if you're setting up an external JavaScript file, you'll need to reference these functions in their new namespace and names. The conversions are listed in the chart below.

{| class="wikitable" style="margin:auto"
! Original (In client) !! New (dev console or external JS file)
|-
| GMCP || nexusclient.datahandler().GMCP
|-
| get_variable() || nexusclient.variables().get()
|-
| set_variable() || nexusclient.variables().set()
|-
| run_function() || nexusclient.reflexes().run_function()
|-
| display_notice() || nexusclient.display_notice()
|-
| print() || nexusclient.add_html_line()
|-
| client || nexusclient
|-
| gag_current_line() || nexusclient.current_line.gag = true
|}

===Special Scripting Note===
jQuery is built in to Nexus 2, so it can be used throughout any reflexes. jQuery is not built into Nexus 3 though, so jQuery will not work in Nexus 3 reflexes at all. There are no aliases for it, it is simply not there.

Migration Guide

2022-08-02T17:23:10Z

Argwin: Created page with "The following is intended to aid in the transition from Nexus 2 to Nexus 3. You may notice that many of the settings and layouts of Nexus 3 are close enough to Nexus 2 that it seems familiar, but different. Most of the settings will have copied over from Nexus 2, and modifying them works much the same way it did before. The biggest differences occur in reflexes, or scripting. The following chart lists the most common changes that will break existing scripts or cause err..."