Iron Realms Nexus Client Documentation - User contributions [en]

GMCP

2018-05-31T20:59:52Z

Justin:

[[File:Aetolia-dwarf.jpg|right|frame|caption|Dwarf Terradrim from Aetolia.]] General MUD Telnet Protocol (GMCP) is a protocol used to send data from the game server to the player client. This data transfer happens behind the scenes and is not seen by the players. This allows the game server to send messages to the client to update basic character, room, and game information. Character health is an example of information that is continually passed to the client from the game.

These messages can also be accessed by the player for use in [[reflexes]]. We are working simplifying the process of capturing GMCP data for use in the client in a future version of the client.

There is a configuration option in the Advanced Settings tab that will allow you to see GMCP messages as they happen.

Module and message names are not case sensitive. JSON key names are case sensitive.

=== Supported modules ===

This documentation covers the following GMCP messages for the Iron Realms Games.

* Core: core functionality
* Char: information about a character
* Char.Afflictions: information the characters afflictions
* Char.Defences- information the characters defences
* Char.Items: information about items in inventory and room, with live updates
* Char.Skills: information about skills known by the player
* Comm.Channel: identification of communication channels and player lists
* Room: various information about the current room
* Redirect: redirect outpot to another window
* IRE.Composer: IRE-specific, used to edit bigger texts client-side
* IRE.Display: IRE-specific display information
* IRE.FileStore: used internally by the Nexus client
* IRE.Misc: used internally by the fMUD and Nexus clients
* IRE.Rift: IRE-specific, transmits information about the Rift contents
* IRE.Sound: Yes. Sound can be sent.
* IRE.Target: information about the current player target.
* IRE.Tasks: information about tasks, quests, and achievements.
* IRE.Time: information about the current time and date conditions in the game.
* IRE.Wiz: used internally by the Nexus client

=== Supported messages by modules ===

==== Core ====
* Sent by client:
** Core.Hello
*** Needs to be the first message that the client sends, used to identify the client
*** Message body is an object with keys "client" and "version", containing the client's name and version
*** '''Example''': Core.Hello {"Client":"Mudlet","Version":"3.0.0"}
** Core.Supports.Set
*** Notifies the server about packages supported by the client
*** If another Core.Supports.*** package has been received earlier, the list is deleted and replaced with the new one
*** Message body is an array of strings, each consisting of the module name and version, separated by space
*** Module version is a positive non-zero integer
*** Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins
*** '''Example''': Core.Supports.Set [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Add
*** Similar to Set, but appends the supported module list to the one sent earlier
*** If no list was sent yet, the behaviour is identical to Set
*** If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower
*** Message body format is identical to that of Set
*** '''Example''': Core.Supports.Add [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Remove
*** Removes specified modules from the list of supported modules
*** Message body format is similar to Set, except that module version numbers are optional and ignored if given
*** '''Example''': Core.Supports.Remove [ "Char", "Char.Skills", "Char.Items" ]
** Core.KeepAlive
*** Causes the server to reset the timeout for the logged character, no message body
** Core.Ping
*** causes the server to send a Core.Ping back
*** message body is a number which indicates average ping time from previous requests, if available
*** '''Example''': Core.Ping 120

* Sent by server:
** Core.Ping
*** Sent in reply to Core.Ping. No body.
** Core.Goodbye
*** Sent by server immediately before terminating a connection
*** Message body is a string to be shown to the user - it can explain the reason for the disconnect
*** '''Example''': Core.Goodbye "Goodbye, adventurer"

==== Char ====
* Sent by client:
** Char.Login
*** Used to log in a character, only interpreted if no character is logged in for that connection
*** Message body is an object with keys "name" and "password"
*** '''Example''': Char.Login { "name": "somename", "password": "somepassword" }

* Sent by server:
** Char.Name
*** Sends the character name and full name which includes the title. This is only sent on login.
*** '''Example''': Char.Name { "name": "Olad", "fullname": "Neophyte Olad" }
** Char.Vitals
*** Basic character attributes such as health, mana, etc.
*** Message body is an object containing several variables
*** Additionally, each variable is included in a string, in the format name:cur/max
*** Interpretation of the variables is game specific
*** It is generally safe to assume that the known values are numbers (even though encoded as strings), but other datatypes can be present
*** The "charstats" attribute, if present, holds a list of strings that the client may choose to display to the player in a client-specific way, these hold information about the character state that the game wishes to show to the player
*** '''Example''': Char.Vitals { "hp": "4500", "maxhp": "4800", "mp": "1200", "maxmp": "2500", "ep": "15000", "maxep": "16000", "wp": "14000", "maxwp": "15000", "nl": "10", "string": "H:4500/4800 M:1200/2500 E:15000/16000 W:14000/15000 NL:10/100" }
*** '''Additional Achaea Keys'''
**** All classes: Bleed, Rage
**** Apostates: Essence
**** Bard: Stance, Voice Balance
**** Blademaster: Stance
**** Druid: Current Morph, Sunlight Energy
**** Infernal: Essence, Weaponmastery Spec
**** Magi: Channels
**** Monk: Kai Energy, Tekura stance
**** Occultist: Karma, Entity Balance
**** Paladin: Devotion, Weaponmastery Spec
**** Priest: Devotion
**** Runewarden: Weaponmastery Spec
**** Sentinel: Current Morph
**** Serpent: Secreted Venom
**** Shaman: Number of spirits bound
**** Sylvan: Elemental Channels, Sunlight Energy
*** '''Additional Aetolia Keys'''
*** '''Additional Imperian Keys'''
**** General: bleed, flying, prone, stunned, dead, blind, phased, res_weakness, vote
**** Balances: leftarm, rightarm, health, herb, salve, toadstool, pipe, tree, focus, purge
**** Resources: kai, devotion, essence, fanatism, rage, fire, ice, faith, health_reserve, mana_reserve
**** Items: leftwield, leftwield_name, rightwield, rightwield_name, mount
** Char.StatusVars
*** Sent by server after a successful login or after the module is enabled
*** Contains a list of character variables (level, race, etc)
*** Message body is an object
*** Each object element is a name-caption pair, name is the internal name and caption the user-visible one
*** '''Example''': Char.StatusVars { "level": "Level", "race": "Race", "guild": "Guild" }
** Char.Status
*** Values of character values defined by StatusVars.
*** A full list is sent by server right after StatusVars, and changes are sent in subsequent messages as they occur.
*** With the exception of the initial Status message, messages only contain changed values; if a variable is not included, it has not changed since the previous Status message.
*** Message body is an object.
*** Each object element is a name-value pair, name is the internal name defined by the StatusVars message and value is the variable value.
*** '''Example''': Char.Status { "level": "58", "city": "Antioch" }
*** ''' Achaea Keys'''
**** name
**** fullname
**** age
**** race
**** specialisation
**** level
**** xp
**** xprank
**** class
**** city
**** house
**** order
**** boundcredits
**** unboundcredits
**** lessons
**** explorerrank
**** mayancrowns
**** boundmayancrowns
**** gold
**** bank
**** unread_msgs
**** unread_news
**** target
**** gender

===== Char.Afflictions =====
* Sent by server:
** Char.Afflictions.List
*** Sends an array of current character afflictions.
**** name: The name of the affliction
**** cure: The basic cure of the affliction. This is used for links to cure even though other options may exist to cure the affliction.
**** desc: A description of what this affliction does.
*** '''Example''': Char.Afflictions.List [ { "name": "weariness", "cure": "eat kelp", "desc": "Decreases cutting and blunt damage that you inflict by 30%." }, { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }, { "name": "slow herbs", "cure": "apply epidermal", "desc": "Increases the time needed to regain herb balance by 1.25 seconds." }, { "name": "nausea", "cure": "eat nightshade", "desc": "Causes periodic vomiting, which does damage and increases hunger." } ]
** Char.Afflictions.Add
*** Add an affliction to the character.
*** '''Example''': Char.Afflictions.Add { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }
** Char.Afflictions.Remove
*** Removes an affliction from the character.
*** '''Example''': Char.Afflictions.Remove [ "asthma" ]

===== Char.Defences=====
* Sent by server:
** Char.Defences.List
*** Send an array of all the defences a character currently has.
**** name: The name of the defence.
**** desc: The description of the defence.
*** '''Example''': Char.Defences.List [ { "name": "deaf", "desc": "deaf" }, { "name": "blind", "desc": "blind" }, { "name": "nightsight", "desc": "nightsight" } ]
** Char.Defences.Add
*** Sent when a defence is added to a character.
*** '''Example''': Char.Defences.Add { "name": "deaf", "desc": "deaf" }
** Char.Defences.Remove
*** Sent when a defence is removed from a character.
*** '''Example''': Char.Defences.Remove [ "blind" ]

===== Char.Items =====
* Sent by client:
** Char.Items.Contents
*** Request for the server to send the list of items located inside another item.
*** Message body is a number identifying the item.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Item.Contents 12345
** Char.Items.Inv
*** Request for the server to send the list of items in player's inventory.
*** Message body is empty.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Inv ""
** Char.Items.Room
*** Sent by the client to refresh the items in a room.
*** Message body is empty
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Room ""

* Sent by server:
** Char.Items.List
*** List of items at a specified location (room, inv, held container)
*** Message body is an object with keys "location" and "items"
*** Location value is a string, "inv", "room", or "repNUMBER" - the last one is container identification
*** Items value is an array, whose each item is an object with keys "id", "name" and optionally "attrib"
*** ID is a number identifying the item, name is a string containing a short player-visible item description
*** Icon is the image the item is associated with in the client.
*** Attrib is a string consisting of characters describing item properties:
**** "w" = worn,
**** "W" = wearable but not worn
**** "l" = wielded
**** "g" = groupable
**** "c" = container
**** "t" = takeable
**** "m" = monster
**** "d" = dead monster
**** "x" = should not be targeted (guards, ...)
*** '''Example''': Char.Items.List { "location": "inv", "items": [ { "id": "12807", "name": "a personal journal", "icon": "scroll", "attrib": "l" }, { "id": "303060", "name": "a gold nugget", "icon": "commodity" } ] }
** Char.Items.Add
*** Informs the client about an item being added to the specified location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an object with the same structure as one item from the items array of List
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "c" } }
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
*** '''Example''': Char.Items.Add { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity", "attrib": "t" } }
** Char.Items.Remove
*** Informs the client about an item being removed from the location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an integer value identifying the item
*** '''Example''': Char.Items.Remove { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "t" } }
*** '''Example''': Char.Items.Remove { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
** Char.Items.Update
*** Informs the client about an item's attributes being changed - only sent for inventory items
*** Message body syntax the same as with Add
*** '''Example''': Char.Items.Update { "location": "inv", "item": { "id": "60572", "name": "an ornate steel rapier" } }

===== Char.Skills =====
* Sent by client:
** Char.Skills.Get
*** Sent by client to request skill information
*** Message body is an object with keys "group" and "name"
*** If both group and name is provided, the server will send Char.Skills.Info for the specified skill
*** If group is provided but name is not, the server will send Char.Skills.List for that group
*** Otherwise the server will send Char.Skills.Groups
*** '''Example''': Char.Skills.Get {"group":"Perception"}
*** '''Example''': Char.Skills.Get {"group":"perception","name":"Deathsight"}

* Sent by server:
** Char.Skills.Groups
*** Groups of skills available to the character
*** Sent by server on request or at any time (usually if the list changes)
*** For IRE games, groups are skills like Survival or Elemancy
*** Message body is an array including the name and current rank of each skill the character has.
*** '''Example''': Char.Skills.Groups [ { "name": "Perception", "rank": "Transcendent (100%)" }, { "name": "Survival", "rank": "Inept (0%)" }, { "name": "Weaponry", "rank": "Inept (0%)" }, { "name": "Tattoos", "rank": "Inept (0%)" }, { "name": "Evasion", "rank": "Inept (0%)" }, { "name": "Engineering", "rank": "Inept (0%)" }, { "name": "Taming", "rank": "Inept (0%)" }, { "name": "Concoctions", "rank": "Inept (0%)" }, { "name": "Toxins", "rank": "Inept (0%)" }, { "name": "Smithing", "rank": "Inept (0%)" }, { "name": "Malignosis", "rank": "Adept (1%)" }, { "name": "Necromancy", "rank": "Inept (0%)" }, { "name": "Evileye", "rank": "Adept (40%)" } ]

** Char.Skills.List
*** List of skills in a group available to the character
*** Sent by server on request only
*** For IRE games, this is the list visible on AB <skillname>
*** Message body is an object with keys "group", "list", and "desc".
*** The list value is an array of strings, each being the name of one skill
*** '''Example''': Char.Skills.List { "group": "perception", "list": [ "Looking", "Glancing", "Secrets", "Decaylist", "Squinting", "Flyers", "Observe", "Farsight", "Containerlist", "Vigilance", "Treewatch", "Deathsight", "Pipelist", "Elixlist", "Search", "Letterlist", "Booklist", "Skywatch", "PowerNodes", "Keylist", "Alertness", "Rites", "Traps", "Magicklist", "Nightsight", "Hypersight", "Thirdeye", "Tattoos", "Discernment", "Wormholes", "Rivensense", "Contemplation", "Scan", "Telesense", "Appraise", "Trueassess", "Artifactlist", "Warning", "Viewshrine", "Landsense" ], "descs": [ "Gain knowledge of your immediate surroundings.", "See summarized information about your surroundings.", "Discover hidden exits.", "How much more time do those items have?", "See extended distances in your line of sight.", "Take notice of those in the skies.", "Gain information about your extended surroundings.", "Attempt to locate another player from afar.", "What do you have in your containers?", "Increase your resistance to hypnosis.", "Watch the forest canopies for movement.", "Attune yourself to the Underworld.", "Scan your pipes with utmost speed.", "Quickly discover what elixirs and salves you are holding.", "Search your location for hidden beings.", "Quick glance of all your letters.", "Scan the titles of books you own.", "Watch the skies for movement.", "Detect the nodes of power in your area.", "See a list of your keys and which doors they open.", "Heightened awareness of your surroundings.", "View the holy rites operating in your location.", "The ability to search for traps in your location.", "Check the status of your magickal items.", "Use infravision to see in the dark.", "See the actions of cloaked players.", "Give yourself the power of the third eye.", "Discover what tattoos are on another player.", "Discover what defences are protecting an individual.", "The ability to sense wormholes in your location.", "Sense the bodies of the recently slain.", "Perceive the state of another's mental strength.", "Seekout the locations of your allies and enemies.", "Heighten your awareness to telepathic attempts.", "Quickly take note of someone's carried possessions.", "Gain more detailed information concerning your foe.", "See what artifact powers surround an individual.", "Watch for the prying eyes of the enemy.", "Gain a detailed understanding of a shrine.", "The ability to recognize mortals entering the realm." ] }

** Char.Skills.Info
*** Information about a single skill, only sent upon request
*** Message body is an object, keys are "group", "skill", and "info", values are strings
*** Group and skill identify the request, info is a description (usually multi-line) of the skill's functionality and usage
*** '''Example''': Char.Skills.Info { "group": "perception", "skill": "deathsight", "info": "Syntax: DEATHSIGHT\n RELAX DEATHSIGHT\n\nUsing this ability, your mind is now capable of attuning itself to the realm of the dead. While doing so, you will be alerted whenever anyone dies." }
==== Comm.Channel ====
* Sent by client:
** Comm.Channel.Players
*** Request for the server to send Comm.Channel.Players
*** No message body.
*** '''Example''': Comm.Channel.Players ""
** Comm.Channel.Enable
*** Used to tell the game to turn on a character channel without typing in a command line command.
*** Example: Comm.Channel.Enable "newbie"
*** Example: Comm.Channel.Enable "clt Consortium"

* Sent by server:
** Comm.Channel.Players
*** List of players and organizations (city, guild, ...) that they share with this player
*** Message body is an array with each element describing one player
*** Each element is an object with keys "name" and "channels", name is a string, channels is an array
*** The channels array may be omitted if empty; if given, it is a list of organization names
*** '''Example''': Comm.Channel.Players [{"name": "Player1", "channels: ["Some city", "Some guild"]}, {"name": "Player2"}]
*** '''Example''': Comm.Channel.Players [ { "name": "Ahkan", "channels": [ "The City of Stavenn" ] }, { "name": "Sharatar", "channels": [ "The City of Stavenn", "The Revenants" ] } ]

** Comm.Channel.List
*** List of communication channels available to the player, sent on login/negotiation and if changed
*** Message body is an array of objects, each object representing one channel
*** Each object has keys "name", "caption" and "command" - name is internal name, caption is player-visible name, command is command used to communicate over this channel
*** '''Example''': Comm.Channel.List [{"name":"ct", "caption":"Some city", "command":"ct"}, {"name":"gt", "caption":"Some guild", "command":"gt"}]
*** '''Example''': Comm.Channel.List [ { "name": "newbie", "caption": "Newbie", "command": "newbie" }, { "name": "market", "caption": "Market", "command": "market" }, { "name": "ct", "caption": "Stavenn", "command": "ct" }, { "name": "gt", "caption": "Revenants", "command": "gt" } ]

** Comm.Channel.Start
*** Informs the client that text that follows is something said over a communication channel
*** Message body is a text containing the channel name
*** For tells from/to another player, the channel name is "tell Name"
*** '''Example''': Comm.Channel.Start "ct"
*** '''Example''' :Comm.Channel.Start "tell Jeremy"
** Comm.Channel.End
*** Ends a channel text started by Comm.Channel.Start
*** Message body is a text containing the channel name
*** '''Example''': Comm.Channel.End "tell Jeremy"

** Comm.Channel.Text
*** The text of the communication that you heard, who spoke, and which channel it was on
*** '''Example''': Comm.Channel.Text { "channel": "says", "talker": "Tecton", "text": "(Tecton the Terraformer says, \"Are we releasing dragon lairs or the phase artefact first?\"" }
*** '''Example''': Comm.Channel.Text { "channel": "tell Jeremy", "talker": "Olad", "text": "\u001b[0;1;33mYou tell Jeremy, \"Hi.\"\u001b[0;37m" }
*** '''Example''': Comm.Channel.Text { "channel": "newbie", "talker": "Olad", "text": "\u001b[0;1;32m(Newbie): You say, \"Hello.\"\u001b[0;37m" }

==== Room ====
* Sent by server:
** Room.Info
*** Contains information about the room that the player is in. Some of these may be IRE-specific
*** Message body is an object with the following keys
**** "num" - number identifying the room
**** "name" - string containing the brief description
**** "area" - string containing area name
**** "environment" - string containing environment type ("Hills", "Ocean", ...)
**** "coords" - room coordinates (string of numbers separated by commas - area,X,Y,X,building, building is optional
**** "map" - map information - URL pointing to a map image, followed by X and Y room (not pixel) coordinates on the map
**** "details" - array holding further information about a room - shop,bank,...
**** "exits" - object containing exits, each key is a direction and each value is the number identifying the target room
*** '''Example''': Room.Info {"num": 12345, "name": "On a hill", "area": "Barren hills", "environment": "Hills", "coords": "45,5,4,3", "map": "www.imperian.com/itex/maps/clientmap.php?map=45&level=3 5 4", "exits": { "n": 12344, "se": 12336 }, "details": [ "shop", "bank" ] }
** Room.WrongDir
*** Sent if the player attempts to move in a non-existant direction using the standard movement commands
*** Upon receiving this message, the client can safely assume that the specified direction does not lead anywhere at this time
*** Message body is a string with the name if the non-existant exit
*** Example: Room.WrongDir "ne"
** Room.Players
*** Object containing player details, each key is the short name of the player and each value is the full name including titles for the player
*** '''Example''': Room.Players [{ "name": "Tecton", "fullname": "Tecton the Terraformer" }, {"name": "Cardan", "fullname": "Cardan, the Curious" }]
** Room.AddPlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being added to the room.
*** '''Example''': Room.AddPlayer { "name": "Cardan", "fullname": "(Cardan, the Curious)" }
** Room.RemovePlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being removed from the room.
*** '''Example''': Room.RemovePlayer "Cardan"

==== Redirect ====
* Sent by server:
** Redirect.Window
*** Specifies a window to redirect further input to
*** Message body is a string specifying the window to redirect to
*** The main window is referred to as "main", and is the default if the message body is omitted or empty
*** Example: Redirect.Window "map"
==== IRE ====
===== IRE.Composer =====
* Sent by server:
** IRE.Composer.Edit
*** Sent by the server when the player enters an in-game editor. Body is an object, with keys "title" and "text". Text contains the current buffer, title is a title that can be shown to the user.
*** '''Example''': IRE.Composer.Edit { "title": "Composer", "text": "" }

* Sent by client:
** IRE.Composer.SetBuffer
*** Sent by the client upon successfully editing a text which was sent to the client in an IRE.Composer.Edit message earlier
*** Sending this message only changes the edit buffer, but does not end the editing session
*** On IRE games, the client may send the command ***save to save a text, or command ***quit to abort editing (IRE.Composer.SetBuffer is not sent in this case) - this behaviour is IRE-specific and is one of the reasons why the Composer module is in the IRE namespace
*** '''Example''': IRE.Composer.SetBuffer "This is a bunch of text."

===== IRE.Display =====
* Send by server:
** IRE.Display.FixedFont "start" | "stop"
*** Sent by the server to indicate between the start and stop messages should be displayed in a fixed-width font.
** IRE.Display.Ohmap "start" | "stop"
*** Sent by the server to indicated that an overhead map is being sent to the client.

===== IRE.Misc =====
* Sent by client:
** IRE.Misc.Voted
*** Informs the game a vote button was clicked.
*** Example: IRE.Misc.Voted ""

* Sent by server:
** IRE.Misc.RemindVote
*** Message sent to remind the player to vote.
*** '''Example''': IRE.Misc.RemindVote "http://www.imperian.com/vote"

** IRE.Misc.Achievement
*** Used to send basic achievement data to the client.
*** '''Example''': IRE.Misc.Achievement [{"name": "HighestLevelAchieved", "value": "89" }]

** IRE.Misc.URL
*** Sends a url to the client to open in a window when clicked.
*** '''Example''': IRE.Misc.URL[{"url": "http://www.imperian.com/tos", "window": "ire_game_tos" }]

** IRE.MISC.Tip
*** Sends a line of text to the client.
*** '''Example''': IRE.Misc.Tip "This is a tip!"

===== IRE.Rift =====
* Sent by server:
** IRE.Rift.List
*** contents of a Rift storage
*** sent upon receiving the IRE.Rift.Request message
*** message body is an array, with each element being an object containing three keys - "name" is item name, "amount" is a number holding the item's amount, and "desc" is user-visible description
** IRE.Rift.Change
*** sent whenever the item amount in a Rift changes
*** message body is an object with the same structure as one element of an array sent with the IRE.Rift.List message

* Sent by client:
** IRE.Rift.Request
*** asks the server to send the Rift contents using the IRE.Rift.List message

===== IRE.Sound =====

* Sent by server:
** IRE.Sound.Play
** IRE.Sound.Stop
** IRE.Sound.Stopall
** IRE.Sound.Preload

===== IRE.Target =====
* Sent by client:
** IRE.Target.Set
*** Sends the currently set target to the server to be used by the internal alias system.
*** '''Example''': IRE.Target.Set "1101"
* Sent by server

** IRE.Target.Set
*** Sends the target the client is trying to set. This is called from cycling targets with tab targeting.
*** '''Example''': IRE.Target.Set "1101"
** IRE.Target.Info
*** Sends an array with the current target information.
*** '''Example''': IRE.Target.Info { "id": "1101", "short_desc": "a brawny goblin smith", "hpperc": "100%" }
** IRE.Target.Request

===== IRE.Tasks =====

* Sent by client:
** IRE.Tasks.Request

* Sent by server:
** IRE.Tasks.List
*** This is used to send a list of quest, tasks, and achievements, depending on what the game supports.
*** Sends an array of items with the following keys:
**** id: A numeric identifier
**** name: The name of the quest, task, or achievement.
**** type: Is this a quest, task, or achievement.
**** cmd: The command to get more information for the quest. Good for MXP links.
**** desc: The description of the event.
**** status: 0 or 1 based on if it is completed or not.
**** group: What group should this be assigned to. This is mainly for client display purposes.
*** '''Example''': IRE.Tasks.List [ { "id": "184", "name": "For the sake of the village", "desc": "The herbs in Maeven's garden are painstakingly cared for so that her fellow villagers can stay healthy. She won't object to borrowing a bit of the magick power the bakuls have, if it can help with her work.\n\nThe bakul herbalist might have something Maeven wants.", "type": "quests", "cmd": "quest For the sake of the village", "status": "0", "group": "Current Quests" }, { "id": "313", "name": "Apostate", "desc": "Destroy a Shrine.", "type": "achievements", "cmd": "achievement apostate", "status": "0", "group": "Sects" } ]
** IRE.Tasks.Update
** IRE.Tasks.Completed

===== IRE.Time =====
* Sent by client:
** IRE.Time.Request

* Sent by server:
** IRE.Time.List
*** A list of the current time condition in the game world.
*** Used in the client to display the the day/night indicator.
*** '''Example''': IRE.Time.List { "day": "1", "mon": "1", "month": "Letum", "year": "98", "hour": "41", "daynight": "80" }
** IRE.Time.Update
*** Used to update time conditions.
*** '''Example''': IRE.Time.Update { "daynight": "112" }

GMCP

2018-05-31T20:59:25Z

Justin:

[[File:Aetolia-dwarf.jpg|right|frame|caption|Dwarf Terradrim from Aetolia.]] General MUD Telnet Protocol (GMCP) is a protocol used to send data from the game server to the player client. This data transfer happens behind the scenes and is not seen by the players. This allows the game server to send messages to the client to update basic character, room, and game information. Character health is an example of information that is continually passed to the client from the game.

These messages can also be accessed by the player for use in [[reflexes]]. We are working simplifying the process of capturing GMCP data for use in the client in a future version of the client.

There is a configuration option in the Advanced Settings tab that will allow you to see GMCP messages as they happen.

Module and message names are not case sensitive. JSON key names are case sensitive.

=== Supported modules ===

This documentation covers the following GMCP messages for the Iron Realms Games.

* Core: core functionality
* Char: information about a character
* Char.Afflictions: information the characters afflictions
* Char.Defences- information the characters defences
* Char.Items: information about items in inventory and room, with live updates
* Char.Skills: information about skills known by the player
* Comm.Channel: identification of communication channels and player lists
* Room: various information about the current room
* Redirect: redirect outpot to another window
* IRE.Composer: IRE-specific, used to edit bigger texts client-side
* IRE.Display: IRE-specific display information
* IRE.FileStore: used internally by the Nexus client
* IRE.Misc: used internally by the fMUD and Nexus clients
* IRE.Rift: IRE-specific, transmits information about the Rift contents
* IRE.Sound: Yes. Sound can be sent.
* IRE.Target: information about the current player target.
* IRE.Tasks: information about tasks, quests, and achievements.
* IRE.Time: information about the current time and date conditions in the game.
* IRE.Wiz: used internally by the Nexus client

=== Supported messages by modules ===

==== Core ====
* Sent by client:
** Core.Hello
*** Needs to be the first message that the client sends, used to identify the client
*** Message body is an object with keys "client" and "version", containing the client's name and version
*** '''Example''': Core.Hello {"Client":"Mudlet","Version":"3.0.0"}
** Core.Supports.Set
*** Notifies the server about packages supported by the client
*** If another Core.Supports.*** package has been received earlier, the list is deleted and replaced with the new one
*** Message body is an array of strings, each consisting of the module name and version, separated by space
*** Module version is a positive non-zero integer
*** Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins
*** '''Example''': Core.Supports.Set [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Add
*** Similar to Set, but appends the supported module list to the one sent earlier
*** If no list was sent yet, the behaviour is identical to Set
*** If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower
*** Message body format is identical to that of Set
*** '''Example''': Core.Supports.Add [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Remove
*** Removes specified modules from the list of supported modules
*** Message body format is similar to Set, except that module version numbers are optional and ignored if given
*** '''Example''': Core.Supports.Remove [ "Char", "Char.Skills", "Char.Items" ]
** Core.KeepAlive
*** Causes the server to reset the timeout for the logged character, no message body
** Core.Ping
*** causes the server to send a Core.Ping back
*** message body is a number which indicates average ping time from previous requests, if available
*** '''Example''': Core.Ping 120

* Sent by server:
** Core.Ping
*** Sent in reply to Core.Ping. No body.
** Core.Goodbye
*** Sent by server immediately before terminating a connection
*** Message body is a string to be shown to the user - it can explain the reason for the disconnect
*** '''Example''': Core.Goodbye "Goodbye, adventurer"

==== Char ====
* Sent by client:
** Char.Login
*** Used to log in a character, only interpreted if no character is logged in for that connection
*** Message body is an object with keys "name" and "password"
*** '''Example''': Char.Login { "name": "somename", "password": "somepassword" }

* Sent by server:
** Char.Name
*** Sends the character name and full name which includes the title. This is only sent on login.
*** '''Example''': Char.Name { "name": "Olad", "fullname": "Neophyte Olad" }
** Char.Vitals
*** Basic character attributes such as health, mana, etc.
*** Message body is an object containing several variables
*** Additionally, each variable is included in a string, in the format name:cur/max
*** Interpretation of the variables is game specific
*** It is generally safe to assume that the known values are numbers (even though encoded as strings), but other datatypes can be present
*** The "charstats" attribute, if present, holds a list of strings that the client may choose to display to the player in a client-specific way, these hold information about the character state that the game wishes to show to the player
*** '''Example''': Char.Vitals { "hp": "4500", "maxhp": "4800", "mp": "1200", "maxmp": "2500", "ep": "15000", "maxep": "16000", "wp": "14000", "maxwp": "15000", "nl": "10", "string": "H:4500/4800 M:1200/2500 E:15000/16000 W:14000/15000 NL:10/100" }
*** '''Additional Achaea Keys'''
**** All classes: Bleed, Rage
**** Apostates: Essence
**** Bard: Stance, Voice Balance
**** Blademaster: Stance
**** Druid: Current Morph, Sunlight Energy
**** Infernal: Essence, Weaponmastery Spec
**** Magi: Channels
**** Monk: Kai Energy, Tekura stance
**** Occultist: Karma, Entity Balance
**** Paladin: Devotion, Weaponmastery Spec
**** Priest: Devotion
**** Runewarden: Weaponmastery Spec
**** Sentinel: Current Morph
**** Serpent: Secreted Venom
**** Shaman: Number of spirits bound
**** Sylvan: Elemental Channels, Sunlight Energy
*** '''Additional Aetolia Keys'''
*** '''Additional Imperian Keys'''
**** General: bleed, flying, prone, stunned, dead, blind, phased, res_weakness, vote
**** Balances: leftarm, rightarm, health, herb, salve, toadstool, pipe, tree, focus, purge
**** Resources: kai, devotion, essence, fanatism, rage, fire, ice, faith, health_reserve, mana_reserve
**** Items: leftwield, leftwield_name, rightwield, rightwield_name, mount
** Char.StatusVars
*** Sent by server after a successful login or after the module is enabled
*** Contains a list of character variables (level, race, etc)
*** Message body is an object
*** Each object element is a name-caption pair, name is the internal name and caption the user-visible one
*** '''Example''': Char.StatusVars { "level": "Level", "race": "Race", "guild": "Guild" }
** Char.Status
*** Values of character values defined by StatusVars.
*** A full list is sent by server right after StatusVars, and changes are sent in subsequent messages as they occur.
*** With the exception of the initial Status message, messages only contain changed values; if a variable is not included, it has not changed since the previous Status message.
*** Message body is an object.
*** Each object element is a name-value pair, name is the internal name defined by the StatusVars message and value is the variable value.
*** '''Example''': Char.Status { "level": "58", "city": "Antioch" }
*** ''' Achaea Keys'''
**** name
**** fullname
**** age
**** race
**** specialisation
**** level
**** xp
**** xprank
**** class
**** city
**** house
**** order
**** boundcredits
**** unboundcredits
**** lessons
**** explorerrank
**** mayancrowns
**** boundmayancrowns
**** gold
**** bank
**** unread_msgs
**** unread_news
**** target
**** gender

===== Char.Afflictions =====
* Sent by server:
** Char.Afflictions.List
*** Sends an array of current character afflictions.
**** name: The name of the affliction
**** cure: The basic cure of the affliction. This is used for links to cure even though other options may exist to cure the affliction.
**** desc: A description of what this affliction does.
*** '''Example''': Char.Afflictions.List [ { "name": "weariness", "cure": "eat kelp", "desc": "Decreases cutting and blunt damage that you inflict by 30%." }, { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }, { "name": "slow herbs", "cure": "apply epidermal", "desc": "Increases the time needed to regain herb balance by 1.25 seconds." }, { "name": "nausea", "cure": "eat nightshade", "desc": "Causes periodic vomiting, which does damage and increases hunger." } ]
** Char.Afflictions.Add
*** Add an affliction to the character.
*** '''Example''': Char.Afflictions.Add { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }
** Char.Afflictions.Remove
*** Removes an affliction from the character.
*** '''Example''': Char.Afflictions.Remove [ "asthma" ]

===== Char.Defences=====
* Sent by server:
** Char.Defences.List
*** Send an array of all the defences a character currently has.
**** name: The name of the defence.
**** desc: The description of the defence.
*** '''Example''': Char.Defences.List [ { "name": "deaf", "desc": "deaf" }, { "name": "blind", "desc": "blind" }, { "name": "nightsight", "desc": "nightsight" } ]
** Char.Defences.Add
*** Sent when a defence is added to a character.
*** '''Example''': Char.Defences.Add { "name": "deaf", "desc": "deaf" }
** Char.Defences.Remove
*** Sent when a defence is removed from a character.
*** '''Example''': Char.Defences.Remove [ "blind" ]

===== Char.Items =====
* Sent by client:
** Char.Items.Contents
*** Request for the server to send the list of items located inside another item.
*** Message body is a number identifying the item.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Item.Contents 12345
** Char.Items.Inv
*** Request for the server to send the list of items in player's inventory.
*** Message body is empty.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Inv ""
** Char.Items.Room
*** Sent by the client to refresh the items in a room.
*** Message body is empty
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Room ""

* Sent by server:
** Char.Items.List
*** List of items at a specified location (room, inv, held container)
*** Message body is an object with keys "location" and "items"
*** Location value is a string, "inv", "room", or "repNUMBER" - the last one is container identification
*** Items value is an array, whose each item is an object with keys "id", "name" and optionally "attrib"
*** ID is a number identifying the item, name is a string containing a short player-visible item description
*** Icon is the image the item is associated with in the client.
*** Attrib is a string consisting of characters describing item properties:
**** "w" = worn,
**** "W" = wearable but not worn
**** "l" = wielded
**** "g" = groupable
**** "c" = container
**** "t" = takeable
**** "m" = monster
**** "d" = dead monster
**** "x" = should not be targeted (guards, ...)
*** '''Example''': Char.Items.List { "location": "inv", "items": [ { "id": "12807", "name": "a personal journal", "icon": "scroll", "attrib": "l" }, { "id": "303060", "name": "a gold nugget", "icon": "commodity" } ] }
** Char.Items.Add
*** Informs the client about an item being added to the specified location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an object with the same structure as one item from the items array of List
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "c" } }
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
*** '''Example''': Char.Items.Add { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity", "attrib": "t" } }
** Char.Items.Remove
*** Informs the client about an item being removed from the location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an integer value identifying the item
*** '''Example''': Char.Items.Remove { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "t" } }
*** '''Example''': Char.Items.Remove { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
** Char.Items.Update
*** Informs the client about an item's attributes being changed - only sent for inventory items
*** Message body syntax the same as with Add
*** '''Example''': Char.Items.Update { "location": "inv", "item": { "id": "60572", "name": "an ornate steel rapier" } }

===== Char.Skills =====
* Sent by client:
** Char.Skills.Get
*** Sent by client to request skill information
*** Message body is an object with keys "group" and "name"
*** If both group and name is provided, the server will send Char.Skills.Info for the specified skill
*** If group is provided but name is not, the server will send Char.Skills.List for that group
*** Otherwise the server will send Char.Skills.Groups
*** '''Example''': Char.Skills.Get {"group":"Perception"}
*** '''Example''': Char.Skills.Get {"group":"perception","name":"Deathsight"}

* Sent by server:
** Char.Skills.Groups
*** Groups of skills available to the character
*** Sent by server on request or at any time (usually if the list changes)
*** For IRE games, groups are skills like Survival or Elemancy
*** Message body is an array including the name and current rank of each skill the character has.
*** '''Example''': Char.Skills.Groups [ { "name": "Perception", "rank": "Transcendent (100%)" }, { "name": "Survival", "rank": "Inept (0%)" }, { "name": "Weaponry", "rank": "Inept (0%)" }, { "name": "Tattoos", "rank": "Inept (0%)" }, { "name": "Evasion", "rank": "Inept (0%)" }, { "name": "Engineering", "rank": "Inept (0%)" }, { "name": "Taming", "rank": "Inept (0%)" }, { "name": "Concoctions", "rank": "Inept (0%)" }, { "name": "Toxins", "rank": "Inept (0%)" }, { "name": "Smithing", "rank": "Inept (0%)" }, { "name": "Malignosis", "rank": "Adept (1%)" }, { "name": "Necromancy", "rank": "Inept (0%)" }, { "name": "Evileye", "rank": "Adept (40%)" } ]

** Char.Skills.List
*** List of skills in a group available to the character
*** Sent by server on request only
*** For IRE games, this is the list visible on AB <skillname>
*** Message body is an object with keys "group", "list", and "desc".
*** The list value is an array of strings, each being the name of one skill
*** '''Example''': Char.Skills.List { "group": "perception", "list": [ "Looking", "Glancing", "Secrets", "Decaylist", "Squinting", "Flyers", "Observe", "Farsight", "Containerlist", "Vigilance", "Treewatch", "Deathsight", "Pipelist", "Elixlist", "Search", "Letterlist", "Booklist", "Skywatch", "PowerNodes", "Keylist", "Alertness", "Rites", "Traps", "Magicklist", "Nightsight", "Hypersight", "Thirdeye", "Tattoos", "Discernment", "Wormholes", "Rivensense", "Contemplation", "Scan", "Telesense", "Appraise", "Trueassess", "Artifactlist", "Warning", "Viewshrine", "Landsense" ], "descs": [ "Gain knowledge of your immediate surroundings.", "See summarized information about your surroundings.", "Discover hidden exits.", "How much more time do those items have?", "See extended distances in your line of sight.", "Take notice of those in the skies.", "Gain information about your extended surroundings.", "Attempt to locate another player from afar.", "What do you have in your containers?", "Increase your resistance to hypnosis.", "Watch the forest canopies for movement.", "Attune yourself to the Underworld.", "Scan your pipes with utmost speed.", "Quickly discover what elixirs and salves you are holding.", "Search your location for hidden beings.", "Quick glance of all your letters.", "Scan the titles of books you own.", "Watch the skies for movement.", "Detect the nodes of power in your area.", "See a list of your keys and which doors they open.", "Heightened awareness of your surroundings.", "View the holy rites operating in your location.", "The ability to search for traps in your location.", "Check the status of your magickal items.", "Use infravision to see in the dark.", "See the actions of cloaked players.", "Give yourself the power of the third eye.", "Discover what tattoos are on another player.", "Discover what defences are protecting an individual.", "The ability to sense wormholes in your location.", "Sense the bodies of the recently slain.", "Perceive the state of another's mental strength.", "Seekout the locations of your allies and enemies.", "Heighten your awareness to telepathic attempts.", "Quickly take note of someone's carried possessions.", "Gain more detailed information concerning your foe.", "See what artifact powers surround an individual.", "Watch for the prying eyes of the enemy.", "Gain a detailed understanding of a shrine.", "The ability to recognize mortals entering the realm." ] }

** Char.Skills.Info
*** Information about a single skill, only sent upon request
*** Message body is an object, keys are "group", "skill", and "info", values are strings
*** Group and skill identify the request, info is a description (usually multi-line) of the skill's functionality and usage
*** '''Example''': Char.Skills.Info { "group": "perception", "skill": "deathsight", "info": "Syntax: DEATHSIGHT\n RELAX DEATHSIGHT\n\nUsing this ability, your mind is now capable of attuning itself to the realm of the dead. While doing so, you will be alerted whenever anyone dies." }
==== Comm.Channel ====
* Sent by client:
** Comm.Channel.Players
*** Request for the server to send Comm.Channel.Players
*** No message body.
*** '''Example''': Comm.Channel.Players ""
** Comm.Channel.Enable
*** Used to tell the game to turn on a character channel without typing in a command line command.
*** Example: Comm.Channel.Enable "newbie"
*** Example: Comm.Channel.Enable "clt Consortium"

* Sent by server:
** Comm.Channel.Players
*** List of players and organizations (city, guild, ...) that they share with this player
*** Message body is an array with each element describing one player
*** Each element is an object with keys "name" and "channels", name is a string, channels is an array
*** The channels array may be omitted if empty; if given, it is a list of organization names
*** '''Example''': Comm.Channel.Players [{"name": "Player1", "channels: ["Some city", "Some guild"]}, {"name": "Player2"}]
*** '''Example''': Comm.Channel.Players [ { "name": "Ahkan", "channels": [ "The City of Stavenn" ] }, { "name": "Sharatar", "channels": [ "The City of Stavenn", "The Revenants" ] } ]

** Comm.Channel.List
*** List of communication channels available to the player, sent on login/negotiation and if changed
*** Message body is an array of objects, each object representing one channel
*** Each object has keys "name", "caption" and "command" - name is internal name, caption is player-visible name, command is command used to communicate over this channel
*** '''Example''': Comm.Channel.List [{"name":"ct", "caption":"Some city", "command":"ct"}, {"name":"gt", "caption":"Some guild", "command":"gt"}]
*** '''Example''': Comm.Channel.List [ { "name": "newbie", "caption": "Newbie", "command": "newbie" }, { "name": "market", "caption": "Market", "command": "market" }, { "name": "ct", "caption": "Stavenn", "command": "ct" }, { "name": "gt", "caption": "Revenants", "command": "gt" } ]

** Comm.Channel.Start
*** Informs the client that text that follows is something said over a communication channel
*** Message body is a text containing the channel name
*** For tells from/to another player, the channel name is "tell Name"
*** '''Example''': Comm.Channel.Start "ct"
*** '''Example''' :Comm.Channel.Start "tell Jeremy"
** Comm.Channel.End
*** Ends a channel text started by Comm.Channel.Start
*** Message body is a text containing the channel name
*** '''Example''': Comm.Channel.End "tell Jeremy"

** Comm.Channel.Text
*** The text of the communication that you heard, who spoke, and which channel it was on
*** '''Example''': Comm.Channel.Text { "channel": "says", "talker": "Tecton", "text": "(Tecton the Terraformer says, \"Are we releasing dragon lairs or the phase artefact first?\"" }
*** '''Example''': Comm.Channel.Text { "channel": "tell Jeremy", "talker": "Olad", "text": "\u001b[0;1;33mYou tell Jeremy, \"Hi.\"\u001b[0;37m" }
*** '''Example''': Comm.Channel.Text { "channel": "newbie", "talker": "Olad", "text": "\u001b[0;1;32m(Newbie): You say, \"Hello.\"\u001b[0;37m" }

==== Room ====
* Sent by server:
** Room.Info
*** Contains information about the room that the player is in. Some of these may be IRE-specific
*** Message body is an object with the following keys
**** "num" - number identifying the room
**** "name" - string containing the brief description
**** "area" - string containing area name
**** "environment" - string containing environment type ("Hills", "Ocean", ...)
**** "coords" - room coordinates (string of numbers separated by commas - area,X,Y,X,building, building is optional
**** "map" - map information - URL pointing to a map image, followed by X and Y room (not pixel) coordinates on the map
**** "details" - array holding further information about a room - shop,bank,...
**** "exits" - object containing exits, each key is a direction and each value is the number identifying the target room
*** '''Example''': Room.Info {"num": 12345, "name": "On a hill", "area": "Barren hills", "environment": "Hills", "coords": "45,5,4,3", "map": "www.imperian.com/itex/maps/clientmap.php?map=45&level=3 5 4", "exits": { "n": 12344, "se": 12336 }, "details": [ "shop", "bank" ] }
** Room.WrongDir
*** Sent if the player attempts to move in a non-existant direction using the standard movement commands
*** Upon receiving this message, the client can safely assume that the specified direction does not lead anywhere at this time
*** Message body is a string with the name if the non-existant exit
*** Example: Room.WrongDir "ne"
** Room.Players
*** Object containing player details, each key is the short name of the player and each value is the full name including titles for the player
*** '''Example''': Room.Players [{ "name": "Tecton", "fullname": "Tecton the Terraformer" }, {"name": "Cardan", "fullname": "Cardan, the Curious" }]
** Room.AddPlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being added to the room.
*** '''Example''': Room.AddPlayer { "name": "Cardan", "fullname": "(Cardan, the Curious)" }
** Room.RemovePlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being removed from the room.
*** '''Example''': Room.RemovePlayer "Cardan"

==== Redirect ====
* Sent by server:
** Redirect.Window
*** Specifies a window to redirect further input to
*** Message body is a string specifying the window to redirect to
*** The main window is referred to as "main", and is the default if the message body is omitted or empty
*** Example: Redirect.Window "map"
==== IRE ====
===== IRE.Composer =====
* Sent by server:
** IRE.Composer.Edit
*** Sent by the server when the player enters an in-game editor. Body is an object, with keys "title" and "text". Text contains the current buffer, title is a title that can be shown to the user.
*** '''Example''': IRE.Composer.Edit { "title": "Composer", "text": "" }

* Sent by client:
** IRE.Composer.SetBuffer
*** Sent by the client upon successfully editing a text which was sent to the client in an IRE.Composer.Edit message earlier
*** Sending this message only changes the edit buffer, but does not end the editing session
*** On IRE games, the client may send the command ***save to save a text, or command ***quit to abort editing (IRE.Composer.SetBuffer is not sent in this case) - this behaviour is IRE-specific and is one of the reasons why the Composer module is in the IRE namespace
*** '''Example''': IRE.Composer.SetBuffer "This is a bunch of text."

===== IRE.Display =====
* Send by server:
** IRE.Display.FixedFont "start" | "stop"
*** Sent by the server to indicate between the start and stop messages should be displayed in a fixed-width font.
** IRE.Display.Ohmap "start" | "stop"
*** Sent by the server to indicated that an overhead map is being sent to the client.

===== IRE.Misc =====
* Sent by client:
** IRE.Misc.Voted
*** Informs the game a vote button was clicked.
*** Example: IRE.Misc.Voted ""

* Sent by server:
** IRE.Misc.RemindVote
*** Message sent to remind the player to vote.
*** '''Example''': IRE.Misc.RemindVote "http://www.imperian.com/vote"

** IRE.Misc.Achievement
*** Used to send basic achievement data to the client.
*** '''Example''': IRE.Misc.Achievement [{"name": "HighestLevelAchieved", "value": "89" }]

** IRE.Misc.URL
*** Sends a url to the client to open in a window when clicked.
*** '''Example''': IRE.Misc.URL[{"url": "http://www.imperian.com/tos", "window": "ire_game_tos" }]

** IRE.MISC.Tip
*** Sends a line of text to the client.
*** '''Example''': IRE.Misc.Tip "This is a tip!"

===== IRE.Rift =====
* Sent by server:
** IRE.Rift.List
*** contents of a Rift storage
*** sent upon receiving the IRE.Rift.Request message
*** message body is an array, with each element being an object containing three keys - "name" is item name, "amount" is a number holding the item's amount, and "desc" is user-visible description
** IRE.Rift.Change
*** sent whenever the item amount in a Rift changes
*** message body is an object with the same structure as one element of an array sent with the IRE.Rift.List message

* Sent by client:
** IRE.Rift.Request
*** asks the server to send the Rift contents using the IRE.Rift.List message

===== IRE.Sound =====

* Sent by server:
** IRE.Sound.Play
** IRE.Sound.Stop
** IRE.Sound.Stopall
** IRE.Sound.Preload

==== IRE.Target ====
* Sent by client:
** IRE.Target.Set
*** Sends the currently set target to the server to be used by the internal alias system.
*** '''Example''': IRE.Target.Set "1101"
* Sent by server

** IRE.Target.Set
*** Sends the target the client is trying to set. This is called from cycling targets with tab targeting.
*** '''Example''': IRE.Target.Set "1101"
** IRE.Target.Info
*** Sends an array with the current target information.
*** '''Example''': IRE.Target.Info { "id": "1101", "short_desc": "a brawny goblin smith", "hpperc": "100%" }
** IRE.Target.Request

===== IRE.Tasks =====

* Sent by client:
** IRE.Tasks.Request

* Sent by server:
** IRE.Tasks.List
*** This is used to send a list of quest, tasks, and achievements, depending on what the game supports.
*** Sends an array of items with the following keys:
**** id: A numeric identifier
**** name: The name of the quest, task, or achievement.
**** type: Is this a quest, task, or achievement.
**** cmd: The command to get more information for the quest. Good for MXP links.
**** desc: The description of the event.
**** status: 0 or 1 based on if it is completed or not.
**** group: What group should this be assigned to. This is mainly for client display purposes.
*** '''Example''': IRE.Tasks.List [ { "id": "184", "name": "For the sake of the village", "desc": "The herbs in Maeven's garden are painstakingly cared for so that her fellow villagers can stay healthy. She won't object to borrowing a bit of the magick power the bakuls have, if it can help with her work.\n\nThe bakul herbalist might have something Maeven wants.", "type": "quests", "cmd": "quest For the sake of the village", "status": "0", "group": "Current Quests" }, { "id": "313", "name": "Apostate", "desc": "Destroy a Shrine.", "type": "achievements", "cmd": "achievement apostate", "status": "0", "group": "Sects" } ]
** IRE.Tasks.Update
** IRE.Tasks.Completed

===== IRE.Time =====
* Sent by client:
** IRE.Time.Request

* Sent by server:
** IRE.Time.List
*** A list of the current time condition in the game world.
*** Used in the client to display the the day/night indicator.
*** '''Example''': IRE.Time.List { "day": "1", "mon": "1", "month": "Letum", "year": "98", "hour": "41", "daynight": "80" }
** IRE.Time.Update
*** Used to update time conditions.
*** '''Example''': IRE.Time.Update { "daynight": "112" }

GMCP

2018-05-31T20:57:52Z

Justin:

[[File:Aetolia-dwarf.jpg|right|frame|caption|Dwarf Terradrim from Aetolia.]] General MUD Telnet Protocol (GMCP) is a protocol used to send data from the game server to the player client. This data transfer happens behind the scenes and is not seen by the players. This allows the game server to send messages to the client to update basic character, room, and game information. Character health is an example of information that is continually passed to the client from the game.

These messages can also be accessed by the player for use in [[reflexes]]. We are working simplifying the process of capturing GMCP data for use in the client in a future version of the client.

There is a configuration option in the Advanced Settings tab that will allow you to see GMCP messages as they happen.

Module and message names are not case sensitive. JSON key names are case sensitive.

=== Supported modules ===

This documentation covers the following GMCP messages for the Iron Realms Games.

* Core: core functionality
* Char: information about a character
* Char.Afflictions: information the characters afflictions
* Char.Defences- information the characters defences
* Char.Items: information about items in inventory and room, with live updates
* Char.Skills: information about skills known by the player
* Comm.Channel: identification of communication channels and player lists
* Room: various information about the current room
* Redirect: redirect outpot to another window
* IRE.Composer: IRE-specific, used to edit bigger texts client-side
* IRE.Display: IRE-specific display information
* IRE.FileStore: used internally by the Nexus client
* IRE.Misc: used internally by the fMUD and Nexus clients
* IRE.Rift: IRE-specific, transmits information about the Rift contents
* IRE.Sound: Yes. Sound can be sent.
* IRE.Target: information about the current player target.
* IRE.Tasks: information about tasks, quests, and achievements.
* IRE.Time: information about the current time and date conditions in the game.
* IRE.Wiz: used internally by the Nexus client

=== Supported messages by modules ===

==== Core ====
* Sent by client:
** Core.Hello
*** Needs to be the first message that the client sends, used to identify the client
*** Message body is an object with keys "client" and "version", containing the client's name and version
*** '''Example''': Core.Hello {"Client":"Mudlet","Version":"3.0.0"}
** Core.Supports.Set
*** Notifies the server about packages supported by the client
*** If another Core.Supports.*** package has been received earlier, the list is deleted and replaced with the new one
*** Message body is an array of strings, each consisting of the module name and version, separated by space
*** Module version is a positive non-zero integer
*** Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins
*** '''Example''': Core.Supports.Set [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Add
*** Similar to Set, but appends the supported module list to the one sent earlier
*** If no list was sent yet, the behaviour is identical to Set
*** If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower
*** Message body format is identical to that of Set
*** '''Example''': Core.Supports.Add [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Remove
*** Removes specified modules from the list of supported modules
*** Message body format is similar to Set, except that module version numbers are optional and ignored if given
*** '''Example''': Core.Supports.Remove [ "Char", "Char.Skills", "Char.Items" ]
** Core.KeepAlive
*** Causes the server to reset the timeout for the logged character, no message body
** Core.Ping
*** causes the server to send a Core.Ping back
*** message body is a number which indicates average ping time from previous requests, if available
*** '''Example''': Core.Ping 120

* Sent by server:
** Core.Ping
*** Sent in reply to Core.Ping. No body.
** Core.Goodbye
*** Sent by server immediately before terminating a connection
*** Message body is a string to be shown to the user - it can explain the reason for the disconnect
*** '''Example''': Core.Goodbye "Goodbye, adventurer"

==== Char ====
* Sent by client:
** Char.Login
*** Used to log in a character, only interpreted if no character is logged in for that connection
*** Message body is an object with keys "name" and "password"
*** '''Example''': Char.Login { "name": "somename", "password": "somepassword" }

* Sent by server:
** Char.Name
*** Sends the character name and full name which includes the title. This is only sent on login.
*** '''Example''': Char.Name { "name": "Olad", "fullname": "Neophyte Olad" }
** Char.Vitals
*** Basic character attributes such as health, mana, etc.
*** Message body is an object containing several variables
*** Additionally, each variable is included in a string, in the format name:cur/max
*** Interpretation of the variables is game specific
*** It is generally safe to assume that the known values are numbers (even though encoded as strings), but other datatypes can be present
*** The "charstats" attribute, if present, holds a list of strings that the client may choose to display to the player in a client-specific way, these hold information about the character state that the game wishes to show to the player
*** '''Example''': Char.Vitals { "hp": "4500", "maxhp": "4800", "mp": "1200", "maxmp": "2500", "ep": "15000", "maxep": "16000", "wp": "14000", "maxwp": "15000", "nl": "10", "string": "H:4500/4800 M:1200/2500 E:15000/16000 W:14000/15000 NL:10/100" }
*** '''Additional Achaea Keys'''
**** All classes: Bleed, Rage
**** Apostates: Essence
**** Bard: Stance, Voice Balance
**** Blademaster: Stance
**** Druid: Current Morph, Sunlight Energy
**** Infernal: Essence, Weaponmastery Spec
**** Magi: Channels
**** Monk: Kai Energy, Tekura stance
**** Occultist: Karma, Entity Balance
**** Paladin: Devotion, Weaponmastery Spec
**** Priest: Devotion
**** Runewarden: Weaponmastery Spec
**** Sentinel: Current Morph
**** Serpent: Secreted Venom
**** Shaman: Number of spirits bound
**** Sylvan: Elemental Channels, Sunlight Energy
*** '''Additional Aetolia Keys'''
*** '''Additional Imperian Keys'''
**** General: bleed, flying, prone, stunned, dead, blind, phased, res_weakness, vote
**** Balances: leftarm, rightarm, health, herb, salve, toadstool, pipe, tree, focus, purge
**** Resources: kai, devotion, essence, fanatism, rage, fire, ice, faith, health_reserve, mana_reserve
**** Items: leftwield, leftwield_name, rightwield, rightwield_name, mount
** Char.StatusVars
*** Sent by server after a successful login or after the module is enabled
*** Contains a list of character variables (level, race, etc)
*** Message body is an object
*** Each object element is a name-caption pair, name is the internal name and caption the user-visible one
*** '''Example''': Char.StatusVars { "level": "Level", "race": "Race", "guild": "Guild" }
** Char.Status
*** Values of character values defined by StatusVars.
*** A full list is sent by server right after StatusVars, and changes are sent in subsequent messages as they occur.
*** With the exception of the initial Status message, messages only contain changed values; if a variable is not included, it has not changed since the previous Status message.
*** Message body is an object.
*** Each object element is a name-value pair, name is the internal name defined by the StatusVars message and value is the variable value.
*** '''Example''': Char.Status { "level": "58", "city": "Antioch" }
*** ''' Achaea Keys'''
**** name
**** fullname
**** age
**** race
**** specialisation
**** level
**** xp
**** xprank
**** class
**** city
**** house
**** order
**** boundcredits
**** unboundcredits
**** lessons
**** explorerrank
**** mayancrowns
**** boundmayancrowns
**** gold
**** bank
**** unread_msgs
**** unread_news
**** target
**** gender

===== Char.Afflictions =====
* Sent by server:
** Char.Afflictions.List
*** Sends an array of current character afflictions.
**** name: The name of the affliction
**** cure: The basic cure of the affliction. This is used for links to cure even though other options may exist to cure the affliction.
**** desc: A description of what this affliction does.
*** '''Example''': Char.Afflictions.List [ { "name": "weariness", "cure": "eat kelp", "desc": "Decreases cutting and blunt damage that you inflict by 30%." }, { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }, { "name": "slow herbs", "cure": "apply epidermal", "desc": "Increases the time needed to regain herb balance by 1.25 seconds." }, { "name": "nausea", "cure": "eat nightshade", "desc": "Causes periodic vomiting, which does damage and increases hunger." } ]
** Char.Afflictions.Add
*** Add an affliction to the character.
*** '''Example''': Char.Afflictions.Add { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }
** Char.Afflictions.Remove
*** Removes an affliction from the character.
*** '''Example''': Char.Afflictions.Remove [ "asthma" ]

===== Char.Defences=====
* Sent by server:
** Char.Defences.List
*** Send an array of all the defences a character currently has.
**** name: The name of the defence.
**** desc: The description of the defence.
*** '''Example''': Char.Defences.List [ { "name": "deaf", "desc": "deaf" }, { "name": "blind", "desc": "blind" }, { "name": "nightsight", "desc": "nightsight" } ]
** Char.Defences.Add
*** Sent when a defence is added to a character.
*** '''Example''': Char.Defences.Add { "name": "deaf", "desc": "deaf" }
** Char.Defences.Remove
*** Sent when a defence is removed from a character.
*** '''Example''': Char.Defences.Remove [ "blind" ]

===== Char.Items =====
* Sent by client:
** Char.Items.Contents
*** Request for the server to send the list of items located inside another item.
*** Message body is a number identifying the item.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Item.Contents 12345
** Char.Items.Inv
*** Request for the server to send the list of items in player's inventory.
*** Message body is empty.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Inv ""
** Char.Items.Room
*** Sent by the client to refresh the items in a room.
*** Message body is empty
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Room ""

* Sent by server:
** Char.Items.List
*** List of items at a specified location (room, inv, held container)
*** Message body is an object with keys "location" and "items"
*** Location value is a string, "inv", "room", or "repNUMBER" - the last one is container identification
*** Items value is an array, whose each item is an object with keys "id", "name" and optionally "attrib"
*** ID is a number identifying the item, name is a string containing a short player-visible item description
*** Icon is the image the item is associated with in the client.
*** Attrib is a string consisting of characters describing item properties:
**** "w" = worn,
**** "W" = wearable but not worn
**** "l" = wielded
**** "g" = groupable
**** "c" = container
**** "t" = takeable
**** "m" = monster
**** "d" = dead monster
**** "x" = should not be targeted (guards, ...)
*** '''Example''': Char.Items.List { "location": "inv", "items": [ { "id": "12807", "name": "a personal journal", "icon": "scroll", "attrib": "l" }, { "id": "303060", "name": "a gold nugget", "icon": "commodity" } ] }
** Char.Items.Add
*** Informs the client about an item being added to the specified location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an object with the same structure as one item from the items array of List
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "c" } }
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
*** '''Example''': Char.Items.Add { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity", "attrib": "t" } }
** Char.Items.Remove
*** Informs the client about an item being removed from the location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an integer value identifying the item
*** '''Example''': Char.Items.Remove { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "t" } }
*** '''Example''': Char.Items.Remove { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
** Char.Items.Update
*** Informs the client about an item's attributes being changed - only sent for inventory items
*** Message body syntax the same as with Add
*** '''Example''': Char.Items.Update { "location": "inv", "item": { "id": "60572", "name": "an ornate steel rapier" } }

===== Char.Skills =====
* Sent by client:
** Char.Skills.Get
*** Sent by client to request skill information
*** Message body is an object with keys "group" and "name"
*** If both group and name is provided, the server will send Char.Skills.Info for the specified skill
*** If group is provided but name is not, the server will send Char.Skills.List for that group
*** Otherwise the server will send Char.Skills.Groups
*** '''Example''': Char.Skills.Get {"group":"Perception"}
*** '''Example''': Char.Skills.Get {"group":"perception","name":"Deathsight"}

* Sent by server:
** Char.Skills.Groups
*** Groups of skills available to the character
*** Sent by server on request or at any time (usually if the list changes)
*** For IRE games, groups are skills like Survival or Elemancy
*** Message body is an array including the name and current rank of each skill the character has.
*** '''Example''': Char.Skills.Groups [ { "name": "Perception", "rank": "Transcendent (100%)" }, { "name": "Survival", "rank": "Inept (0%)" }, { "name": "Weaponry", "rank": "Inept (0%)" }, { "name": "Tattoos", "rank": "Inept (0%)" }, { "name": "Evasion", "rank": "Inept (0%)" }, { "name": "Engineering", "rank": "Inept (0%)" }, { "name": "Taming", "rank": "Inept (0%)" }, { "name": "Concoctions", "rank": "Inept (0%)" }, { "name": "Toxins", "rank": "Inept (0%)" }, { "name": "Smithing", "rank": "Inept (0%)" }, { "name": "Malignosis", "rank": "Adept (1%)" }, { "name": "Necromancy", "rank": "Inept (0%)" }, { "name": "Evileye", "rank": "Adept (40%)" } ]

** Char.Skills.List
*** List of skills in a group available to the character
*** Sent by server on request only
*** For IRE games, this is the list visible on AB <skillname>
*** Message body is an object with keys "group", "list", and "desc".
*** The list value is an array of strings, each being the name of one skill
*** '''Example''': Char.Skills.List { "group": "perception", "list": [ "Looking", "Glancing", "Secrets", "Decaylist", "Squinting", "Flyers", "Observe", "Farsight", "Containerlist", "Vigilance", "Treewatch", "Deathsight", "Pipelist", "Elixlist", "Search", "Letterlist", "Booklist", "Skywatch", "PowerNodes", "Keylist", "Alertness", "Rites", "Traps", "Magicklist", "Nightsight", "Hypersight", "Thirdeye", "Tattoos", "Discernment", "Wormholes", "Rivensense", "Contemplation", "Scan", "Telesense", "Appraise", "Trueassess", "Artifactlist", "Warning", "Viewshrine", "Landsense" ], "descs": [ "Gain knowledge of your immediate surroundings.", "See summarized information about your surroundings.", "Discover hidden exits.", "How much more time do those items have?", "See extended distances in your line of sight.", "Take notice of those in the skies.", "Gain information about your extended surroundings.", "Attempt to locate another player from afar.", "What do you have in your containers?", "Increase your resistance to hypnosis.", "Watch the forest canopies for movement.", "Attune yourself to the Underworld.", "Scan your pipes with utmost speed.", "Quickly discover what elixirs and salves you are holding.", "Search your location for hidden beings.", "Quick glance of all your letters.", "Scan the titles of books you own.", "Watch the skies for movement.", "Detect the nodes of power in your area.", "See a list of your keys and which doors they open.", "Heightened awareness of your surroundings.", "View the holy rites operating in your location.", "The ability to search for traps in your location.", "Check the status of your magickal items.", "Use infravision to see in the dark.", "See the actions of cloaked players.", "Give yourself the power of the third eye.", "Discover what tattoos are on another player.", "Discover what defences are protecting an individual.", "The ability to sense wormholes in your location.", "Sense the bodies of the recently slain.", "Perceive the state of another's mental strength.", "Seekout the locations of your allies and enemies.", "Heighten your awareness to telepathic attempts.", "Quickly take note of someone's carried possessions.", "Gain more detailed information concerning your foe.", "See what artifact powers surround an individual.", "Watch for the prying eyes of the enemy.", "Gain a detailed understanding of a shrine.", "The ability to recognize mortals entering the realm." ] }

** Char.Skills.Info
*** Information about a single skill, only sent upon request
*** Message body is an object, keys are "group", "skill", and "info", values are strings
*** Group and skill identify the request, info is a description (usually multi-line) of the skill's functionality and usage
*** '''Example''': Char.Skills.Info { "group": "perception", "skill": "deathsight", "info": "Syntax: DEATHSIGHT\n RELAX DEATHSIGHT\n\nUsing this ability, your mind is now capable of attuning itself to the realm of the dead. While doing so, you will be alerted whenever anyone dies." }
==== Comm.Channel ====
* Sent by client:
** Comm.Channel.Players
*** Request for the server to send Comm.Channel.Players
*** No message body.
*** '''Example''': Comm.Channel.Players ""
** Comm.Channel.Enable
*** Used to tell the game to turn on a character channel without typing in a command line command.
*** Example: Comm.Channel.Enable "newbie"
*** Example: Comm.Channel.Enable "clt Consortium"

* Sent by server:
** Comm.Channel.Players
*** List of players and organizations (city, guild, ...) that they share with this player
*** Message body is an array with each element describing one player
*** Each element is an object with keys "name" and "channels", name is a string, channels is an array
*** The channels array may be omitted if empty; if given, it is a list of organization names
*** '''Example''': Comm.Channel.Players [{"name": "Player1", "channels: ["Some city", "Some guild"]}, {"name": "Player2"}]
*** '''Example''': Comm.Channel.Players [ { "name": "Ahkan", "channels": [ "The City of Stavenn" ] }, { "name": "Sharatar", "channels": [ "The City of Stavenn", "The Revenants" ] } ]

** Comm.Channel.List
*** List of communication channels available to the player, sent on login/negotiation and if changed
*** Message body is an array of objects, each object representing one channel
*** Each object has keys "name", "caption" and "command" - name is internal name, caption is player-visible name, command is command used to communicate over this channel
*** '''Example''': Comm.Channel.List [{"name":"ct", "caption":"Some city", "command":"ct"}, {"name":"gt", "caption":"Some guild", "command":"gt"}]
*** '''Example''': Comm.Channel.List [ { "name": "newbie", "caption": "Newbie", "command": "newbie" }, { "name": "market", "caption": "Market", "command": "market" }, { "name": "ct", "caption": "Stavenn", "command": "ct" }, { "name": "gt", "caption": "Revenants", "command": "gt" } ]

** Comm.Channel.Start
*** Informs the client that text that follows is something said over a communication channel
*** Message body is a text containing the channel name
*** For tells from/to another player, the channel name is "tell Name"
*** '''Example''': Comm.Channel.Start "ct"
*** '''Example''' :Comm.Channel.Start "tell Jeremy"
** Comm.Channel.End
*** Ends a channel text started by Comm.Channel.Start
*** Message body is a text containing the channel name
*** '''Example''': Comm.Channel.End "tell Jeremy"

** Comm.Channel.Text
*** The text of the communication that you heard, who spoke, and which channel it was on
*** '''Example''': Comm.Channel.Text { "channel": "says", "talker": "Tecton", "text": "(Tecton the Terraformer says, \"Are we releasing dragon lairs or the phase artefact first?\"" }
*** '''Example''': Comm.Channel.Text { "channel": "tell Jeremy", "talker": "Olad", "text": "\u001b[0;1;33mYou tell Jeremy, \"Hi.\"\u001b[0;37m" }
*** '''Example''': Comm.Channel.Text { "channel": "newbie", "talker": "Olad", "text": "\u001b[0;1;32m(Newbie): You say, \"Hello.\"\u001b[0;37m" }

==== Room ====
* Sent by server:
** Room.Info
*** Contains information about the room that the player is in. Some of these may be IRE-specific
*** Message body is an object with the following keys
**** "num" - number identifying the room
**** "name" - string containing the brief description
**** "area" - string containing area name
**** "environment" - string containing environment type ("Hills", "Ocean", ...)
**** "coords" - room coordinates (string of numbers separated by commas - area,X,Y,X,building, building is optional
**** "map" - map information - URL pointing to a map image, followed by X and Y room (not pixel) coordinates on the map
**** "details" - array holding further information about a room - shop,bank,...
**** "exits" - object containing exits, each key is a direction and each value is the number identifying the target room
*** '''Example''': Room.Info {"num": 12345, "name": "On a hill", "area": "Barren hills", "environment": "Hills", "coords": "45,5,4,3", "map": "www.imperian.com/itex/maps/clientmap.php?map=45&level=3 5 4", "exits": { "n": 12344, "se": 12336 }, "details": [ "shop", "bank" ] }
** Room.WrongDir
*** Sent if the player attempts to move in a non-existant direction using the standard movement commands
*** Upon receiving this message, the client can safely assume that the specified direction does not lead anywhere at this time
*** Message body is a string with the name if the non-existant exit
*** Example: Room.WrongDir "ne"
** Room.Players
*** Object containing player details, each key is the short name of the player and each value is the full name including titles for the player
*** '''Example''': Room.Players [{ "name": "Tecton", "fullname": "Tecton the Terraformer" }, {"name": "Cardan", "fullname": "Cardan, the Curious" }]
** Room.AddPlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being added to the room.
*** '''Example''': Room.AddPlayer { "name": "Cardan", "fullname": "(Cardan, the Curious)" }
** Room.RemovePlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being removed from the room.
*** '''Example''': Room.RemovePlayer "Cardan"

==== Redirect ====
* Sent by server:
** Redirect.Window
*** Specifies a window to redirect further input to
*** Message body is a string specifying the window to redirect to
*** The main window is referred to as "main", and is the default if the message body is omitted or empty
*** Example: Redirect.Window "map"

==== IRE.Composer ====
* Sent by server:
** IRE.Composer.Edit
*** Sent by the server when the player enters an in-game editor. Body is an object, with keys "title" and "text". Text contains the current buffer, title is a title that can be shown to the user.
*** '''Example''': IRE.Composer.Edit { "title": "Composer", "text": "" }

* Sent by client:
** IRE.Composer.SetBuffer
*** Sent by the client upon successfully editing a text which was sent to the client in an IRE.Composer.Edit message earlier
*** Sending this message only changes the edit buffer, but does not end the editing session
*** On IRE games, the client may send the command ***save to save a text, or command ***quit to abort editing (IRE.Composer.SetBuffer is not sent in this case) - this behaviour is IRE-specific and is one of the reasons why the Composer module is in the IRE namespace
*** '''Example''': IRE.Composer.SetBuffer "This is a bunch of text."

==== IRE.Display ====
* Send by server:
** IRE.Display.FixedFont "start" | "stop"
*** Sent by the server to indicate between the start and stop messages should be displayed in a fixed-width font.
** IRE.Display.Ohmap "start" | "stop"
*** Sent by the server to indicated that an overhead map is being sent to the client.

==== IRE.Misc ====
* Sent by client:
** IRE.Misc.Voted
*** Informs the game a vote button was clicked.
*** Example: IRE.Misc.Voted ""

* Sent by server:
** IRE.Misc.RemindVote
*** Message sent to remind the player to vote.
*** '''Example''': IRE.Misc.RemindVote "http://www.imperian.com/vote"

** IRE.Misc.Achievement
*** Used to send basic achievement data to the client.
*** '''Example''': IRE.Misc.Achievement [{"name": "HighestLevelAchieved", "value": "89" }]

** IRE.Misc.URL
*** Sends a url to the client to open in a window when clicked.
*** '''Example''': IRE.Misc.URL[{"url": "http://www.imperian.com/tos", "window": "ire_game_tos" }]

** IRE.MISC.Tip
*** Sends a line of text to the client.
*** '''Example''': IRE.Misc.Tip "This is a tip!"

==== IRE.Rift ====
* Sent by server:
** IRE.Rift.List
*** contents of a Rift storage
*** sent upon receiving the IRE.Rift.Request message
*** message body is an array, with each element being an object containing three keys - "name" is item name, "amount" is a number holding the item's amount, and "desc" is user-visible description
** IRE.Rift.Change
*** sent whenever the item amount in a Rift changes
*** message body is an object with the same structure as one element of an array sent with the IRE.Rift.List message

* Sent by client:
** IRE.Rift.Request
*** asks the server to send the Rift contents using the IRE.Rift.List message

==== IRE.Sound ====

* Sent by server:
** IRE.Sound.Play
** IRE.Sound.Stop
** IRE.Sound.Stopall
** IRE.Sound.Preload

==== IRE.Target ====
* Sent by client:
** IRE.Target.Set
*** Sends the currently set target to the server to be used by the internal alias system.
*** '''Example''': IRE.Target.Set "1101"
* Sent by server

** IRE.Target.Set
*** Sends the target the client is trying to set. This is called from cycling targets with tab targeting.
*** '''Example''': IRE.Target.Set "1101"
** IRE.Target.Info
*** Sends an array with the current target information.
*** '''Example''': IRE.Target.Info { "id": "1101", "short_desc": "a brawny goblin smith", "hpperc": "100%" }
** IRE.Target.Request

==== IRE.Tasks ====

* Sent by client:
** IRE.Tasks.Request

* Sent by server:
** IRE.Tasks.List
*** This is used to send a list of quest, tasks, and achievements, depending on what the game supports.
*** Sends an array of items with the following keys:
**** id: A numeric identifier
**** name: The name of the quest, task, or achievement.
**** type: Is this a quest, task, or achievement.
**** cmd: The command to get more information for the quest. Good for MXP links.
**** desc: The description of the event.
**** status: 0 or 1 based on if it is completed or not.
**** group: What group should this be assigned to. This is mainly for client display purposes.
*** '''Example''': IRE.Tasks.List [ { "id": "184", "name": "For the sake of the village", "desc": "The herbs in Maeven's garden are painstakingly cared for so that her fellow villagers can stay healthy. She won't object to borrowing a bit of the magick power the bakuls have, if it can help with her work.\n\nThe bakul herbalist might have something Maeven wants.", "type": "quests", "cmd": "quest For the sake of the village", "status": "0", "group": "Current Quests" }, { "id": "313", "name": "Apostate", "desc": "Destroy a Shrine.", "type": "achievements", "cmd": "achievement apostate", "status": "0", "group": "Sects" } ]
** IRE.Tasks.Update
** IRE.Tasks.Completed

==== IRE.Time ====
* Sent by client:
** IRE.Time.Request

* Sent by server:
** IRE.Time.List
*** A list of the current time condition in the game world.
*** Used in the client to display the the day/night indicator.
*** '''Example''': IRE.Time.List { "day": "1", "mon": "1", "month": "Letum", "year": "98", "hour": "41", "daynight": "80" }
** IRE.Time.Update
*** Used to update time conditions.
*** '''Example''': IRE.Time.Update { "daynight": "112" }

GMCP

2018-05-31T20:40:27Z

Justin:

[[File:Aetolia-dwarf.jpg|right|frame|caption|Dwarf Terradrim from Aetolia.]] General MUD Telnet Protocol (GMCP) is a protocol used to send data from the game server to the player client. This data transfer happens behind the scenes and is not seen by the players. This allows the game server to send messages to the client to update basic character, room, and game information. Character health is an example of information that is continually passed to the client from the game.

These messages can also be accessed by the player for use in [[reflexes]]. We are working simplifying the process of capturing GMCP data for use in the client in a future version of the client.

There is a configuration option in the Advanced Settings tab that will allow you to see GMCP messages as they happen.

Module and message names are not case sensitive. JSON key names are case sensitive.

=== Supported modules ===

This documentation covers the following GMCP messages for the Iron Realms Games.

* Core: core functionality
* Char: information about a character
* Char.Afflictions: information the characters afflictions
* Char.Defences- information the characters defences
* Char.Items: information about items in inventory and room, with live updates
* Char.Skills: information about skills known by the player
* Comm.Channel: identification of communication channels and player lists
* Room: various information about the current room
* Redirect: redirect outpot to another window
* IRE.Composer: IRE-specific, used to edit bigger texts client-side
* IRE.Display: IRE-specific display information
* IRE.FileStore: used internally by the Nexus client
* IRE.Misc: used internally by the fMUD and Nexus clients
* IRE.Rift: IRE-specific, transmits information about the Rift contents
* IRE.Sound: Yes. Sound can be sent.
* IRE.Target: information about the current player target.
* IRE.Tasks: information about tasks, quests, and achievements.
* IRE.Time: information about the current time and date conditions in the game.
* IRE.Wiz: used internally by the Nexus client

=== Supported messages by modules ===

==== Core ====
* Sent by client:
** Core.Hello
*** Needs to be the first message that the client sends, used to identify the client
*** Message body is an object with keys "client" and "version", containing the client's name and version
*** '''Example''': Core.Hello {"Client":"Mudlet","Version":"3.0.0"}
** Core.Supports.Set
*** Notifies the server about packages supported by the client
*** If another Core.Supports.*** package has been received earlier, the list is deleted and replaced with the new one
*** Message body is an array of strings, each consisting of the module name and version, separated by space
*** Module version is a positive non-zero integer
*** Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins
*** '''Example''': Core.Supports.Set [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Add
*** Similar to Set, but appends the supported module list to the one sent earlier
*** If no list was sent yet, the behaviour is identical to Set
*** If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower
*** Message body format is identical to that of Set
*** '''Example''': Core.Supports.Add [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Remove
*** Removes specified modules from the list of supported modules
*** Message body format is similar to Set, except that module version numbers are optional and ignored if given
*** '''Example''': Core.Supports.Remove [ "Char", "Char.Skills", "Char.Items" ]
** Core.KeepAlive
*** Causes the server to reset the timeout for the logged character, no message body
** Core.Ping
*** causes the server to send a Core.Ping back
*** message body is a number which indicates average ping time from previous requests, if available
*** '''Example''': Core.Ping 120

* Sent by server:
** Core.Ping
*** Sent in reply to Core.Ping. No body.
** Core.Goodbye
*** Sent by server immediately before terminating a connection
*** Message body is a string to be shown to the user - it can explain the reason for the disconnect
*** '''Example''': Core.Goodbye "Goodbye, adventurer"

==== Char ====
* Sent by client:
** Char.Login
*** Used to log in a character, only interpreted if no character is logged in for that connection
*** Message body is an object with keys "name" and "password"
*** '''Example''': Char.Login { "name": "somename", "password": "somepassword" }

* Sent by server:
** Char.Name
*** Sends the character name and full name which includes the title. This is only sent on login.
*** '''Example''': Char.Name { "name": "Olad", "fullname": "Neophyte Olad" }
** Char.Vitals
*** Basic character attributes such as health, mana, etc.
*** Message body is an object containing several variables
*** Additionally, each variable is included in a string, in the format name:cur/max
*** Interpretation of the variables is game specific
*** It is generally safe to assume that the known values are numbers (even though encoded as strings), but other datatypes can be present
*** The "charstats" attribute, if present, holds a list of strings that the client may choose to display to the player in a client-specific way, these hold information about the character state that the game wishes to show to the player
*** '''Example''': Char.Vitals { "hp": "4500", "maxhp": "4800", "mp": "1200", "maxmp": "2500", "ep": "15000", "maxep": "16000", "wp": "14000", "maxwp": "15000", "nl": "10", "string": "H:4500/4800 M:1200/2500 E:15000/16000 W:14000/15000 NL:10/100" }
*** '''Additional Achaea Keys'''
**** All classes: Bleed, Rage
**** Apostates: Essence
**** Bard: Stance, Voice Balance
**** Blademaster: Stance
**** Druid: Current Morph, Sunlight Energy
**** Infernal: Essence, Weaponmastery Spec
**** Magi: Channels
**** Monk: Kai Energy, Tekura stance
**** Occultist: Karma, Entity Balance
**** Paladin: Devotion, Weaponmastery Spec
**** Priest: Devotion
**** Runewarden: Weaponmastery Spec
**** Sentinel: Current Morph
**** Serpent: Secreted Venom
**** Shaman: Number of spirits bound
**** Sylvan: Elemental Channels, Sunlight Energy
*** '''Additional Aetolia Keys'''
*** '''Additional Imperian Keys'''
**** General: bleed, flying, prone, stunned, dead, blind, phased, res_weakness, vote
**** Balances: leftarm, rightarm, health, herb, salve, toadstool, pipe, tree, focus, purge
**** Resources: kai, devotion, essence, fanatism, rage, fire, ice, faith, health_reserve, mana_reserve
**** Items: leftwield, leftwield_name, rightwield, rightwield_name, mount
** Char.StatusVars
*** Sent by server after a successful login or after the module is enabled
*** Contains a list of character variables (level, race, etc)
*** Message body is an object
*** Each object element is a name-caption pair, name is the internal name and caption the user-visible one
*** '''Example''': Char.StatusVars { "level": "Level", "race": "Race", "guild": "Guild" }
** Char.Status
*** Values of character values defined by StatusVars.
*** A full list is sent by server right after StatusVars, and changes are sent in subsequent messages as they occur.
*** With the exception of the initial Status message, messages only contain changed values; if a variable is not included, it has not changed since the previous Status message.
*** Message body is an object.
*** Each object element is a name-value pair, name is the internal name defined by the StatusVars message and value is the variable value.
*** '''Example''': Char.Status { "level": "58", "city": "Antioch" }
*** ''' Achaea Keys'''
**** name
**** fullname
**** age
**** race
**** specialisation
**** level
**** xp
**** xprank
**** class
**** city
**** house
**** order
**** boundcredits
**** unboundcredits
**** lessons
**** explorerrank
**** mayancrowns
**** boundmayancrowns
**** gold
**** bank
**** unread_msgs
**** unread_news
**** target
**** gender

==== Char.Afflictions ====
* Sent by server:
** Char.Afflictions.List
*** Sends an array of current character afflictions.
**** name: The name of the affliction
**** cure: The basic cure of the affliction. This is used for links to cure even though other options may exist to cure the affliction.
**** desc: A description of what this affliction does.
*** '''Example''': Char.Afflictions.List [ { "name": "weariness", "cure": "eat kelp", "desc": "Decreases cutting and blunt damage that you inflict by 30%." }, { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }, { "name": "slow herbs", "cure": "apply epidermal", "desc": "Increases the time needed to regain herb balance by 1.25 seconds." }, { "name": "nausea", "cure": "eat nightshade", "desc": "Causes periodic vomiting, which does damage and increases hunger." } ]
** Char.Afflictions.Add
*** Add an affliction to the character.
*** '''Example''': Char.Afflictions.Add { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }
** Char.Afflictions.Remove
*** Removes an affliction from the character.
*** '''Example''': Char.Afflictions.Remove [ "asthma" ]

==== Char.Defences====
* Sent by server:
** Char.Defences.List
*** Send an array of all the defences a character currently has.
**** name: The name of the defence.
**** desc: The description of the defence.
*** '''Example''': Char.Defences.List [ { "name": "deaf", "desc": "deaf" }, { "name": "blind", "desc": "blind" }, { "name": "nightsight", "desc": "nightsight" } ]
** Char.Defences.Add
*** Sent when a defence is added to a character.
*** '''Example''': Char.Defences.Add { "name": "deaf", "desc": "deaf" }
** Char.Defences.Remove
*** Sent when a defence is removed from a character.
*** '''Example''': Char.Defences.Remove [ "blind" ]

==== Char.Items ====
* Sent by client:
** Char.Items.Contents
*** Request for the server to send the list of items located inside another item.
*** Message body is a number identifying the item.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Item.Contents 12345
** Char.Items.Inv
*** Request for the server to send the list of items in player's inventory.
*** Message body is empty.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Inv ""
** Char.Items.Room
*** Sent by the client to refresh the items in a room.
*** Message body is empty
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Room ""

* Sent by server:
** Char.Items.List
*** List of items at a specified location (room, inv, held container)
*** Message body is an object with keys "location" and "items"
*** Location value is a string, "inv", "room", or "repNUMBER" - the last one is container identification
*** Items value is an array, whose each item is an object with keys "id", "name" and optionally "attrib"
*** ID is a number identifying the item, name is a string containing a short player-visible item description
*** Icon is the image the item is associated with in the client.
*** Attrib is a string consisting of characters describing item properties:
**** "w" = worn,
**** "W" = wearable but not worn
**** "l" = wielded
**** "g" = groupable
**** "c" = container
**** "t" = takeable
**** "m" = monster
**** "d" = dead monster
**** "x" = should not be targeted (guards, ...)
*** '''Example''': Char.Items.List { "location": "inv", "items": [ { "id": "12807", "name": "a personal journal", "icon": "scroll", "attrib": "l" }, { "id": "303060", "name": "a gold nugget", "icon": "commodity" } ] }
** Char.Items.Add
*** Informs the client about an item being added to the specified location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an object with the same structure as one item from the items array of List
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "c" } }
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
*** '''Example''': Char.Items.Add { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity", "attrib": "t" } }
** Char.Items.Remove
*** Informs the client about an item being removed from the location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an integer value identifying the item
*** '''Example''': Char.Items.Remove { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "t" } }
*** '''Example''': Char.Items.Remove { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
** Char.Items.Update
*** Informs the client about an item's attributes being changed - only sent for inventory items
*** Message body syntax the same as with Add
*** '''Example''': Char.Items.Update { "location": "inv", "item": { "id": "60572", "name": "an ornate steel rapier" } }

==== Char.Skills ====
* Sent by client:
** Char.Skills.Get
*** Sent by client to request skill information
*** Message body is an object with keys "group" and "name"
*** If both group and name is provided, the server will send Char.Skills.Info for the specified skill
*** If group is provided but name is not, the server will send Char.Skills.List for that group
*** Otherwise the server will send Char.Skills.Groups
*** '''Example''': Char.Skills.Get {"group":"Perception"}
*** '''Example''': Char.Skills.Get {"group":"perception","name":"Deathsight"}

* Sent by server:
** Char.Skills.Groups
*** Groups of skills available to the character
*** Sent by server on request or at any time (usually if the list changes)
*** For IRE games, groups are skills like Survival or Elemancy
*** Message body is an array including the name and current rank of each skill the character has.
*** '''Example''': Char.Skills.Groups [ { "name": "Perception", "rank": "Transcendent (100%)" }, { "name": "Survival", "rank": "Inept (0%)" }, { "name": "Weaponry", "rank": "Inept (0%)" }, { "name": "Tattoos", "rank": "Inept (0%)" }, { "name": "Evasion", "rank": "Inept (0%)" }, { "name": "Engineering", "rank": "Inept (0%)" }, { "name": "Taming", "rank": "Inept (0%)" }, { "name": "Concoctions", "rank": "Inept (0%)" }, { "name": "Toxins", "rank": "Inept (0%)" }, { "name": "Smithing", "rank": "Inept (0%)" }, { "name": "Malignosis", "rank": "Adept (1%)" }, { "name": "Necromancy", "rank": "Inept (0%)" }, { "name": "Evileye", "rank": "Adept (40%)" } ]

** Char.Skills.List
*** List of skills in a group available to the character
*** Sent by server on request only
*** For IRE games, this is the list visible on AB <skillname>
*** Message body is an object with keys "group", "list", and "desc".
*** The list value is an array of strings, each being the name of one skill
*** '''Example''': Char.Skills.List { "group": "perception", "list": [ "Looking", "Glancing", "Secrets", "Decaylist", "Squinting", "Flyers", "Observe", "Farsight", "Containerlist", "Vigilance", "Treewatch", "Deathsight", "Pipelist", "Elixlist", "Search", "Letterlist", "Booklist", "Skywatch", "PowerNodes", "Keylist", "Alertness", "Rites", "Traps", "Magicklist", "Nightsight", "Hypersight", "Thirdeye", "Tattoos", "Discernment", "Wormholes", "Rivensense", "Contemplation", "Scan", "Telesense", "Appraise", "Trueassess", "Artifactlist", "Warning", "Viewshrine", "Landsense" ], "descs": [ "Gain knowledge of your immediate surroundings.", "See summarized information about your surroundings.", "Discover hidden exits.", "How much more time do those items have?", "See extended distances in your line of sight.", "Take notice of those in the skies.", "Gain information about your extended surroundings.", "Attempt to locate another player from afar.", "What do you have in your containers?", "Increase your resistance to hypnosis.", "Watch the forest canopies for movement.", "Attune yourself to the Underworld.", "Scan your pipes with utmost speed.", "Quickly discover what elixirs and salves you are holding.", "Search your location for hidden beings.", "Quick glance of all your letters.", "Scan the titles of books you own.", "Watch the skies for movement.", "Detect the nodes of power in your area.", "See a list of your keys and which doors they open.", "Heightened awareness of your surroundings.", "View the holy rites operating in your location.", "The ability to search for traps in your location.", "Check the status of your magickal items.", "Use infravision to see in the dark.", "See the actions of cloaked players.", "Give yourself the power of the third eye.", "Discover what tattoos are on another player.", "Discover what defences are protecting an individual.", "The ability to sense wormholes in your location.", "Sense the bodies of the recently slain.", "Perceive the state of another's mental strength.", "Seekout the locations of your allies and enemies.", "Heighten your awareness to telepathic attempts.", "Quickly take note of someone's carried possessions.", "Gain more detailed information concerning your foe.", "See what artifact powers surround an individual.", "Watch for the prying eyes of the enemy.", "Gain a detailed understanding of a shrine.", "The ability to recognize mortals entering the realm." ] }

** Char.Skills.Info
*** Information about a single skill, only sent upon request
*** Message body is an object, keys are "group", "skill", and "info", values are strings
*** Group and skill identify the request, info is a description (usually multi-line) of the skill's functionality and usage
*** '''Example''': Char.Skills.Info { "group": "perception", "skill": "deathsight", "info": "Syntax: DEATHSIGHT\n RELAX DEATHSIGHT\n\nUsing this ability, your mind is now capable of attuning itself to the realm of the dead. While doing so, you will be alerted whenever anyone dies." }
==== Comm.Channel ====
* Sent by client:
** Comm.Channel.Players
*** Request for the server to send Comm.Channel.Players
*** No message body.
*** '''Example''': Comm.Channel.Players ""
** Comm.Channel.Enable
*** Used to tell the game to turn on a character channel without typing in a command line command.
*** Example: Comm.Channel.Enable "newbie"
*** Example: Comm.Channel.Enable "clt Consortium"

* Sent by server:
** Comm.Channel.Players
*** List of players and organizations (city, guild, ...) that they share with this player
*** Message body is an array with each element describing one player
*** Each element is an object with keys "name" and "channels", name is a string, channels is an array
*** The channels array may be omitted if empty; if given, it is a list of organization names
*** '''Example''': Comm.Channel.Players [{"name": "Player1", "channels: ["Some city", "Some guild"]}, {"name": "Player2"}]
*** '''Example''': Comm.Channel.Players [ { "name": "Ahkan", "channels": [ "The City of Stavenn" ] }, { "name": "Sharatar", "channels": [ "The City of Stavenn", "The Revenants" ] } ]

** Comm.Channel.List
*** List of communication channels available to the player, sent on login/negotiation and if changed
*** Message body is an array of objects, each object representing one channel
*** Each object has keys "name", "caption" and "command" - name is internal name, caption is player-visible name, command is command used to communicate over this channel
*** '''Example''': Comm.Channel.List [{"name":"ct", "caption":"Some city", "command":"ct"}, {"name":"gt", "caption":"Some guild", "command":"gt"}]
*** '''Example''': Comm.Channel.List [ { "name": "newbie", "caption": "Newbie", "command": "newbie" }, { "name": "market", "caption": "Market", "command": "market" }, { "name": "ct", "caption": "Stavenn", "command": "ct" }, { "name": "gt", "caption": "Revenants", "command": "gt" } ]

** Comm.Channel.Start
*** Informs the client that text that follows is something said over a communication channel
*** Message body is a text containing the channel name
*** For tells from/to another player, the channel name is "tell Name"
*** '''Example''': Comm.Channel.Start "ct"
*** '''Example''' :Comm.Channel.Start "tell Jeremy"
** Comm.Channel.End
*** Ends a channel text started by Comm.Channel.Start
*** Message body is a text containing the channel name
*** '''Example''': Comm.Channel.End "tell Jeremy"

** Comm.Channel.Text
*** The text of the communication that you heard, who spoke, and which channel it was on
*** '''Example''': Comm.Channel.Text { "channel": "says", "talker": "Tecton", "text": "(Tecton the Terraformer says, \"Are we releasing dragon lairs or the phase artefact first?\"" }
*** '''Example''': Comm.Channel.Text { "channel": "tell Jeremy", "talker": "Olad", "text": "\u001b[0;1;33mYou tell Jeremy, \"Hi.\"\u001b[0;37m" }
*** '''Example''': Comm.Channel.Text { "channel": "newbie", "talker": "Olad", "text": "\u001b[0;1;32m(Newbie): You say, \"Hello.\"\u001b[0;37m" }

==== Room ====
* Sent by server:
** Room.Info
*** Contains information about the room that the player is in. Some of these may be IRE-specific
*** Message body is an object with the following keys
**** "num" - number identifying the room
**** "name" - string containing the brief description
**** "area" - string containing area name
**** "environment" - string containing environment type ("Hills", "Ocean", ...)
**** "coords" - room coordinates (string of numbers separated by commas - area,X,Y,X,building, building is optional
**** "map" - map information - URL pointing to a map image, followed by X and Y room (not pixel) coordinates on the map
**** "details" - array holding further information about a room - shop,bank,...
**** "exits" - object containing exits, each key is a direction and each value is the number identifying the target room
*** '''Example''': Room.Info {"num": 12345, "name": "On a hill", "area": "Barren hills", "environment": "Hills", "coords": "45,5,4,3", "map": "www.imperian.com/itex/maps/clientmap.php?map=45&level=3 5 4", "exits": { "n": 12344, "se": 12336 }, "details": [ "shop", "bank" ] }
** Room.WrongDir
*** Sent if the player attempts to move in a non-existant direction using the standard movement commands
*** Upon receiving this message, the client can safely assume that the specified direction does not lead anywhere at this time
*** Message body is a string with the name if the non-existant exit
*** Example: Room.WrongDir "ne"
** Room.Players
*** Object containing player details, each key is the short name of the player and each value is the full name including titles for the player
*** '''Example''': Room.Players [{ "name": "Tecton", "fullname": "Tecton the Terraformer" }, {"name": "Cardan", "fullname": "Cardan, the Curious" }]
** Room.AddPlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being added to the room.
*** '''Example''': Room.AddPlayer { "name": "Cardan", "fullname": "(Cardan, the Curious)" }
** Room.RemovePlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being removed from the room.
*** '''Example''': Room.RemovePlayer "Cardan"

==== Redirect ====
* Sent by server:
** Redirect.Window
*** Specifies a window to redirect further input to
*** Message body is a string specifying the window to redirect to
*** The main window is referred to as "main", and is the default if the message body is omitted or empty
*** Example: Redirect.Window "map"

==== IRE.Composer ====
* Sent by server:
** IRE.Composer.Edit
*** Sent by the server when the player enters an in-game editor. Body is an object, with keys "title" and "text". Text contains the current buffer, title is a title that can be shown to the user.
*** '''Example''': IRE.Composer.Edit { "title": "Composer", "text": "" }

* Sent by client:
** IRE.Composer.SetBuffer
*** Sent by the client upon successfully editing a text which was sent to the client in an IRE.Composer.Edit message earlier
*** Sending this message only changes the edit buffer, but does not end the editing session
*** On IRE games, the client may send the command ***save to save a text, or command ***quit to abort editing (IRE.Composer.SetBuffer is not sent in this case) - this behaviour is IRE-specific and is one of the reasons why the Composer module is in the IRE namespace
*** '''Example''': IRE.Composer.SetBuffer "This is a bunch of text."

==== IRE.Display ====
* Send by server:
** IRE.Display.FixedFont "start" | "stop"
*** Sent by the server to indicate between the start and stop messages should be displayed in a fixed-width font.
** IRE.Display.Ohmap "start" | "stop"
*** Sent by the server to indicated that an overhead map is being sent to the client.

==== IRE.Misc ====
* Sent by client:
** IRE.Misc.Voted
*** Informs the game a vote button was clicked.
*** Example: IRE.Misc.Voted ""

* Sent by server:
** IRE.Misc.RemindVote
*** Message sent to remind the player to vote.
*** '''Example''': IRE.Misc.RemindVote "http://www.imperian.com/vote"

** IRE.Misc.Achievement
*** Used to send basic achievement data to the client.
*** '''Example''': IRE.Misc.Achievement [{"name": "HighestLevelAchieved", "value": "89" }]

** IRE.Misc.URL
*** Sends a url to the client to open in a window when clicked.
*** '''Example''': IRE.Misc.URL[{"url": "http://www.imperian.com/tos", "window": "ire_game_tos" }]

** IRE.MISC.Tip
*** Sends a line of text to the client.
*** '''Example''': IRE.Misc.Tip "This is a tip!"

==== IRE.Rift ====
* Sent by server:
** IRE.Rift.List
*** contents of a Rift storage
*** sent upon receiving the IRE.Rift.Request message
*** message body is an array, with each element being an object containing three keys - "name" is item name, "amount" is a number holding the item's amount, and "desc" is user-visible description
** IRE.Rift.Change
*** sent whenever the item amount in a Rift changes
*** message body is an object with the same structure as one element of an array sent with the IRE.Rift.List message

* Sent by client:
** IRE.Rift.Request
*** asks the server to send the Rift contents using the IRE.Rift.List message

==== IRE.Sound ====

* Sent by server:
** IRE.Sound.Play
** IRE.Sound.Stop
** IRE.Sound.Stopall
** IRE.Sound.Preload

==== IRE.Target ====
* Sent by client:
** IRE.Target.Set
*** Sends the currently set target to the server to be used by the internal alias system.
*** '''Example''': IRE.Target.Set "1101"
* Sent by server

** IRE.Target.Set
*** Sends the target the client is trying to set. This is called from cycling targets with tab targeting.
*** '''Example''': IRE.Target.Set "1101"
** IRE.Target.Info
*** Sends an array with the current target information.
*** '''Example''': IRE.Target.Info { "id": "1101", "short_desc": "a brawny goblin smith", "hpperc": "100%" }
** IRE.Target.Request

==== IRE.Tasks ====

* Sent by client:
** IRE.Tasks.Request

* Sent by server:
** IRE.Tasks.List
*** This is used to send a list of quest, tasks, and achievements, depending on what the game supports.
*** Sends an array of items with the following keys:
**** id: A numeric identifier
**** name: The name of the quest, task, or achievement.
**** type: Is this a quest, task, or achievement.
**** cmd: The command to get more information for the quest. Good for MXP links.
**** desc: The description of the event.
**** status: 0 or 1 based on if it is completed or not.
**** group: What group should this be assigned to. This is mainly for client display purposes.
*** '''Example''': IRE.Tasks.List [ { "id": "184", "name": "For the sake of the village", "desc": "The herbs in Maeven's garden are painstakingly cared for so that her fellow villagers can stay healthy. She won't object to borrowing a bit of the magick power the bakuls have, if it can help with her work.\n\nThe bakul herbalist might have something Maeven wants.", "type": "quests", "cmd": "quest For the sake of the village", "status": "0", "group": "Current Quests" }, { "id": "313", "name": "Apostate", "desc": "Destroy a Shrine.", "type": "achievements", "cmd": "achievement apostate", "status": "0", "group": "Sects" } ]
** IRE.Tasks.Update
** IRE.Tasks.Completed

==== IRE.Time ====
* Sent by client:
** IRE.Time.Request

* Sent by server:
** IRE.Time.List
*** A list of the current time condition in the game world.
*** Used in the client to display the the day/night indicator.
*** '''Example''': IRE.Time.List { "day": "1", "mon": "1", "month": "Letum", "year": "98", "hour": "41", "daynight": "80" }
** IRE.Time.Update
*** Used to update time conditions.
*** '''Example''': IRE.Time.Update { "daynight": "112" }

Nexus 2.0

2018-03-18T18:06:55Z

Justin: Starmourn

__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]

====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>

Simplified Scripting

2018-03-18T17:14:48Z

Justin: 2.10 updates

Simplified Scripting in Nexus allows users to create complex [[triggers]], [[aliases]], [[events]] and [[keybinds]] using a simple user interface. Previously this could only be accomplished with [[AdvancedScripting|advanced scripting]] options, which involves needing to know some amount of javascript.

There are 15 different actions you can use. Hide the line, Highlight and Rewrite cannot be used for aliases and keybinds, however.

== Send a command ==
This is the most basic and commonly used action. The trigger will automatically send text back to the game. In this example, the action will send ''attack rat'' when called.

[[File:action-send.png]]

== Show a notice ==
The action will just display a notice using whatever colors you choose. Typically players use these to get something to pop out at them so they know it has happened, but they may not want to automatically respond. In the example below, the game will display a bright red '''HIT HIM AGAIN''' when called.

[[File:action-notice.png]]

== Desktop Notification ==
The action is used to display a desktop notification when a trigger has fired. In the example below, we have created a trigger that will display a desktop notification when someone has entered the room with you.

[[File:action-notification.png]]

Here is an example of the notification that will appear.

[[File:action-notification-popup.png]]

== Play a sound ==
This action will allow you to play a sound when an event is triggered. In the example below, an alarm will sound whenever another player enters the room.

[[File:action-sound.png]]

== Wait ==
The wait action is usually used in conjunction with other actions. In the example below, we wait 3 seconds and then attack the rat.

[[File:action-wait.png]]

== Wait for ==
This action is essentially a temporary trigger. It allows you to specify a line or pattern to wait for. Once encountered, the script will continue executing normally. If not encountered within the specified timeout, the script is aborted.

In the example below we have created a simple trigger that will fire when the client receives the text 'You have regained your mental equilibrium.'. The first action will then cause the trigger to wait 10 seconds, looking to receive the text from the game, 'You have recovered balance.'.

If the trigger receives that text within 10 seconds, it will send the next action, which is set to send the command 'kick rabbit'.

[[File:action-wait-for.png]]

== Hide the line (or Gagging) ==
You can also opt to just hide any line that matches your trigger. Sometimes this is good for text that you see over and over again and are tired of reading.

This is also referred to as a gag or gagging.

[[File:action-hide.png]]

== Highlight ==
This will highlight the text you have matched. There are more options here to highlight the text around the trigger as well.

[[File:action-highlight.png]]

== Rewrite ==
A rewrite will change the trigger text into whatever your would like. Players will typically use this to shorten long messages in combat.

In the case below we are rewriting the text in the trigger to display a bright yellow, ''Balance back''.

[[File:action-rewrite.png]]

== Linkify ==
Linkify is similar to rewrite, and will change the trigger text into whatever your would like it to say. In addition it will make the text a clickable link, which can do whatever the user wants.

In the case below we are rewriting the text in the trigger to display the text 'Need to wake up!' and making it a link that will issue the command to 'wake'.

[[File:action-linkify.png]]

== Modify variable ==
The modify variable action is used to modify a certain variable. You can set it to a value, increase or decrease its value, assign the value of another variable to it, or modify it by the value of another variable. You can also assign the matched text or a captured part of it. It is a fairly flexible action.

In the example below we have created a trigger that will set the @EQ variable to a value of 1 when your character has regained mental equilibrium. In the example we also display the value of the @EQ variable so that we can make sure it is correctly set. This is probably very redundant, but is a simple example.

[[File:action-modify-variable.png]]

== If ==
This is one of the more powerful actions for reflexes. It will allow your reflexes to execute actions based on if certain conditions are true or not.

For example, you can compare two variables, or a variable and a fixed value. You can also compare against the matched text or a captured part of it. When the check succeeds or fails, you can choose whether the reflex should continue running normally, stop, or continue running from a Label action.

The example below is very simple. When a character recovers equilibrium it will check to see if the balance variable has been set to 1. The balance variable has been set to 1 or 0 from another reflex.

If the balance variable is 1, it will jump to the 'Yup' label and then show a notice that the character has both Balance and EQ.

If the balance variable is 0, it will jump to the 'Nope' label and show a notice that the character does not have Balance. It will then jump to the 'End' label.

If it did not just to the 'End' label it would also do the Yup label action and the 'You have Balance and EQ.' notice.

[[File:Action-if.png]]

== Repeat ==
This action allows you to repeat a block of actions multiple times. All actions up to a label that you specify will be repeated.

[[File:Action-repeat.png]]

== Label ==
This action does nothing at all. It is used together with the If, Repeat, and Jump to Label actions to do conditional execution and looping.

[[File:Action-label.png]]

== Jump to Label ==
This action causes a jump to the label of your choice. It is best used inside an If or Repeat block, so you don't create an endless loop (the client does offer protection against these).

The example below is absurd, but shows exactly how it functions. In this case the first action jumps right to the third action. Missing the second action completely.

[[File:Action-jump.png]]

== Disable this reflex ==
This simple action disables the current reflex. This is useful when creating reflexes that should only work once.

[[File:Action-disable.png]]

== Disable reflex ==
This action disables a reflex of your choice. The reflex must have a name. It can also disable entire groups of reflexes. In the example below we are disabling a group that contains all of our bashing reflexes.

[[File:Action-disable-reflex.png]]

== Enable reflex ==
This action enables a reflex of your choice. The reflex must have a name. It can also enable entire groups of reflexes. In the example below we are enabling a group that contains all of our bashing reflexes.

[[File:Action-enable-reflex.png]]

== Stop ==
This action will stop all actions after this point. Useful for testing and for use in IF actions.

[[File:Action-stop.png]]

== Modify a button ==
This action will allow you to modify any of the client's buttons. Options you can set here are:
* Change label - Change the text on the button
* Change command - Change the command sent to the game when the button is pressed
* Highlight - Set a button to be highlighted
* Unhighlight - Set a button to not be highlighted
* Reset to default - Set a button back to the default.

[[File:action_buttons.png]]

File:Action buttons.png

2018-03-18T17:14:08Z

Justin:

Simplified Scripting

2018-03-18T17:12:53Z

Justin: 2.10 changes

Settings

2018-03-18T17:08:28Z

Justin: /* Import/Export */

The client settings window can be accessed by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

There are 10 tabs in the settings window.

__TOC__

<div id="Display_Options"></div>
=== Display Options ===

The Display Options tab controls most of the basic settings of the client. Most options will demonstrate what will happen in the preview window to the right as they are checked and unchecked.

[[File:nexus_settings_210.jpg]]

<div id="Display_Options_Options"></div>
''Options''
* '''Output'''
** Display Font: You can change the font and the font size used by the client.
** Interface Style: This allows you to change what the client looks like. Currently you can select between standard and minimal, which is shown below.
[[File:Client_main_page_-_minimal_-_1280x1024.jpg]]
** Command Echo: When you type a command into the game to can opt to not display it. You can also set the color.
** Echo Target Changes: When you target something in the game, you can have it display that information.
** Add extra padding: Adds additional whitespace between lines, making it easier to read.
** Hide Chat Messages: You can opt not to show any chat messages in the main window. Chat will always display in the communication window.
** Show Inverted Colors: Invert the colors in the client. This will switch the black background to white.
** Prompt Lines: You can opt not to see your prompt at all. Your prompt typically displays health, mana, and balance. Although this varies from game to game.
** Only show the last prompt: Only display the most recent prompt at the bottom of the main display window.
** Plays Background Music: You can turn on/off the background music in the client. This does not effect other client sounds.
<div id="Display_Options_Interface"></div>
* '''Interface'''
** Movement Compass: Select your preference for displaying the movement compass in the client.
** Clear commands from the input bar after sending: This will automatically clear your command line after you press enter.
** Show HELP files in a new window: When looking at help files, a window will popup to let you read them.
** Show item numbers on room/inventory lists: When checked, this option will display the unique item number for all items in the game in your inventory and room windows.
** Reduced gauge height: This options will reduce the height of the gauges in the client, allowing more room for the output window.
** Display tooltips: Hide or display tooltips when hovering over parts of the main client window.
** Copy on Select: When copying text from the output window, it will automatically be copied to your computer's clipboard.
** Enable desktop notifications: This will notify you when something is happening in the game when the client isn't the active window/tab.
<div id="Display_Options_Timestamps"></div>
* '''Logging'''
** Show timestamps in logs - Toggle whether to show timestamps in logs.
** Prepend history on logging start - Add what is already in your output window to the top of the log when you start logging.
* '''Timestamps'''
** Show timestamps in the main output window: Display the time that each line in the game is received.
** Show timestamps in the main output scrollback: Display timestamps on each line when scrolling up the main output window.
** Show milliseconds on timestamps: Display timestamps down to the millisecond.

<div id="Colors"></div>

=== Colors ===
This window will allow you to set the colors sent from the game to the Nexus client to whatever your heart desires.

[[File:Settings_color.png]]

<div id="Buttons"></div>
=== Buttons ===
Nexus can have 6 to 12 buttons placed directly above the command line based on your preferences. When you character is first created it is populated with some basic commands. The buttons tab, allows you to set the number of buttons displayed and edit what each button does when clicked.

Below is an example of the button bar in the main client window.

[[File:Client_buttons.png]]

The buttons tab allows you to set the text for the button, a basic command, and a script should you desire. The commands can include [[aliases]] from your [[Reflexes|reflex]] settings. If you are running a script from the button, be sure to review the [[javascript]] page for more information.

[[File:Buttons_tab.png]]

<div id="Reflex_Packages"></div>
=== Reflex Packages ===

This tab will allow you to install packages from other players. Packages is a term used to describe groups of reflexes.

By default all characters come with the Numpad movement package. This package allows you to use the numpad to move around the game world.

If you would like to create your own package, click 'Add a package' and assign reflexes to that new package in your reflexes tab.

[[File:Settings_packages.png]]

<div id="Reflexes"></div>
=== Reflexes ===
Reflexes is an indepth subject and can be fully explained on [[Reflexes|its own page]].

<div id="Variables"></div>
=== Variables ===

A variable is alphabetic character representing a value or text that may be used in a reflex. For example, a user may store the number of a pack or the name of the last player that attacked them.

Variables can then be used by other reflexes by using the @ symbol and the variable name. For example, from the image below, @pack would be replaced with my pack number, 12345. @tar will be replaces with goblin.

[[File:Settings_variables.png]]

<div id="ImportExport"></div>
=== Import/Export ===

Your characters settings are saved on the game servers. This means that no matter what computer you play from, your character will load its latest settings.

There may be instances where you want to backup your settings. Especially if you are about to make radical changes to your reflexes and system. In that case, this tab will allow you to save your current settings you your own computer or load any settings you have previously saved.

WARNING: If you load previously saved setting from your computer, you will overwrite any changes you have made.

Additionally, we keep a backup of your settings from the last 9 days, allowing you to revert to an older version of your settings.

[[File:settings_importexport_210.png]]

<div id="Advanced"></div>

=== Advanced ===

Most of the advanced settings are never used. Explanations for the settings are below.

[[File:settings_advanced_210.png]]

* Settings
** Echo all GMCP messages: This will display all [[GMCP]] messages. This will be very spammy and is only needed if you are trying to debug problems.
** Echo trigger execution: This will echo all triggers as they happen. The more reflexes your character has, the more spammy this will be. Again, this is for debugging purposes.
** Log raw output to console
** Scrollback Limit: The more text stored in the scollback the more laggy the client can become. Increase at your own risk.
** Command Stack Delimiter: You can send multiple commands to the game by separating them with this character. By default is it the | character.

<div id="Feedback"></div>
=== Feedback ===
Hate us? Love us? Have a suggestions? Found a bug? Please send us your feedback.

<div id="help"></div>
=== Help ===
Some basic help on importing, exporting, saving, and loading your settings.

File:Settings importexport 210.png

2018-03-18T17:08:07Z

Justin:

Settings

2018-03-18T17:07:02Z

Justin:

The client settings window can be accessed by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

There are 10 tabs in the settings window.

__TOC__

<div id="Display_Options"></div>
=== Display Options ===

The Display Options tab controls most of the basic settings of the client. Most options will demonstrate what will happen in the preview window to the right as they are checked and unchecked.

[[File:nexus_settings_210.jpg]]

<div id="Display_Options_Options"></div>
''Options''
* '''Output'''
** Display Font: You can change the font and the font size used by the client.
** Interface Style: This allows you to change what the client looks like. Currently you can select between standard and minimal, which is shown below.
[[File:Client_main_page_-_minimal_-_1280x1024.jpg]]
** Command Echo: When you type a command into the game to can opt to not display it. You can also set the color.
** Echo Target Changes: When you target something in the game, you can have it display that information.
** Add extra padding: Adds additional whitespace between lines, making it easier to read.
** Hide Chat Messages: You can opt not to show any chat messages in the main window. Chat will always display in the communication window.
** Show Inverted Colors: Invert the colors in the client. This will switch the black background to white.
** Prompt Lines: You can opt not to see your prompt at all. Your prompt typically displays health, mana, and balance. Although this varies from game to game.
** Only show the last prompt: Only display the most recent prompt at the bottom of the main display window.
** Plays Background Music: You can turn on/off the background music in the client. This does not effect other client sounds.
<div id="Display_Options_Interface"></div>
* '''Interface'''
** Movement Compass: Select your preference for displaying the movement compass in the client.
** Clear commands from the input bar after sending: This will automatically clear your command line after you press enter.
** Show HELP files in a new window: When looking at help files, a window will popup to let you read them.
** Show item numbers on room/inventory lists: When checked, this option will display the unique item number for all items in the game in your inventory and room windows.
** Reduced gauge height: This options will reduce the height of the gauges in the client, allowing more room for the output window.
** Display tooltips: Hide or display tooltips when hovering over parts of the main client window.
** Copy on Select: When copying text from the output window, it will automatically be copied to your computer's clipboard.
** Enable desktop notifications: This will notify you when something is happening in the game when the client isn't the active window/tab.
<div id="Display_Options_Timestamps"></div>
* '''Logging'''
** Show timestamps in logs - Toggle whether to show timestamps in logs.
** Prepend history on logging start - Add what is already in your output window to the top of the log when you start logging.
* '''Timestamps'''
** Show timestamps in the main output window: Display the time that each line in the game is received.
** Show timestamps in the main output scrollback: Display timestamps on each line when scrolling up the main output window.
** Show milliseconds on timestamps: Display timestamps down to the millisecond.

<div id="Colors"></div>

=== Colors ===
This window will allow you to set the colors sent from the game to the Nexus client to whatever your heart desires.

[[File:Settings_color.png]]

<div id="Buttons"></div>
=== Buttons ===
Nexus can have 6 to 12 buttons placed directly above the command line based on your preferences. When you character is first created it is populated with some basic commands. The buttons tab, allows you to set the number of buttons displayed and edit what each button does when clicked.

Below is an example of the button bar in the main client window.

[[File:Client_buttons.png]]

The buttons tab allows you to set the text for the button, a basic command, and a script should you desire. The commands can include [[aliases]] from your [[Reflexes|reflex]] settings. If you are running a script from the button, be sure to review the [[javascript]] page for more information.

[[File:Buttons_tab.png]]

<div id="Reflex_Packages"></div>
=== Reflex Packages ===

This tab will allow you to install packages from other players. Packages is a term used to describe groups of reflexes.

By default all characters come with the Numpad movement package. This package allows you to use the numpad to move around the game world.

If you would like to create your own package, click 'Add a package' and assign reflexes to that new package in your reflexes tab.

[[File:Settings_packages.png]]

<div id="Reflexes"></div>
=== Reflexes ===
Reflexes is an indepth subject and can be fully explained on [[Reflexes|its own page]].

<div id="Variables"></div>
=== Variables ===

A variable is alphabetic character representing a value or text that may be used in a reflex. For example, a user may store the number of a pack or the name of the last player that attacked them.

Variables can then be used by other reflexes by using the @ symbol and the variable name. For example, from the image below, @pack would be replaced with my pack number, 12345. @tar will be replaces with goblin.

[[File:Settings_variables.png]]

<div id="ImportExport"></div>
=== Import/Export ===

Your characters settings are saved on the game servers. This means that no matter what computer you play from, your character will load its latest settings.

There may be instances where you want to backup your settings. Especially if you are about to make radical changes to your reflexes and system. In that case, this tab will allow you to save your current settings you your own computer or load any settings you have previously saved.

WARNING: If you load previously saved setting from your computer, you will overwrite any changes you have made.

Additionally, we keep a backup of your settings from the last 9 days, allowing you to revert to an older version of your settings.

[[File:Settings_import.png]]

<div id="Advanced"></div>
=== Advanced ===

Most of the advanced settings are never used. Explanations for the settings are below.

[[File:settings_advanced_210.png]]

* Settings
** Echo all GMCP messages: This will display all [[GMCP]] messages. This will be very spammy and is only needed if you are trying to debug problems.
** Echo trigger execution: This will echo all triggers as they happen. The more reflexes your character has, the more spammy this will be. Again, this is for debugging purposes.
** Log raw output to console
** Scrollback Limit: The more text stored in the scollback the more laggy the client can become. Increase at your own risk.
** Command Stack Delimiter: You can send multiple commands to the game by separating them with this character. By default is it the | character.

<div id="Feedback"></div>
=== Feedback ===
Hate us? Love us? Have a suggestions? Found a bug? Please send us your feedback.

<div id="help"></div>
=== Help ===
Some basic help on importing, exporting, saving, and loading your settings.

Settings

2018-03-18T17:04:57Z

Justin:

The client settings window can be accessed by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

There are 10 tabs in the settings window.

__TOC__

<div id="Display_Options"></div>
=== Display Options ===

The Display Options tab controls most of the basic settings of the client. Most options will demonstrate what will happen in the preview window to the right as they are checked and unchecked.

[[File:nexus_settings_210.jpg]]

<div id="Display_Options_Options"></div>
''Options''
* '''Output'''
** Display Font: You can change the font and the font size used by the client.
** Interface Style: This allows you to change what the client looks like. Currently you can select between standard and minimal, which is shown below.
[[File:Client_main_page_-_minimal_-_1280x1024.jpg]]
** Command Echo: When you type a command into the game to can opt to not display it. You can also set the color.
** Echo Target Changes: When you target something in the game, you can have it display that information.
** Add extra padding: Adds additional whitespace between lines, making it easier to read.
** Hide Chat Messages: You can opt not to show any chat messages in the main window. Chat will always display in the communication window.
** Show Inverted Colors: Invert the colors in the client. This will switch the black background to white.
** Prompt Lines: You can opt not to see your prompt at all. Your prompt typically displays health, mana, and balance. Although this varies from game to game.
** Only show the last prompt: Only display the most recent prompt at the bottom of the main display window.
** Plays Background Music: You can turn on/off the background music in the client. This does not effect other client sounds.
<div id="Display_Options_Interface"></div>
* '''Interface'''
** Movement Compass: Select your preference for displaying the movement compass in the client.
** Clear commands from the input bar after sending: This will automatically clear your command line after you press enter.
** Show HELP files in a new window: When looking at help files, a window will popup to let you read them.
** Show item numbers on room/inventory lists: When checked, this option will display the unique item number for all items in the game in your inventory and room windows.
** Reduced gauge height: This options will reduce the height of the gauges in the client, allowing more room for the output window.
** Display tooltips: Hide or display tooltips when hovering over parts of the main client window.
** Copy on Select: When copying text from the output window, it will automatically be copied to your computer's clipboard.
** Enable desktop notifications: This will notify you when something is happening in the game when the client isn't the active window/tab.
<div id="Display_Options_Timestamps"></div>
* '''Logging'''
** Show timestamps in logs - Toggle whether to show timestamps in logs.
** Prepend history on logging start - Add what is already in your output window to the top of the log when you start logging.
* '''Timestamps'''
** Show timestamps in the main output window: Display the time that each line in the game is received.
** Show timestamps in the main output scrollback: Display timestamps on each line when scrolling up the main output window.
** Show milliseconds on timestamps: Display timestamps down to the millisecond.

<div id="Colors"></div>

=== Colors ===
This window will allow you to set the colors sent from the game to the Nexus client to whatever your heart desires.

[[File:Settings_color.png]]

<div id="Buttons"></div>
=== Buttons ===
Nexus can have 6 to 12 buttons placed directly above the command line based on your preferences. When you character is first created it is populated with some basic commands. The buttons tab, allows you to set the number of buttons displayed and edit what each button does when clicked.

Below is an example of the button bar in the main client window.

[[File:Client_buttons.png]]

The buttons tab allows you to set the text for the button, a basic command, and a script should you desire. The commands can include [[aliases]] from your [[Reflexes|reflex]] settings. If you are running a script from the button, be sure to review the [[javascript]] page for more information.

[[File:Buttons_tab.png]]

<div id="Reflex_Packages"></div>
=== Reflex Packages ===

This tab will allow you to install packages from other players. Packages is a term used to describe groups of reflexes.

By default all characters come with the Numpad movement package. This package allows you to use the numpad to move around the game world.

If you would like to create your own package, click 'Add a package' and assign reflexes to that new package in your reflexes tab.

[[File:Settings_packages.png]]

<div id="Reflexes"></div>
=== Reflexes ===
Reflexes is an indepth subject and can be fully explained on [[Reflexes|its own page]].

<div id="Variables"></div>
=== Variables ===

A variable is alphabetic character representing a value or text that may be used in a reflex. For example, a user may store the number of a pack or the name of the last player that attacked them.

Variables can then be used by other reflexes by using the @ symbol and the variable name. For example, from the image below, @pack would be replaced with my pack number, 12345. @tar will be replaces with goblin.

[[File:Settings_variables.png]]

<div id="ImportExport"></div>
=== Import/Export ===

Your characters settings are saved on the game servers. This means that no matter what computer you play from, your character will load its latest settings.

There may be instances where you want to backup your settings. Especially if you are about to make radical changes to your reflexes and system. In that case, this tab will allow you to save your current settings you your own computer or load any settings you have previously saved.

WARNING: If you load previously saved setting from your computer, you will overwrite any changes you have made.

[[File:Settings_import.png]]

<div id="Advanced"></div>
=== Advanced ===

Most of the advanced settings are never used. Explanations for the settings are below.

[[File:settings_advanced_210.png]]

* Settings
** Echo all GMCP messages: This will display all [[GMCP]] messages. This will be very spammy and is only needed if you are trying to debug problems.
** Echo trigger execution: This will echo all triggers as they happen. The more reflexes your character has, the more spammy this will be. Again, this is for debugging purposes.
** Log raw output to console
** Scrollback Limit: The more text stored in the scollback the more laggy the client can become. Increase at your own risk.
** Command Stack Delimiter: You can send multiple commands to the game by separating them with this character. By default is it the | character.

<div id="Feedback"></div>
=== Feedback ===
Hate us? Love us? Have a suggestions? Found a bug? Please send us your feedback.

<div id="help"></div>
=== Help ===
Some basic help on importing, exporting, saving, and loading your settings.

File:Settings advanced 210.png

2018-03-18T17:04:26Z

Justin:

Settings

2018-03-18T16:57:21Z

Justin:

The client settings window can be accessed by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

There are 10 tabs in the settings window.

__TOC__

<div id="Display_Options"></div>
=== Display Options ===

The Display Options tab controls most of the basic settings of the client. Most options will demonstrate what will happen in the preview window to the right as they are checked and unchecked.

[[File:nexus_settings_210.jpg]]

<div id="Display_Options_Options"></div>
''Options''
* '''Output'''
** Display Font: You can change the font and the font size used by the client.
** Interface Style: This allows you to change what the client looks like. Currently you can select between standard and minimal, which is shown below.
[[File:Client_main_page_-_minimal_-_1280x1024.jpg]]
** Command Echo: When you type a command into the game to can opt to not display it. You can also set the color.
** Echo Target Changes: When you target something in the game, you can have it display that information.
** Add extra padding: Adds additional whitespace between lines, making it easier to read.
** Hide Chat Messages: You can opt not to show any chat messages in the main window. Chat will always display in the communication window.
** Show Inverted Colors: Invert the colors in the client. This will switch the black background to white.
** Prompt Lines: You can opt not to see your prompt at all. Your prompt typically displays health, mana, and balance. Although this varies from game to game.
** Only show the last prompt: Only display the most recent prompt at the bottom of the main display window.
** Plays Background Music: You can turn on/off the background music in the client. This does not effect other client sounds.
<div id="Display_Options_Interface"></div>
* '''Interface'''
** Movement Compass: Select your preference for displaying the movement compass in the client.
** Clear commands from the input bar after sending: This will automatically clear your command line after you press enter.
** Show HELP files in a new window: When looking at help files, a window will popup to let you read them.
** Show item numbers on room/inventory lists: When checked, this option will display the unique item number for all items in the game in your inventory and room windows.
** Reduced gauge height: This options will reduce the height of the gauges in the client, allowing more room for the output window.
** Display tooltips: Hide or display tooltips when hovering over parts of the main client window.
** Copy on Select: When copying text from the output window, it will automatically be copied to your computer's clipboard.
** Enable desktop notifications: This will notify you when something is happening in the game when the client isn't the active window/tab.
<div id="Display_Options_Timestamps"></div>
* '''Logging'''
** Show timestamps in logs - Toggle whether to show timestamps in logs.
** Prepend history on logging start - Add what is already in your output window to the top of the log when you start logging.
* '''Timestamps'''
** Show timestamps in the main output window: Display the time that each line in the game is received.
** Show timestamps in the main output scrollback: Display timestamps on each line when scrolling up the main output window.
** Show milliseconds on timestamps: Display timestamps down to the millisecond.

<div id="Colors"></div>

=== Colors ===
This window will allow you to set the colors sent from the game to the Nexus client to whatever your heart desires.

[[File:Settings_color.png]]

<div id="Buttons"></div>
=== Buttons ===
Nexus can have 6 to 12 buttons placed directly above the command line based on your preferences. When you character is first created it is populated with some basic commands. The buttons tab, allows you to set the number of buttons displayed and edit what each button does when clicked.

Below is an example of the button bar in the main client window.

[[File:Client_buttons.png]]

The buttons tab allows you to set the text for the button, a basic command, and a script should you desire. The commands can include [[aliases]] from your [[Reflexes|reflex]] settings. If you are running a script from the button, be sure to review the [[javascript]] page for more information.

[[File:Buttons_tab.png]]

<div id="Reflex_Packages"></div>
=== Reflex Packages ===

This tab will allow you to install packages from other players. Packages is a term used to describe groups of reflexes.

By default all characters come with the Numpad movement package. This package allows you to use the numpad to move around the game world.

If you would like to create your own package, click 'Add a package' and assign reflexes to that new package in your reflexes tab.

[[File:Settings_packages.png]]

<div id="Reflexes"></div>
=== Reflexes ===
Reflexes is an indepth subject and can be fully explained on [[Reflexes|its own page]].

<div id="Variables"></div>
=== Variables ===

A variable is alphabetic character representing a value or text that may be used in a reflex. For example, a user may store the number of a pack or the name of the last player that attacked them.

Variables can then be used by other reflexes by using the @ symbol and the variable name. For example, from the image below, @pack would be replaced with my pack number, 12345. @tar will be replaces with goblin.

[[File:Settings_variables.png]]

<div id="ImportExport"></div>
=== Import/Export ===

Your characters settings are saved on the game servers. This means that no matter what computer you play from, your character will load its latest settings.

There may be instances where you want to backup your settings. Especially if you are about to make radical changes to your reflexes and system. In that case, this tab will allow you to save your current settings you your own computer or load any settings you have previously saved.

WARNING: If you load previously saved setting from your computer, you will overwrite any changes you have made.

[[File:Settings_import.png]]

<div id="Advanced"></div>
=== Advanced ===

Most of the advanced settings are never used. Explanations for the settings are below.

[[File:Settings_advances.png]]

* Settings
** Echo all GMCP messages: This will display all [[GMCP]] messages. This will be very spammy and is only needed if you are trying to debug problems.
** Echo trigger execution: This will echo all triggers as they happen. The more reflexes your character has, the more spammy this will be. Again, this is for debugging purposes.
** Log raw output to console
** Scrollback Limit: The more text stored in the scollback the more laggy the client can become. Increase at your own risk.
** Command Stack Delimiter: You can send multiple commands to the game by separating them with this character. By default is it the | character.

<div id="Feedback"></div>
=== Feedback ===
Hate us? Love us? Have a suggestions? Found a bug? Please send us your feedback.

<div id="help"></div>
=== Help ===
Some basic help on importing, exporting, saving, and loading your settings.

Settings

2018-03-18T16:55:46Z

Justin: 2.10 Updates

The client settings window can be accessed by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

There are 10 tabs in the settings window.

__TOC__

<div id="Display_Options"></div>
=== Display Options ===

The Display Options tab controls most of the basic settings of the client. Most options will demonstrate what will happen in the preview window to the right as they are checked and unchecked.

[[File:nexus_settings_210.jpg]]

<div id="Display_Options_Options"></div>
''Options''
* '''Output'''
** Display Font: You can change the font and the font size used by the client.
** Interface Style: This allows you to change what the client looks like. Currently you can select between standard and minimal, which is shown below.
[[File:Client_main_page_-_minimal_-_1280x1024.jpg]]
** Command Echo: When you type a command into the game to can opt to not display it. You can also set the color.
** Echo Target Changes: When you target something in the game, you can have it display that information.
** Add extra padding: Adds additional whitespace between lines, making it easier to read.
** Hide Chat Messages: You can opt not to show any chat messages in the main window. Chat will always display in the communication window.
** Show Inverted Colors: Invert the colors in the client. This will switch the black background to white.
** Prompt Lines: You can opt not to see your prompt at all. Your prompt typically displays health, mana, and balance. Although this varies from game to game.
** Only show the last prompt: Only display the most recent prompt at the bottom of the main display window.
** Plays Background Music: You can turn on/off the background music in the client. This does not effect other client sounds.
<div id="Display_Options_Interface"></div>
* '''Interface'''
** Movement Compass: Select your preference for displaying the movement compass in the client.
** Clear commands from the input bar after sending: This will automatically clear your command line after you press enter.
** Show HELP files in a new window: When looking at help files, a window will popup to let you read them.
** Show item numbers on room/inventory lists: When checked, this option will display the unique item number for all items in the game in your inventory and room windows.
** Reduced gauge height: This options will reduce the height of the gauges in the client, allowing more room for the output window.
** Display tooltips: Hide or display tooltips when hovering over parts of the main client window.
** Copy on Select: When copying text from the output window, it will automatically be copied to your computer's clipboard.
** Enable desktop notifications: This will notify you when something is happening in the game when the client isn't the active window/tab.
<div id="Display_Options_Timestamps"></div>
* '''Logging'''
** Show timestamps in logs - Toggle whether to show timestamps in logs.
** Prepend history on logging start - Add what is already in your output window to the top of the log when you start logging.
* '''Timestamps'''
** Show timestamps in the main output window: Display the time that each line in the game is received.
** Show timestamps in the main output scrollback: Display timestamps on each line when scrolling up the main output window.
** Show milliseconds on timestamps: Display timestamps down to the millisecond.

<div id="Colors"></div>

=== Colors ===
This window will allow you to set the colors sent from the game to the Nexus client to whatever your heart desires.

[[File:Settings_color.png]]

<div id="Buttons"></div>
=== Buttons ===
Nexus can have 6 to 12 buttons placed directly above the command line based on your preferences. When you character is first created it is populated with some basic commands. The buttons tab, allows you to set the number of buttons displayed and edit what each button does when clicked.

Below is an example of the button bar in the main client window.

[[File:Client_buttons.png]]

The buttons tab allows you to set the text for the button, a basic command, and a script should you desire. The commands can include [[aliases]] from your [[Reflexes|reflex]] settings. If you are running a script from the button, be sure to review the [[javascript]] page for more information.

[[File:Buttons_tab.png]]

<div id="Reflex_Packages"></div>
=== Reflex Packages ===

This tab will allow you to install packages from other players. Packages is a term used to describe groups of reflexes.

By default all characters come with the Numpad movement package. This package allows you to use the numpad to move around the game world.

If you would like to create your own package, click 'Add a package' and assign reflexes to that new package in your reflexes tab.

[[File:Settings_packages.png]]

<div id="Reflexes"></div>
=== Reflexes ===
Reflexes is an indepth subject and can be fully explained on [[Reflexes|its own page]].

<div id="Variables"></div>
=== Variables ===

A variable is alphabetic character representing a value or text that may be used in a reflex. For example, a user may store the number of a pack or the name of the last player that attacked them.

Variables can then be used by other reflexes by using the @ symbol and the variable name. For example, from the image below, @pack would be replaced with my pack number, 12345. @tar will be replaces with goblin.

[[File:Settings_variables.png]]

<div id="ImportExport"></div>
=== Import/Export ===

Your characters settings are saved on the game servers. This means that no matter what computer you play from, your character will load its latest settings.

There may be instances where you want to backup your settings. Especially if you are about to make radical changes to your reflexes and system. In that case, this tab will allow you to save your current settings you your own computer or load any settings you have previously saved.

WARNING: If you load previously saved setting from your computer, you will overwrite any changes you have made.

[[File:Settings_import.png]]

<div id="Advances"></div>
=== Advanced ===

Most of the advanced settings are never used. Explanations for the settings are below.

[[File:Settings_advances.png]]

* Settings
** Echo all GMCP messages: This will display all [[GMCP]] messages. This will be very spammy and is only needed if you are trying to debug problems.
** Echo trigger execution: This will echo all triggers as they happen. The more reflexes your character has, the more spammy this will be. Again, this is for debugging purposes.
** Log raw output to console
** Use Secure WebSockets: Experimental
** Scrollback Limit: The more text stored in the scollback the more laggy the client can become. Increase at your own risk.
** Command Stack Delimiter: You can send multiple commands to the game by separating them with this character. By default is it the | character.

<div id="Feedback"></div>
=== Feedback ===
Hate us? Love us? Have a suggestions? Found a bug? Please send us your feedback.

<div id="help"></div>
=== Help ===
Some basic help on importing, exporting, saving, and loading your settings.

Settings

2018-03-18T16:51:09Z

Justin: /* Display Options */

The client settings window can be accessed by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

There are 10 tabs in the settings window.

__TOC__

<div id="Display_Options"></div>
=== Display Options ===

The Display Options tab controls most of the basic settings of the client. Most options will demonstrate what will happen in the preview window to the right as they are checked and unchecked.

[[File:nexus_settings_210.jpg]]

<div id="Display_Options_Options"></div>
''Options''
* '''Output'''
** Display Font: You can change the font and the font size used by the client.
** Interface Style: This allows you to change what the client looks like. Currently you can select between standard and minimal, which is shown below.
[[File:Client_main_page_-_minimal_-_1280x1024.jpg]]
** Command Echo: When you type a command into the game to can opt to not display it. You can also set the color.
** Echo Target Changes: When you target something in the game, you can have it display that information.
** Hide Chat Messages: You can opt not to show any chat messages in the main window. Chat will always display in the communication window.
** Show Inverted Colors: Invert the colors in the client. This will switch the black background to white.
** Prompt Lines: You can opt not to see your prompt at all. Your prompt typically displays health, mana, and balance. Although this varies from game to game.
** Only show the last prompt: Only display the most recent prompt at the bottom of the main display window.
** Plays Background Music: You can turn on/off the background music in the client. This does not effect other client sounds.
<div id="Display_Options_Interface"></div>
* '''Interface'''
** Movement Compass: Select your preference for displaying the movement compass in the client.
** Clear commands from the input bar after sending: This will automatically clear your command line after you press enter.
** Show HELP files in a new window: When looking at help files, a window will popup to let you read them.
** Show item numbers on room/inventory lists: When checked, this option will display the unique item number for all items in the game in your inventory and room windows.
** Reduced gauge height: This options will reduce the height of the gauges in the client, allowing more room for the output window.
** Display tooltips: Hide or display tooltips when hovering over parts of the main client window.
** Enable desktop notifications: This will notify you when something is happening in the game.
<div id="Display_Options_Timestamps"></div>
* '''Timestamps'''
** Show timestamps in the main output window: Display the time that each line in the game is received.
** Show timestamps in the main output scrollback: Display timestamps on each line when scrolling up the main output window.
** Show milliseconds on timestamps: Display timestamps down to the millisecond.

<div id="Colors"></div>

=== Colors ===
This window will allow you to set the colors sent from the game to the Nexus client to whatever your heart desires.

[[File:Settings_color.png]]

<div id="Buttons"></div>
=== Buttons ===
Nexus can have 6 to 12 buttons placed directly above the command line based on your preferences. When you character is first created it is populated with some basic commands. The buttons tab, allows you to set the number of buttons displayed and edit what each button does when clicked.

Below is an example of the button bar in the main client window.

[[File:Client_buttons.png]]

The buttons tab allows you to set the text for the button, a basic command, and a script should you desire. The commands can include [[aliases]] from your [[Reflexes|reflex]] settings. If you are running a script from the button, be sure to review the [[javascript]] page for more information.

[[File:Buttons_tab.png]]

<div id="Reflex_Packages"></div>
=== Reflex Packages ===

This tab will allow you to install packages from other players. Packages is a term used to describe groups of reflexes.

By default all characters come with the Numpad movement package. This package allows you to use the numpad to move around the game world.

If you would like to create your own package, click 'Add a package' and assign reflexes to that new package in your reflexes tab.

[[File:Settings_packages.png]]

<div id="Reflexes"></div>
=== Reflexes ===
Reflexes is an indepth subject and can be fully explained on [[Reflexes|its own page]].

<div id="Variables"></div>
=== Variables ===

A variable is alphabetic character representing a value or text that may be used in a reflex. For example, a user may store the number of a pack or the name of the last player that attacked them.

Variables can then be used by other reflexes by using the @ symbol and the variable name. For example, from the image below, @pack would be replaced with my pack number, 12345. @tar will be replaces with goblin.

[[File:Settings_variables.png]]

<div id="ImportExport"></div>
=== Import/Export ===

Your characters settings are saved on the game servers. This means that no matter what computer you play from, your character will load its latest settings.

There may be instances where you want to backup your settings. Especially if you are about to make radical changes to your reflexes and system. In that case, this tab will allow you to save your current settings you your own computer or load any settings you have previously saved.

WARNING: If you load previously saved setting from your computer, you will overwrite any changes you have made.

[[File:Settings_import.png]]

<div id="Advances"></div>
=== Advanced ===

Most of the advanced settings are never used. Explanations for the settings are below.

[[File:Settings_advances.png]]

* Settings
** Echo all GMCP messages: This will display all [[GMCP]] messages. This will be very spammy and is only needed if you are trying to debug problems.
** Echo trigger execution: This will echo all triggers as they happen. The more reflexes your character has, the more spammy this will be. Again, this is for debugging purposes.
** Log raw output to console
** Use Secure WebSockets: Experimental
** Scrollback Limit: The more text stored in the scollback the more laggy the client can become. Increase at your own risk.
** Command Stack Delimiter: You can send multiple commands to the game by separating them with this character. By default is it the | character.

<div id="Feedback"></div>
=== Feedback ===
Hate us? Love us? Have a suggestions? Found a bug? Please send us your feedback.

<div id="help"></div>
=== Help ===
Some basic help on importing, exporting, saving, and loading your settings.

File:Nexus settings 210.jpg

2018-03-18T16:50:15Z

Justin: Settings window in Nexus 2.10

Settings window in Nexus 2.10

Functions

2018-03-18T16:45:02Z

Justin:

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.

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

Functions

2018-03-18T16:44:39Z

Justin:

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.

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

WildcardMatching

2018-03-12T17:03:17Z

Justin:

This trigger captures the name and incoming direction for a player when they enter the room, using the [[Variables|variables]]: <person> and <direction>. Those variables can then be used in the action section with @person and @direction to, in this case, say "hi" to the person.

Here is the trigger.

[[File:WildcardTrigger.png]]

Here is a sample of what it would look like in the game.

[[File:WildcardOutput.png]]

WildcardMatching

2018-03-12T17:02:51Z

Justin:

This trigger captures the name and incoming direction for a player when they enter the room, using the [[Variables|variables]]: <player> and <direction>. Those variables can then be used in the action section with @player and @direction to, in this case, say "hi" to the person.

Here is the trigger.

[[File:WildcardTrigger.png]]

Here is a sample of what it would look like in the game.

[[File:WildcardOutput.png]]

Predefined variables

2016-10-20T20:40:49Z

Justin:

Predefined variables are set by the game as text is sent to the clients.

{| class="wikitable"
! style="text-align:left;" | Variable Name
! style="text-align:left;" | Description
|-
! scope="row"|@tar
|Your current enemy target.
|-
! scope="row"|@match
|The text matched in a trigger.
|-
! scope="row"|@line
|The complete line of text that executed the trigger.
|-
! scope="row"|@suffix
|The suffix is set to all of the text received in a line after the matching text.
|-
! scope="row"|@prefix
|The prefix is set to all of the text received in a line before the matching text.
|}

Additionally, Nexus will attempt to automatically fill the in these variables for you:

{| class="wikitable"
|-
! scope="col"| Variable
! scope="col"| Description
! scope="col"| Game
|-
! scope="row"| @my_hp
| Your current health
| All
|-
! scope="row"| @my_maxhp
| Your maximum health points
| All
|-
! scope="row"| @my_mp
| Your current mana points
| All
|-
! scope="row"| @my_maxmp
| Your maximum mana points
| All
|-
! scope="row"| @my_nl
| Your experience percentage to next level
| All
|-
! scope="row"| @my_bal
| If you currently have balance
| All
|-
! scope="row"| @my_eq
| If you currently have equilibrium
| All
|-
! scope="row"| @my_vote
| If you have not voted for your game recently
| All
|-
! scope="row"| @my_string
| Your current prompt string
| All
|-
! scope="row"| @my_wp
| Your current willpower points
| Achaea, Aetolia
|-
! scope="row"| @my_maxwp
| Your maximum willpower points
| Achaea, Aetolia
|-
! scope="row"| @my_ep
| Your current endurance points
| Achaea, Aetolia
|-
! scope="row"| @my_maxep
| Your maximum endurance points
| Achaea, Aetolia
|-
! scope="row"| @my_xp
| The numerical amount of experience you have for your current level.
| Aetolia
|-
! scope="row"| @my_maxxp
| The numerical amount of experience needed to advance from your current level.
| Aetolia
|-
! scope="row"| @my_blood
| Your blood reserves percentage
| Aetolia
|-
! scope="row"| @my_bleeding
| The current amount of health you're bleeding for.
| Aetolia
|-
! scope="row"| @my_blind
| If you are blind.
| Aetolia
|-
! scope="row"| @my_deaf
| If you are deaf.
| Aetolia
|-
! scope="row"| @my_prone
| If you are prone.
| Aetolia
|-
! scope="row"| @my_cloak
| If you have the Cloak (tattoo) defence.
| Aetolia
|-
! scope="row"| @my_fangbarrier
| If you have the fangbarrier defence.
| Aetolia
|-
! scope="row"| @my_phased
| If you are phased.
| Aetolia
|-
! scope="row"| @my_elevation
| What room elevation you're currently at.
| Aetolia
|-
! scope="row"| @my_herb
| If you have herb/slice balance.
| Aetolia
|-
! scope="row"| @my_salve
| If you have salve/poultice balance.
| Aetolia
|-
! scope="row"| @my_pipe
| If you have pipe/tincture balance.
| Aetolia
|-
! scope="row"| @my_elixir
| If you have elixir/serum balance.
| Aetolia
|-
! scope="row"| @my_moss
| If you have moss/kidney balance.
| Aetolia
|-
! scope="row"| @my_tree
| If your tree tattoo is off cooldown.
| Aetolia
|-
! scope="row"| @my_renew
| If your renew ability is off cooldown.
| Aetolia
|-
! scope="row"| @my_affelixir
| If your affliction elixir/serum balance is off cooldown.
| Aetolia
|-
! scope="row"| @my_focus
| If your focus ability is off cooldown.
| Aetolia
|-
! scope="row"| @my_writhing
| If you are currently writhing.
| Aetolia
|-
! scope="row"| @my_soul
| Your soul percentage (drained by Carnifex).
| Aetolia
|-
! scope="row"| @my_madness
| Your Shapeshifter madness percentage.
| Aetolia
|-
! scope="row"| @my_left_arm
| If you have left arm balance.
| Aetolia
|-
! scope="row"| @my_right_arm
| If you have right arm balance.
| Aetolia
|-
! scope="row"| @my_wield_left
| What item are you wielding in your left hand.
| Aetolia
|-
! scope="row"| @my_wield_right
| What item are you wielding in your right hand.
| Aetolia
|-
! scope="row"| @my_essence
| Your remaining life essence percent (Necromancy).
| Aetolia
|-
! scope="row"| @my_devotion
| Your remaining devotion percent (Devotion).
| Aetolia
|-
! scope="row"| @my_spark
| Your remaining spark percent (Illumination).
| Aetolia
|-
! scope="row"| @my_stance
| What Tekura stance you are currently in.
| Aetolia
|-
! scope="row"| @my_kai
| What your kai level is at (Kaido).
| Aetolia
|-
! scope="row"| @my_momentum
| Your current momentum level (Terramancy).
| Aetolia
|-
! scope="row"| @my_charge_left
| Current charge of your left-hand weapon (Bladefire).
| Aetolia
|-
! scope="row"| @my_charge_right
| Current charge of your right-hand weapon (Bladefire).
| Aetolia
|-
! scope="row"| @my_mounted
| What steed you are currently mounted upon.
| Aetolia
|}

=== Example ===

This is the output from the game, showing some predefined variables. It uses the trigger below.

[[File:PredefinedOutput.png]]

This is the sample trigger used display the predefined variables above.

[[File:PredefinedTrigger.png]]

Predefined variables

2016-10-20T20:40:18Z

Justin:

Predefined variables are set by the game as text is sent to the clients.

{| class="wikitable"
! style="text-align:left;" | Variable Name
! style="text-align:left;" | Description
|-
! scope="row"|@tar
|Your current enemy target.
|-
! scope="row"|@match
|The text matched in a trigger.
|-
! scope="row"|@line
|The complete line of text that executed the trigger.
|-
! scope="row"|@suffix
|The suffix is set to all of the text received in a line after the matching text.
|-
! scope="row"|@prefix
|The prefix is set to all of the text received in a line before the matching text.
|}

Additionally, Nexus will attempt to automatically fill the in these variables for you:

{| class="wikitable"
|-
! scope="col"| Variable
! scope="col"| Description
! scope="col"| Game
|-
! scope="row"| @my_hp
| Your current health
| All
|-
! scope="row"| @my_maxhp
| Your maximum health points
| All
|-
! scope="row"| @my_mp
| Your current mana points
| All
|-
! scope="row"| @my_maxmp
| Your maximum mana points
| All
|-
! scope="row"| @my_nl
| Your experience percentage to next level
| All
|-
! scope="row"| @my_bal
| If you currently have balance
| All
|-
! scope="row"| @my_eq
| If you currently have equilibrium
| All
|-
! scope="row"| @my_vote
| If you have not voted for your game recently
| All
|-
! scope="row"| @my_string
| Your current prompt string
| All
|-
! scope="row"| @my_wp
| Your current willpower points
| Achaea, Aetolia
|-
! scope="row"| @my_maxwp
| Your maximum willpower points
| Achaea, Aetolia
|-
! scope="row"| @my_ep
| Your current endurance points
| Achaea, Aetolia
|-
! scope="row"| @my_maxep
| Your maximum endurance points
| Achaea, Aetolia
|-
! scope="row"| @my_maxep
| Your maximum endurance points
| Achaea, Aetolia
|-
! scope="row"| @my_xp
| The numerical amount of experience you have for your current level.
| Aetolia
|-
! scope="row"| @my_maxxp
| The numerical amount of experience needed to advance from your current level.
| Aetolia
|-
! scope="row"| @my_blood
| Your blood reserves percentage
| Aetolia
|-
! scope="row"| @my_bleeding
| The current amount of health you're bleeding for.
| Aetolia
|-
! scope="row"| @my_blind
| If you are blind.
| Aetolia
|-
! scope="row"| @my_deaf
| If you are deaf.
| Aetolia
|-
! scope="row"| @my_prone
| If you are prone.
| Aetolia
|-
! scope="row"| @my_cloak
| If you have the Cloak (tattoo) defence.
| Aetolia
|-
! scope="row"| @my_fangbarrier
| If you have the fangbarrier defence.
| Aetolia
|-
! scope="row"| @my_phased
| If you are phased.
| Aetolia
|-
! scope="row"| @my_elevation
| What room elevation you're currently at.
| Aetolia
|-
! scope="row"| @my_herb
| If you have herb/slice balance.
| Aetolia
|-
! scope="row"| @my_salve
| If you have salve/poultice balance.
| Aetolia
|-
! scope="row"| @my_pipe
| If you have pipe/tincture balance.
| Aetolia
|-
! scope="row"| @my_elixir
| If you have elixir/serum balance.
| Aetolia
|-
! scope="row"| @my_moss
| If you have moss/kidney balance.
| Aetolia
|-
! scope="row"| @my_tree
| If your tree tattoo is off cooldown.
| Aetolia
|-
! scope="row"| @my_renew
| If your renew ability is off cooldown.
| Aetolia
|-
! scope="row"| @my_affelixir
| If your affliction elixir/serum balance is off cooldown.
| Aetolia
|-
! scope="row"| @my_focus
| If your focus ability is off cooldown.
| Aetolia
|-
! scope="row"| @my_writhing
| If you are currently writhing.
| Aetolia
|-
! scope="row"| @my_soul
| Your soul percentage (drained by Carnifex).
| Aetolia
|-
! scope="row"| @my_madness
| Your Shapeshifter madness percentage.
| Aetolia
|-
! scope="row"| @my_left_arm
| If you have left arm balance.
| Aetolia
|-
! scope="row"| @my_right_arm
| If you have right arm balance.
| Aetolia
|-
! scope="row"| @my_wield_left
| What item are you wielding in your left hand.
| Aetolia
|-
! scope="row"| @my_wield_right
| What item are you wielding in your right hand.
| Aetolia
|-
! scope="row"| @my_essence
| Your remaining life essence percent (Necromancy).
| Aetolia
|-
! scope="row"| @my_devotion
| Your remaining devotion percent (Devotion).
| Aetolia
|-
! scope="row"| @my_spark
| Your remaining spark percent (Illumination).
| Aetolia
|-
! scope="row"| @my_stance
| What Tekura stance you are currently in.
| Aetolia
|-
! scope="row"| @my_kai
| What your kai level is at (Kaido).
| Aetolia
|-
! scope="row"| @my_momentum
| Your current momentum level (Terramancy).
| Aetolia
|-
! scope="row"| @my_charge_left
| Current charge of your left-hand weapon (Bladefire).
| Aetolia
|-
! scope="row"| @my_charge_right
| Current charge of your right-hand weapon (Bladefire).
| Aetolia
|-
! scope="row"| @my_mounted
| What steed you are currently mounted upon.
| Aetolia
|}

=== Example ===

This is the output from the game, showing some predefined variables. It uses the trigger below.

[[File:PredefinedOutput.png]]

This is the sample trigger used display the predefined variables above.

[[File:PredefinedTrigger.png]]

Reflexes

2016-10-14T19:18:10Z

Justin:

[[File:Elf-summoner.jpg|right|frame|caption|A summoner from Imperian.]] The Nexus client allows for basic automation of your game experience by creating triggers, aliases, keybindings, and variables. These types of automation are referred to as ''reflexes''. Reflexes will allow you to automatically enter commands when text is sent to you, quickly enter commands with a keystroke, and create short custom commands to send more information to the game.

=== Types of Reflexes ===
Reflexes are grouped into six major categories; '''Aliases''', '''Events''', '''Keybinds''', '''Triggers''', '''Functions''', and '''Variables'''. The seventh category, '''Groups''' are used for organization.

All reflexes are created, deleted, edited, and managed from the Reflexes tab in the settings window. Variables are the only exception and they are managed from their own Variables tab in settings.

=== Aliases===
[[Aliases]] are used to create very short commands that can be quickly entered and execute longer or multiple commands instantly. ''Note that the Iron Realms games also have in-game alias systems that are separate. HELP ALIASES will explain, in-game.''

=== Keybinds ===
[[Keybinds]] are similar to aliases but instantly send a command to the game with a single keystroke or keystroke combination. For example, control-h to sip health.

=== Triggers ===
[[Triggers]] are used to instantly send a command to the game after receiving specific text from the game. Triggers have been used to create simple to very complex fighting systems.

=== Events ===
[[Events]] are used to perform an action when a pre-defined event happens, such as a defence being lost, or another player entering your room.

=== Functions ===
[[Functions]] are an advanced scripting option. Functions use javascript to process more complicated procedures. Functions are normally used by triggers, aliases, or keybinds.

=== Variables ===
[[Variables]] are usually used to save information for use in triggers, aliases, or keybindings. A popular use for varibles is assigning the monster you are fighting to a ''target'' variable and then using a single button to attack the target. Variables are managed from their own tab in settings and not in the reflexes tab.

=== Groups ===
[[Groups]] are not technically a reflex, but are used to help organize and manage them. Systems can quickly grow to have hundreds of separate reflexes. You can put your reflexes into groups to better organize them. You can even use reflexes to automatically turn entire groups on and off.

Predefined variables

2016-10-14T19:04:13Z

Justin:

Predefined variables

2016-10-14T19:01:41Z

Justin:

GMCP

2016-03-13T20:01:01Z

Justin:

[[File:Aetolia-dwarf.jpg|right|frame|caption|Dwarf Terradrim from Aetolia.]] General MUD Telnet Protocol (GMCP) is a protocol used to send data from the game server to the player client. This data transfer happens behind the scenes and is not seen by the players. This allows the game server to send messages to the client to update basic character, room, and game information. Character health is an example of information that is continually passed to the client from the game.

These messages can also be accessed by the player for use in [[reflexes]]. We are working simplifying the process of capturing GMCP data for use in the client in a future version of the client.

There is a configuration option in the Advanced Settings tab that will allow you to see GMCP messages as they happen.

Module and message names are not case sensitive. JSON key names are case sensitive.

=== Supported modules ===

This documentation covers the following GMCP messages for the Iron Realms Games.

* Core: core functionality
* Char: information about a character
* Char.Afflictions: information the characters afflictions
* Char.Defences- information the characters defences
* Char.Items: information about items in inventory and room, with live updates
* Char.Skills: information about skills known by the player
* Comm.Channel: identification of communication channels and player lists
* Room: various information about the current room
* Redirect: redirect outpot to another window
* IRE.Composer: IRE-specific, used to edit bigger texts client-side
* IRE.FileStore: used internally by the Nexus client
* IRE.Misc: used internally by the fMUD and Nexus clients
* IRE.Rift: IRE-specific, transmits information about the Rift contents
* IRE.Sound: Yes. Sound can be sent.
* IRE.Target: information about the current player target.
* IRE.Tasks: information about tasks, quests, and achievements.
* IRE.Time: information about the current time and date conditions in the game.
* IRE.Wiz: used internally by the Nexus client

=== Supported messages by modules ===

==== Core ====
* Sent by client:
** Core.Hello
*** Needs to be the first message that the client sends, used to identify the client
*** Message body is an object with keys "client" and "version", containing the client's name and version
*** '''Example''': Core.Hello {"Client":"Mudlet","Version":"3.0.0"}
** Core.Supports.Set
*** Notifies the server about packages supported by the client
*** If another Core.Supports.*** package has been received earlier, the list is deleted and replaced with the new one
*** Message body is an array of strings, each consisting of the module name and version, separated by space
*** Module version is a positive non-zero integer
*** Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins
*** '''Example''': Core.Supports.Set [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Add
*** Similar to Set, but appends the supported module list to the one sent earlier
*** If no list was sent yet, the behaviour is identical to Set
*** If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower
*** Message body format is identical to that of Set
*** '''Example''': Core.Supports.Add [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Remove
*** Removes specified modules from the list of supported modules
*** Message body format is similar to Set, except that module version numbers are optional and ignored if given
*** '''Example''': Core.Supports.Remove [ "Char", "Char.Skills", "Char.Items" ]
** Core.KeepAlive
*** Causes the server to reset the timeout for the logged character, no message body
** Core.Ping
*** causes the server to send a Core.Ping back
*** message body is a number which indicates average ping time from previous requests, if available
*** '''Example''': Core.Ping 120

* Sent by server:
** Core.Ping
*** Sent in reply to Core.Ping. No body.
** Core.Goodbye
*** Sent by server immediately before terminating a connection
*** Message body is a string to be shown to the user - it can explain the reason for the disconnect
*** '''Example''': Core.Goodbye "Goodbye, adventurer"

==== Char ====
* Sent by client:
** Char.Login
*** Used to log in a character, only interpreted if no character is logged in for that connection
*** Message body is an object with keys "name" and "password"
*** '''Example''': Char.Login { "name": "somename", "password": "somepassword" }

* Sent by server:
** Char.Name
*** Sends the character name and full name which includes the title. This is only sent on login.
*** '''Example''': Char.Name { "name": "Olad", "fullname": "Neophyte Olad" }
** Char.Vitals
*** Basic character attributes such as health, mana, etc.
*** Message body is an object containing several variables
*** Additionally, each variable is included in a string, in the format name:cur/max
*** Interpretation of the variables is game specific
*** It is generally safe to assume that the known values are numbers (even though encoded as strings), but other datatypes can be present
*** The "charstats" attribute, if present, holds a list of strings that the client may choose to display to the player in a client-specific way, these hold information about the character state that the game wishes to show to the player
*** '''Example''': Char.Vitals { "hp": "4500", "maxhp": "4800", "mp": "1200", "maxmp": "2500", "ep": "15000", "maxep": "16000", "wp": "14000", "maxwp": "15000", "nl": "10", "string": "H:4500/4800 M:1200/2500 E:15000/16000 W:14000/15000 NL:10/100" }
*** '''Additional Achaea Keys'''
**** All classes: Bleed, Rage
**** Apostates: Essence
**** Bard: Stance, Voice Balance
**** Blademaster: Stance
**** Druid: Current Morph, Sunlight Energy
**** Infernal: Essence, Weaponmastery Spec
**** Magi: Channels
**** Monk: Kai Energy, Tekura stance
**** Occultist: Karma, Entity Balance
**** Paladin: Devotion, Weaponmastery Spec
**** Priest: Devotion
**** Runewarden: Weaponmastery Spec
**** Sentinel: Current Morph
**** Serpent: Secreted Venom
**** Shaman: Number of spirits bound
**** Sylvan: Elemental Channels, Sunlight Energy
*** '''Additional Aetolia Keys'''
*** '''Additional Imperian Keys'''
** Char.StatusVars
*** Sent by server after a successful login or after the module is enabled
*** Contains a list of character variables (level, race, etc)
*** Message body is an object
*** Each object element is a name-caption pair, name is the internal name and caption the user-visible one
*** '''Example''': Char.StatusVars { "level": "Level", "race": "Race", "guild": "Guild" }
** Char.Status
*** Values of character values defined by StatusVars.
*** A full list is sent by server right after StatusVars, and changes are sent in subsequent messages as they occur.
*** With the exception of the initial Status message, messages only contain changed values; if a variable is not included, it has not changed since the previous Status message.
*** Message body is an object.
*** Each object element is a name-value pair, name is the internal name defined by the StatusVars message and value is the variable value.
*** '''Example''': Char.Status { "level": "58", "city": "Antioch" }
*** ''' Achaea Keys'''
**** name
**** fullname
**** age
**** race
**** specialisation
**** level
**** xp
**** xprank
**** class
**** city
**** house
**** order
**** boundcredits
**** unboundcredits
**** lessons
**** explorerrank
**** mayancrowns
**** boundmayancrowns
**** gold
**** bank
**** unread_msgs
**** unread_news
**** target
**** gender

==== Char.Afflictions ====
* Sent by server:
** Char.Afflictions.List
*** Sends an array of current character afflictions.
**** name: The name of the affliction
**** cure: The basic cure of the affliction. This is used for links to cure even though other options may exist to cure the affliction.
**** desc: A description of what this affliction does.
*** '''Example''': Char.Afflictions.List [ { "name": "weariness", "cure": "eat kelp", "desc": "Decreases cutting and blunt damage that you inflict by 30%." }, { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }, { "name": "slow herbs", "cure": "apply epidermal", "desc": "Increases the time needed to regain herb balance by 1.25 seconds." }, { "name": "nausea", "cure": "eat nightshade", "desc": "Causes periodic vomiting, which does damage and increases hunger." } ]
** Char.Afflictions.Add
*** Add an affliction to the character.
*** '''Example''': Char.Afflictions.Add { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }
** Char.Afflictions.Remove
*** Removes an affliction from the character.
*** '''Example''': Char.Afflictions.Remove [ "asthma" ]

==== Char.Defences====
* Sent by server:
** Char.Defences.List
*** Send an array of all the defences a character currently has.
**** name: The name of the defence.
**** desc: The description of the defence.
*** '''Example''': Char.Defences.List [ { "name": "deaf", "desc": "deaf" }, { "name": "blind", "desc": "blind" }, { "name": "nightsight", "desc": "nightsight" } ]
** Char.Defences.Add
*** Sent when a defence is added to a character.
*** '''Example''': Char.Defences.Add { "name": "deaf", "desc": "deaf" }
** Char.Defences.Remove
*** Sent when a defence is removed from a character.
*** '''Example''': Char.Defences.Remove [ "blind" ]

==== Char.Items ====
* Sent by client:
** Char.Items.Contents
*** Request for the server to send the list of items located inside another item.
*** Message body is a number identifying the item.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Item.Contents 12345
** Char.Items.Inv
*** Request for the server to send the list of items in player's inventory.
*** Message body is empty.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Inv ""
** Char.Items.Room
*** Sent by the client to refresh the items in a room.
*** Message body is empty
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Room ""

* Sent by server:
** Char.Items.List
*** List of items at a specified location (room, inv, held container)
*** Message body is an object with keys "location" and "items"
*** Location value is a string, "inv", "room", or "repNUMBER" - the last one is container identification
*** Items value is an array, whose each item is an object with keys "id", "name" and optionally "attrib"
*** ID is a number identifying the item, name is a string containing a short player-visible item description
*** Icon is the image the item is associated with in the client.
*** Attrib is a string consisting of characters describing item properties:
**** "w" = worn,
**** "W" = wearable but not worn
**** "l" = wielded
**** "g" = groupable
**** "c" = container
**** "t" = takeable
**** "m" = monster
**** "d" = dead monster
**** "x" = should not be targeted (guards, ...)
*** '''Example''': Char.Items.List { "location": "inv", "items": [ { "id": "12807", "name": "a personal journal", "icon": "scroll", "attrib": "l" }, { "id": "303060", "name": "a gold nugget", "icon": "commodity" } ] }
** Char.Items.Add
*** Informs the client about an item being added to the specified location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an object with the same structure as one item from the items array of List
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "c" } }
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
*** '''Example''': Char.Items.Add { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity", "attrib": "t" } }
** Char.Items.Remove
*** Informs the client about an item being removed from the location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an integer value identifying the item
*** '''Example''': Char.Items.Remove { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "t" } }
*** '''Example''': Char.Items.Remove { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
** Char.Items.Update
*** Informs the client about an item's attributes being changed - only sent for inventory items
*** Message body syntax the same as with Add
*** '''Example''': Char.Items.Update { "location": "inv", "item": { "id": "60572", "name": "an ornate steel rapier" } }

==== Char.Skills ====
* Sent by client:
** Char.Skills.Get
*** Sent by client to request skill information
*** Message body is an object with keys "group" and "name"
*** If both group and name is provided, the server will send Char.Skills.Info for the specified skill
*** If group is provided but name is not, the server will send Char.Skills.List for that group
*** Otherwise the server will send Char.Skills.Groups
*** '''Example''': Char.Skills.Get {"group":"Perception"}
*** '''Example''': Char.Skills.Get {"group":"perception","name":"Deathsight"}

* Sent by server:
** Char.Skills.Groups
*** Groups of skills available to the character
*** Sent by server on request or at any time (usually if the list changes)
*** For IRE games, groups are skills like Survival or Elemancy
*** Message body is an array including the name and current rank of each skill the character has.
*** '''Example''': Char.Skills.Groups [ { "name": "Perception", "rank": "Transcendent (100%)" }, { "name": "Survival", "rank": "Inept (0%)" }, { "name": "Weaponry", "rank": "Inept (0%)" }, { "name": "Tattoos", "rank": "Inept (0%)" }, { "name": "Evasion", "rank": "Inept (0%)" }, { "name": "Engineering", "rank": "Inept (0%)" }, { "name": "Taming", "rank": "Inept (0%)" }, { "name": "Concoctions", "rank": "Inept (0%)" }, { "name": "Toxins", "rank": "Inept (0%)" }, { "name": "Smithing", "rank": "Inept (0%)" }, { "name": "Malignosis", "rank": "Adept (1%)" }, { "name": "Necromancy", "rank": "Inept (0%)" }, { "name": "Evileye", "rank": "Adept (40%)" } ]

** Char.Skills.List
*** List of skills in a group available to the character
*** Sent by server on request only
*** For IRE games, this is the list visible on AB <skillname>
*** Message body is an object with keys "group", "list", and "desc".
*** The list value is an array of strings, each being the name of one skill
*** '''Example''': Char.Skills.List { "group": "perception", "list": [ "Looking", "Glancing", "Secrets", "Decaylist", "Squinting", "Flyers", "Observe", "Farsight", "Containerlist", "Vigilance", "Treewatch", "Deathsight", "Pipelist", "Elixlist", "Search", "Letterlist", "Booklist", "Skywatch", "PowerNodes", "Keylist", "Alertness", "Rites", "Traps", "Magicklist", "Nightsight", "Hypersight", "Thirdeye", "Tattoos", "Discernment", "Wormholes", "Rivensense", "Contemplation", "Scan", "Telesense", "Appraise", "Trueassess", "Artifactlist", "Warning", "Viewshrine", "Landsense" ], "descs": [ "Gain knowledge of your immediate surroundings.", "See summarized information about your surroundings.", "Discover hidden exits.", "How much more time do those items have?", "See extended distances in your line of sight.", "Take notice of those in the skies.", "Gain information about your extended surroundings.", "Attempt to locate another player from afar.", "What do you have in your containers?", "Increase your resistance to hypnosis.", "Watch the forest canopies for movement.", "Attune yourself to the Underworld.", "Scan your pipes with utmost speed.", "Quickly discover what elixirs and salves you are holding.", "Search your location for hidden beings.", "Quick glance of all your letters.", "Scan the titles of books you own.", "Watch the skies for movement.", "Detect the nodes of power in your area.", "See a list of your keys and which doors they open.", "Heightened awareness of your surroundings.", "View the holy rites operating in your location.", "The ability to search for traps in your location.", "Check the status of your magickal items.", "Use infravision to see in the dark.", "See the actions of cloaked players.", "Give yourself the power of the third eye.", "Discover what tattoos are on another player.", "Discover what defences are protecting an individual.", "The ability to sense wormholes in your location.", "Sense the bodies of the recently slain.", "Perceive the state of another's mental strength.", "Seekout the locations of your allies and enemies.", "Heighten your awareness to telepathic attempts.", "Quickly take note of someone's carried possessions.", "Gain more detailed information concerning your foe.", "See what artifact powers surround an individual.", "Watch for the prying eyes of the enemy.", "Gain a detailed understanding of a shrine.", "The ability to recognize mortals entering the realm." ] }

** Char.Skills.Info
*** Information about a single skill, only sent upon request
*** Message body is an object, keys are "group", "skill", and "info", values are strings
*** Group and skill identify the request, info is a description (usually multi-line) of the skill's functionality and usage
*** '''Example''': Char.Skills.Info { "group": "perception", "skill": "deathsight", "info": "Syntax: DEATHSIGHT\n RELAX DEATHSIGHT\n\nUsing this ability, your mind is now capable of attuning itself to the realm of the dead. While doing so, you will be alerted whenever anyone dies." }
==== Comm.Channel ====
* Sent by client:
** Comm.Channel.Players
*** Request for the server to send Comm.Channel.Players
*** No message body.
*** '''Example''': Comm.Channel.Players ""
** Comm.Channel.Enable
*** Used to tell the game to turn on a character channel without typing in a command line command.
*** Example: Comm.Channel.Enable "newbie"
*** Example: Comm.Channel.Enable "clt Consortium"

* Sent by server:
** Comm.Channel.Players
*** List of players and organizations (city, guild, ...) that they share with this player
*** Message body is an array with each element describing one player
*** Each element is an object with keys "name" and "channels", name is a string, channels is an array
*** The channels array may be omitted if empty; if given, it is a list of organization names
*** '''Example''': Comm.Channel.Players [{"name": "Player1", "channels: ["Some city", "Some guild"]}, {"name": "Player2"}]
*** '''Example''': Comm.Channel.Players [ { "name": "Ahkan", "channels": [ "The City of Stavenn" ] }, { "name": "Sharatar", "channels": [ "The City of Stavenn", "The Revenants" ] } ]

** Comm.Channel.List
*** List of communication channels available to the player, sent on login/negotiation and if changed
*** Message body is an array of objects, each object representing one channel
*** Each object has keys "name", "caption" and "command" - name is internal name, caption is player-visible name, command is command used to communicate over this channel
*** '''Example''': Comm.Channel.List [{"name":"ct", "caption":"Some city", "command":"ct"}, {"name":"gt", "caption":"Some guild", "command":"gt"}]
*** '''Example''': Comm.Channel.List [ { "name": "newbie", "caption": "Newbie", "command": "newbie" }, { "name": "market", "caption": "Market", "command": "market" }, { "name": "ct", "caption": "Stavenn", "command": "ct" }, { "name": "gt", "caption": "Revenants", "command": "gt" } ]

** Comm.Channel.Start
*** Informs the client that text that follows is something said over a communication channel
*** Message body is a text containing the channel name
*** For tells from/to another player, the channel name is "tell Name"
*** '''Example''': Comm.Channel.Start "ct"
*** '''Example''' :Comm.Channel.Start "tell Jeremy"
** Comm.Channel.End
*** Ends a channel text started by Comm.Channel.Start
*** Message body is a text containing the channel name
*** '''Example''': Comm.Channel.End "tell Jeremy"

** Comm.Channel.Text
*** The text of the communication that you heard, who spoke, and which channel it was on
*** '''Example''': Comm.Channel.Text { "channel": "says", "talker": "Tecton", "text": "(Tecton the Terraformer says, \"Are we releasing dragon lairs or the phase artefact first?\"" }
*** '''Example''': Comm.Channel.Text { "channel": "tell Jeremy", "talker": "Olad", "text": "\u001b[0;1;33mYou tell Jeremy, \"Hi.\"\u001b[0;37m" }
*** '''Example''': Comm.Channel.Text { "channel": "newbie", "talker": "Olad", "text": "\u001b[0;1;32m(Newbie): You say, \"Hello.\"\u001b[0;37m" }

==== Room ====
* Sent by server:
** Room.Info
*** Contains information about the room that the player is in. Some of these may be IRE-specific
*** Message body is an object with the following keys
**** "num" - number identifying the room
**** "name" - string containing the brief description
**** "area" - string containing area name
**** "environment" - string containing environment type ("Hills", "Ocean", ...)
**** "coords" - room coordinates (string of numbers separated by commas - area,X,Y,X,building, building is optional
**** "map" - map information - URL pointing to a map image, followed by X and Y room (not pixel) coordinates on the map
**** "details" - array holding further information about a room - shop,bank,...
**** "exits" - object containing exits, each key is a direction and each value is the number identifying the target room
*** '''Example''': Room.Info {"num": 12345, "name": "On a hill", "area": "Barren hills", "environment": "Hills", "coords": "45,5,4,3", "map": "www.imperian.com/itex/maps/clientmap.php?map=45&level=3 5 4", "exits": { "n": 12344, "se": 12336 }, "details": [ "shop", "bank" ] }
** Room.WrongDir
*** Sent if the player attempts to move in a non-existant direction using the standard movement commands
*** Upon receiving this message, the client can safely assume that the specified direction does not lead anywhere at this time
*** Message body is a string with the name if the non-existant exit
*** Example: Room.WrongDir "ne"
** Room.Players
*** Object containing player details, each key is the short name of the player and each value is the full name including titles for the player
*** '''Example''': Room.Players [{ "name": "Tecton", "fullname": "Tecton the Terraformer" }, {"name": "Cardan", "fullname": "Cardan, the Curious" }]
** Room.AddPlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being added to the room.
*** '''Example''': Room.AddPlayer { "name": "Cardan", "fullname": "(Cardan, the Curious)" }
** Room.RemovePlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being removed from the room.
*** '''Example''': Room.RemovePlayer "Cardan"

==== Redirect ====
* Sent by server:
** Redirect.Window
*** Specifies a window to redirect further input to
*** Message body is a string specifying the window to redirect to
*** The main window is referred to as "main", and is the default if the message body is omitted or empty
*** Example: Redirect.Window "map"

==== IRE.Composer ====
* Sent by server:
** IRE.Composer.Edit
*** Sent by the server when the player enters an in-game editor. Body is an object, with keys "title" and "text". Text contains the current buffer, title is a title that can be shown to the user.
*** '''Example''': IRE.Composer.Edit { "title": "Composer", "text": "" }

* Sent by client:
** IRE.Composer.SetBuffer
*** Sent by the client upon successfully editing a text which was sent to the client in an IRE.Composer.Edit message earlier
*** Sending this message only changes the edit buffer, but does not end the editing session
*** On IRE games, the client may send the command ***save to save a text, or command ***quit to abort editing (IRE.Composer.SetBuffer is not sent in this case) - this behaviour is IRE-specific and is one of the reasons why the Composer module is in the IRE namespace
*** '''Example''': IRE.Composer.SetBuffer "This is a bunch of text."

==== IRE.Misc ====
* Sent by client:
** IRE.Misc.Voted
*** Informs the game a vote button was clicked.
*** Example: IRE.Misc.Voted ""

* Sent by server:
** IRE.Misc.RemindVote
*** Message sent to remind the player to vote.
*** '''Example''': IRE.Misc.RemindVote "http://www.imperian.com/vote"

** IRE.Misc.Achievement
*** Used to send basic achievement data to the client.
*** '''Example''': IRE.Misc.Achievement [{"name": "HighestLevelAchieved", "value": "89" }]

** IRE.Misc.URL
*** Sends a url to the client to open in a window when clicked.
*** '''Example''': IRE.Misc.URL[{"url": "http://www.imperian.com/tos", "window": "ire_game_tos" }]

** IRE.MISC.Tip
*** Sends a line of text to the client.
*** '''Example''': IRE.Misc.Tip "This is a tip!"

==== IRE.Rift ====
* Sent by server:
** IRE.Rift.List
*** contents of a Rift storage
*** sent upon receiving the IRE.Rift.Request message
*** message body is an array, with each element being an object containing three keys - "name" is item name, "amount" is a number holding the item's amount, and "desc" is user-visible description
** IRE.Rift.Change
*** sent whenever the item amount in a Rift changes
*** message body is an object with the same structure as one element of an array sent with the IRE.Rift.List message

* Sent by client:
** IRE.Rift.Request
*** asks the server to send the Rift contents using the IRE.Rift.List message

==== IRE.Sound ====

* Sent by server:
** IRE.Sound.Play
** IRE.Sound.Stop
** IRE.Sound.Stopall
** IRE.Sound.Preload

==== IRE.Target ====
* Sent by client:
** IRE.Target.Set
*** Sends the currently set target to the server to be used by the internal alias system.
*** '''Example''': IRE.Target.Set "1101"
* Sent by server

** IRE.Target.Set
*** Sends the target the client is trying to set. This is called from cycling targets with tab targeting.
*** '''Example''': IRE.Target.Set "1101"
** IRE.Target.Info
*** Sends an array with the current target information.
*** '''Example''': IRE.Target.Info { "id": "1101", "short_desc": "a brawny goblin smith", "hpperc": "100%" }
** IRE.Target.Request

==== IRE.Tasks ====

* Sent by client:
** IRE.Tasks.Request

* Sent by server:
** IRE.Tasks.List
*** This is used to send a list of quest, tasks, and achievements, depending on what the game supports.
*** Sends an array of items with the following keys:
**** id: A numeric identifier
**** name: The name of the quest, task, or achievement.
**** type: Is this a quest, task, or achievement.
**** cmd: The command to get more information for the quest. Good for MXP links.
**** desc: The description of the event.
**** status: 0 or 1 based on if it is completed or not.
**** group: What group should this be assigned to. This is mainly for client display purposes.
*** '''Example''': IRE.Tasks.List [ { "id": "184", "name": "For the sake of the village", "desc": "The herbs in Maeven's garden are painstakingly cared for so that her fellow villagers can stay healthy. She won't object to borrowing a bit of the magick power the bakuls have, if it can help with her work.\n\nThe bakul herbalist might have something Maeven wants.", "type": "quests", "cmd": "quest For the sake of the village", "status": "0", "group": "Current Quests" }, { "id": "313", "name": "Apostate", "desc": "Destroy a Shrine.", "type": "achievements", "cmd": "achievement apostate", "status": "0", "group": "Sects" } ]
** IRE.Tasks.Update
** IRE.Tasks.Completed

==== IRE.Time ====
* Sent by client:
** IRE.Time.Request

* Sent by server:
** IRE.Time.List
*** A list of the current time condition in the game world.
*** Used in the client to display the the day/night indicator.
*** '''Example''': IRE.Time.List { "day": "1", "mon": "1", "month": "Letum", "year": "98", "hour": "41", "daynight": "80" }
** IRE.Time.Update
*** Used to update time conditions.
*** '''Example''': IRE.Time.Update { "daynight": "112" }

Functions

2016-03-13T19:04:04Z

Justin: /* Output Manipulation (Trigger Scripts) */

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.''
===== Misc. =====
* '''to_number(val)''' - Convert a string number to a value.

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

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

Variables

2016-02-24T22:53:14Z

Justin:

Variables are storage containers that can hold text, numbers, or other values. For example, you could use variables to store your currently attacked target, the item number of your pack, or anything else. To set a variable, use the following command on the command line or in an alias: @set name value. For example, @set target orc.

Once a variable is set, you can refer to it in aliases and direct command using @name. For example, you could easily make a simple targetting system by creating an alias with Alias text set to t and the Command set to @set t. Then, you would create a separate alias for each attack that you wish to use - for example, an alias with text fl and command cast firelash at @t. With this setup, you could then simply enter t orc to target an orc, and fl to cast firelash at it. Much easier than having to type it all the time by hand!

There may be times when you'll want to use the contents of a variable appended to some more text. In cases like this, you may use @{variablename}<rest of your text>. For example, if you have a variable called @him, which is either "him" or "her" and want to use that as part of "himself" or "herself", you can use @{him}self.

Variables can also be set in the settings interface, on the Variables panel.

[[File:tab-variables.png]]

== Examples ==
[[Basic Targeting Alias]]: These aliases use variables to target and attack mobiles.

Variables

2016-02-24T22:52:47Z

Justin:

Variables are storage containers that can hold text, numbers, or other values. For example, you could use variables to store your currently attacked target, the item number of your pack, or anything else. To set a variable, use the following command on the command line or in an alias: @set name value. For example, @set target orc.

Once a variable is set, you can refer to it in aliases and direct command using @name. For example, you could easily make a simple targetting system by creating an alias with Alias text set to t and the Command set to @set t. Then, you would create a separate alias for each attack that you wish to use - for example, an alias with text fl and command cast firelash at @t. With this setup, you could then simply enter t orc to target an orc, and fl to cast firelash at it. Much easier than having to type it all the time by hand!

There may be times when you'll want to use the contents of a variable appended to some more text. In cases like this, you may use @{variablename}<rest of your text>. For example, if you have a variable called @him, which is either "him" or "her" and want to use that as par of "himself" or "herself", you can use @{him}self.

Variables can also be set in the settings interface, on the Variables panel.

[[File:tab-variables.png]]

== Examples ==
[[Basic Targeting Alias]]: These aliases use variables to target and attack mobiles.

Variables

2016-02-24T22:51:43Z

Justin:

Variables are storage containers that can hold text, numbers, or other values. For example, you could use variables to store your currently attacked target, the item number of your pack, or anything else. To set a variable, use the following command on the command line or in an alias: @set name value. For example, @set target orc.

Once a variable is set, you can refer to it in aliases and direct command using @name. For example, you could easily make a simple targetting system by creating an alias with Alias text set to t and the Command set to @set t. Then, you would create a separate alias for each attack that you wish to use - for example, an alias with text fl and command cast firelash at @t. With this setup, you could then simply enter t orc to target an orc, and fl to cast firelash at it. Much easier than having to type it all the time by hand!

There may be times when you'll want to use the contents of a variable appended. In cases like this, you may use @{variablename}<rest of your text>. For example, if you have a variable called @him, which is either "him" or "her" and want to use that as par of "himself" or "herself", you can use @{him}self.

Variables can also be set in the settings interface, on the Variables panel.

[[File:tab-variables.png]]

== Examples ==
[[Basic Targeting Alias]]: These aliases use variables to target and attack mobiles.

Advanced Scripting

2016-02-23T20:44:50Z

Justin:

[[File:Grook.jpg|right|frame|caption|A grook Occultist from Achaea.]] The [[SimplifiedScripting|simplfied scripting]] system in the Nexus client should offer enough options for most players of the game. However, for those of you that may need a bit more power, or have some specific need that Nexus can't fill, you can use JavaScript to do nearly everything else.

*[[Javascript]]: JavaScript is the scripting language for the Nexus client.
*[[Functions]]: Create custom JavaScript functions to use in with other [[reflexes]].
*[[GMCP]]: The game server communicates behind the scenes with the Nexus client using GMCP. You can access this information.

===Hints and tips===
* Namespacing
** Each reflex and script is sandboxed. You will want to use the '''client.''' object as a shared namespace for custom functions, variables, etc.

Functions

2016-02-23T20:41:19Z

Justin:

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_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.''
===== Misc. =====
* '''to_number(val)''' - Convert a string number to a value.

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

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

Advanced Scripting

2016-02-23T20:37:07Z

Justin:

[[File:Grook.jpg|right|frame|caption|A grook Occultist from Achaea.]] The [[SimplifiedScripting|simplfied scripting]] system in the Nexus client should offer enough options for most players of the game. However, for those of you that may need a bit more power, or have some specific need that Nexus can't fill, you can use javascript to do nearly everything else.

*[[Javascript]]: Javascript is the scripting language for the Nexus client.
*[[Functions]]: Create custom javascript functions to use in with other [[reflexes]].
*[[GMCP]]: The game server communicates behind the scenes with the Nexus client using GMCP. You can access this information.

* '''Hints and tips:'''
** Namespacing
*** Each reflex and script is sandboxed. You will want to use the '''client.''' object as a shared namespace for custom functions, variables, etc.

Advanced Scripting

2016-02-23T20:36:38Z

Justin:

[[File:Grook.jpg|right|frame|caption|A grook Occultist from Achaea.]] The [[SimplifiedScripting|simplfied scripting]] system in the Nexus client should offer enough options for most players of the game. However, for those of you that may need a bit more power, or have some specific need that Nexus can't fill, you can use javascript to do nearly everything else.

*[[Javascript]]: Javascript is the scripting language for the Nexus client.
*[[Functions]]: Create custom javascript functions to use in with other [[reflexes]].
*[[GMCP]]: The game server communicates behind the scenes with the Nexus client using GMCP. You can access this information.

* Hints and tips:
** Namespacing
*** Each reflex and script is sandboxed. You will want to use the '''client.''' object as a shared namespace for custom functions, variables, etc.

Advanced Scripting

2016-02-23T20:36:26Z

Justin:

[[File:Grook.jpg|right|frame|caption|A grook Occultist from Achaea.]] The [[SimplifiedScripting|simplfied scripting]] system in the Nexus client should offer enough options for most players of the game. However, for those of you that may need a bit more power, or have some specific need that Nexus can't fill, you can use javascript to do nearly everything else.

*[[Javascript]]: Javascript is the scripting language for the Nexus client.
*[[Functions]]: Create custom javascript functions to use in with other [[reflexes]].
*[[GMCP]]: The game server communicates behind the scenes with the Nexus client using GMCP. You can access this information.

* Hints and tips:
** Namespacing
Each reflex and script is sandboxed. You will want to use the '''client.''' object as a shared namespace for custom functions, variables, etc.

Nexus 2.0

2016-02-22T20:28:58Z

Justin:

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

This documentation details how to configure the [[The_Game_Client|client basics]] including sound settings, window arrangement, and map settings.

You can also learn how to create basic [[reflexes]]. Reflexes can help automate parts of the game with [[triggers]], [[aliases]], [[keybinds]], and [[variables]]. The Nexus client has a [[SimplifiedScripting|Simplified Scripting]] which allows for easy creation of complex systems. Nexus also supports [[javascript]] as part of our [[AdvancedScripting|advanced scripting]] options.

Another option for advanced scripting is use of [[GMCP]]. GMCP sends basic data from the game to the client behind the scenes. Data such as inventory, health, room items, and more can be tracked with advanced scripting.

==== Tutorial Videos ====
<embedvideo service="youtube">https://www.youtube.com/watch?v=dQTrmHtS0K8</embedvideo>

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

<embedvideo service="youtube">https://youtu.be/eol8F8b_9sk</embedvideo>
''' Recommended for experienced players. ''' A just over 2 minute tutorial for experienced MUD users running down 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.

==== Screenshots ====

<ul class="small-block-grid-3">
<li>[[File:Client_main_page_-_1280x1024_75p.jpg|thumb|Main Client.]]</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.midkemiaonline.com Play Midkemia Online]

====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.midkemiaonline.com Midkemia Online 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.midkemiaonline.com www.MidkemiaOnline.com]

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

The Game Client

2016-02-20T22:29:07Z

Justin:

This is the client. It is the interface through which you play the game world. Let's take a moment and explore each section of the client.
[[File:TheClient.png]]

=== Main Output Window ===
This is the output window. New output will appear from the bottom and scroll up.
[[File:MainOutput.png]]

==== Scrollback ====
You can see your scrollback history by using the page-up and page-down keys, by using your mouse wheel, or by clicking on the button in the upper right of the client.

You can adjust the location where the split screen happens with your mouse.

You can close the split screen by clicking on the HIDE button in the top right.

[[File:MainScrollback.png]]

=== Command Line ===
This is the command input line and is where you input commands to the game.

[[File:MainCommandLine.png]]

=== F-Key Buttons ===
These are the F-Key buttons, which come pre-filled for new characters. You can edit these keys in [[settings]] menu, which is accessed from the gears icon in the lower-right.

You can activate the buttons by clicking on them with your mouse it pressing the corresponding F-Key on your keyboard.

[[File:MainButtons.png]]

=== Gauges ===
Above that you’ll see indicators for health, mana, and other stats, depending on which Iron Realms game you’re playing.
[[File:MainGauges.png]]

=== Balance and Equilibrium Indicators ===
<table style="border:0;">
<tr>
<td valign="top" width="50px">
[[File:MainBalEq.png]]
</td>
<td valign="top">
To the left of the gauges are the balance and equilibrium indicators.
* The hammer icon indicated your balance.
* The star indicates your equilibrium.
</td>
</tr>
</table>

=== Avatar ===
<table style="border:0;">
<tr>
<td valign="top">
[[File:MainAvatar.png|left]]
</td>
<td valign="top">
To the right of the gauges is your character portrait. This is initially set by default. You can select one of ours or upload one of your own by clicking on it.
</td>
</tr>
</table>

=== Map Window ===
<table>
<div class="row">
<div class="large-3 columns">
[[File:MainMap.png]]
</div>
<div class="large-9 columns">
In our game worlds your character is in a room. You move from room to room by typing in directions like north or southwest. This map window indicates the room you are currently in with a flag. You can also move by clicking on the exits listed in the map window, or by double clicking on a room.
</div>
</div>
</table>

==== Map Compass ====
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainCompass.png]]
</div>
<div class="small-9 columns">
You can also move by using the Map Compass which appears in the top right corner of your main output window. This is off by default, but can be turned on in your [[settings]].
</div>
</div>
</table>

=== Character Tab ===
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainCharacter.png]]
</div>
<div class="small-9 columns">
That is the character window. As you get damaged, your limbs, body, and head will change colors (not all of our games have this concept). To the right are icons representing different common defenses that your character may have active. You can mouseover them to see their names, and get more info in-game.

Below that you’ll see other kinds of info, as well as a complete list of the afflictions and defences you currently have.
</div>
</div>
</table>

=== Skills Tab ===
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainSkills.png]]
</div>
<div class="small-9 columns">
The skill tab displays your current skills. Clicking on a skill will popup a display of all your abilities in that skill.
</div>
</div>
</table>

=== Inventory Tab ===
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainInventory.png]]
</div>
<div class="small-9 columns">
This displays your inventory. Breaking it down by items you are wielding, wearing, and carrying.
</div>
</div>
</table>

=== Room Tab ===
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainRoom.png]]
</div>
<div class="small-9 columns">
This is the room tab. It displays all of the items in the room. It is broken down by other players, mobs (these are NPCs and monsters), and items.
</div>
</div>
</table>

=== Who Tab ===
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainWho.png]]
</div>
<div class="small-9 columns">
This tab lists all of the current players in the game that you can see. You can also click on any organization you belong to for a filtered list.
</div>
</div>
</table>

=== Quests, Tasks, and Achievement Tabs ===
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainQuests.png]]
</div>
<div class="small-3 columns">
[[File:MainAchivements.png]]
</div>
<div class="small-6 columns">
These tabs display any quests, tasks, and achievements you may accomplish. You can click on the task for a popup to display any information about that task. Not all of the Iron Realms games use all of these activities.
</div>
</div>
</table>

=== Communications Tab ===
<table>
<div class="row">
<div class="small-3 columns">
[[File:MainCommunication.png]]
</div>
<div class="small-9 columns">
All chat communication you receive in the game is piped to this window.
</div>
</div>
</table>

=== Status bar ===
[[File:MainStatus.png]]
The status bar is located at the bottom of the client.

From left to right it has:
# Help: Click this button to access this wiki.
# Vote: Click this button to vote for your favorite game on the TopMudSites website.
# Level: This star icon indicated your level and how far you have progressed to the next level.
# Target: What player or mob you are currently targeting.
# Gold: How much gold your character is carrying.
# Bank: How much gold you character has in the bank.
# Ping: How fast is your connection to our servers. The lower the number, the better.
# Messages: If the envelop icon is visible, you have a message. Type HELP MESSAGES in the game for more information.
# News: If the news icon is highlighted, you have unread news. Type HELP NEWS for more information.
# Day/Night Indicator: This indicated the current time of day in the game. Hovering your mouse over the icon will display more information.
# Fullscreen Mode: The monitor icon will cause the client to run in fullscreen.
# Logging: You can log all output from the game to a text file for later use.
# Scripts On/Off: The lightning icon will turn on and off all of your [[reflexes]].
# Settings: The gear icon will open another window, allowing you to adjust your [[settings]].
# Reset: You can reset the client to its default layout by clicking this icon.

The Game Client

2016-02-20T22:28:47Z

Justin:

Examples

2016-02-19T06:29:43Z

Justin:

This page links to several [[reflexes|reflex]] examples. You can use these directly or use them to help you create new types of reflexes.

=== Aliases ===
These are examples of how to create an [[aliases|alias]].

* [[Hello World Alias]]: A simple example of an alias.
* [[Basic Targeting Alias]]: These aliases use variables to target and attack mobiles.
* [[Put Pack Alias]]: This alias quickly gets and puts items in packs using the @suffix expansion.
* [[Disable Group Alias]]: This is an example alias that will disable an entire group or reflexes.

=== Keybinds ===
These are examples of how to create an [[keybinds|keybind]].

=== Triggers ===
These are examples of how to create an [[triggers|trigger]].
* [[Gold Counter]]: This alias will keep track of the amount of gold picked up. It shows how to use wildcards in a trigger text.
* [[Balance Recovery Attack]]: This is an example of a trigger to automatically attack a target when you recover balance.

=== Functions ===
These are examples of how to create a [[functions|function]].
* [[GMCP Data|GMCPData]]: This example reads some data coming over via [[GMCP]] and assigns it to variables.

Gold Counter

2016-02-19T05:35:07Z

Justin:

This is a basic trigger to show how to use basic wildcards in a trigger. This reflex will keep track of the amount of gold picked up.

[[File:GoldTrigger.png]]

As you can see, we use <gold> in place of the number of gold sovereigns picked up. We then use that number to increase the value of our ''totalgold'' variable.

Here is an example of the output:
[[File:GoldTriggerOutput.png]]

Gold Counter

2016-02-19T05:32:55Z

Justin:

This is a basic trigger to show how to use basic wildcards in a trigger. This reflex will keep track of the amount of gold picked up.

[[File:GoldTrigger.png]]

[[File:GoldTriggerOutput.png]]

File:GoldTriggerOutput.png

2016-02-19T05:31:51Z

Justin:

File:GoldTrigger.png

2016-02-19T05:31:30Z

Justin:

Gold Counter

2016-02-19T05:29:40Z

Justin: Created page with "This is a basic trigger to show how to use basic wildcards in a trigger. This reflex will keep track of the amount of gold picked up."

This is a basic trigger to show how to use basic wildcards in a trigger. This reflex will keep track of the amount of gold picked up.

Triggers

2016-02-19T05:23:19Z

Justin:

Triggers are a very powerful and versatile type of reflexes. Triggers allow you to automatically react when text (and other events) is sent to your character from the game.

A few brief examples of things triggers can do:

* Automatically send commands to the game when certain text is received.
* Hide unimportant lines you don't want to see.
* Highlight lines of text you do not want to accidentally miss.
* Modify portions of the lines received from the game.
* Save data in a variable for later use. Such as how much gold you picked up or the name of a player that hit you.

The basic usage of triggers is similar to that of [[aliases]] or [[keybinds]]. One thing to be careful of is that by default, triggers can match anywhere in the received text, not only at the beginning (you can change the ''Matching Type'' accordingly, if desired).

== How to Create a New Trigger ==

Triggers are a reflex. They are created and managed from the Reflexes tab in the settings window. To open the settings window, click on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your main game screen

=== Step 1. Open the settings page and click the 'Reflexes' tab. ===

To create a new trigger, open your settings window by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

In the settings window, click on the 'Reflexes' tab as shown in the image below.

[[File:tab-reflexes.png|frame|center|Setting window displaying the reflexes tab.]]

=== Step 2. Click the 'Add' Button and select 'Add a Trigger'. ===

There are several different reflexes you can create. We want to create a trigger. In order to do this, click the 'Add' button located in the left pane and then click on 'Add a Trigger'. This will create a new, undefined trigger.

Should you want to delete a trigger, you can select the trigger from the list, and then click the 'Remove' button.

[[File:Trigger-create.png|frame|center|Example of creating a new trigger.]]

=== Step 3: Triggers Options. ===

There are two main option sections for triggers; '''Matching''' and '''Actions'''.

'''Matching''' is used to find the text you would like to use for this trigger. When the game sends text to your character that matches, it will automatically send the action defined below it.

'''Actions''' is what will happen when the trigger matches text from the game. Actions can be used to automatically send text to the game, highlight you want to stand out, create complicated functions, and other things.

[[File:trigger-blank.png|frame|center|This is a blank trigger. It will not do anything until you add text to match and an action to do when that text is matched.]]

== Matching Options Explained ==

Matching is used to find text sent from the game to create an action for. You can match entire lines of text, single words, partial lines, and lines of text with variable words.

[[File:trigger-matching.png]]

There are five options for matching text.

=== Trigger Text ===

This field is required and contains the text to match.

Examples of Trigger Text:
* You have recovered balance.
* You have recovered
* recovered balance.
* You have recovered balance.

This works hand in hand with the '''Matching Type''' option. See below.

There are times when you'll want to use wildcard matches in your triggers. Say you want to make an alert when someone enters the room, you can surround a word in <>'s to assign it to a variable. If an example line is ''Jeremy enters from the north'', you could configure your trigger to match on ''<person> enters from the <direction>''. As an added bonus, you can then use @person and @direction as variables in the trigger actions.

These simplified triggers do not work with regular expressions, and if using this advanced feature, you'll want to ensure that you're using the correct syntax.

=== Matching Type ===

There are four options for matching text.

* '''Contains''': This will match any line that has your trigger text in it.
* '''Begins with''': Will only match a line that starts with your trigger text in it.
* '''Exact match''': Will only match a line that matches exactly like your trigger text.
* '''Regular expression''': This will match any regular expression patterns. This is advanced, but good to learn.

In most cases you will want to use ''Contains'' option unless you have more complicated situations.

=== Whole Words Only ===

If checked, the trigger will only match whole words.

For example; you create a trigger with trigger text set to 'You have recovered bal'.

If the game sends the text - You have recovered balance. - it will '''NOT''' match, because 'balance.' is a different whole word than 'bal'.

If I uncheck 'Whole words only', the trigger would work.

In almost all cases you will just want to keep 'Whole words only' turned on and be sure to include the full trigger text. Remember that whole words are separated by spaces and punctuation is considered part of a word.

=== Match Case ===

If checked, capitalization must match.

For example, if checked, 'You have recovered balance' is not the same as 'You HAVE reCOvered balance'.

If unchecked, the example above will work.

=== Trigger Name ===

(Optional) The name of the trigger. The name is an identifier that will show up in your list of triggers. It is used for organizing your triggers. It is not required for your trigger and has nothing to do with the actual operation of the trigger.

== Action Options Explained ==

Once you have matched text from the game, you can initiate a single action, or a series of multiple actions. Actions will fire in the order they are listed.

[[File:trigger-actions.png]]

Above is a simple example of three separate actions that will happen when a trigger fires.

=== Simplified Scripting ===

The Nexus client allows for fifteen different [[SimplifiedScripting|simplified scripting]] actions. In most cases instantly returning a command is the best option. However, the Nexus client will allow you to loop through commands, use if statements, wait commands, highlight text, and much more.

All of these options, with full explanations and examples can be found here: [[SimplifiedScripting|simplified scripting]].

=== Advanced Scripting ===

There are two main [[AdvancedScripting|advanced scripting]] options. You can ''Call function'' or you can ''Execute script''. Both options allow for the use of javascript. You can learn more and [[functions]] here and more about [[javascript]] here.

== Examples ==
You can view some example triggers on the [[examples]] page.

== Regular Expression Help ==
* http://www.regular-expressions.info/

Triggers

2016-02-19T05:22:00Z

Justin:

Triggers are a very powerful and versatile type of reflexes. Triggers allow you to automatically react when text (and other events) is sent to your character from the game.

A few brief examples of things triggers can do:

* Automatically send commands to the game when certain text is received.
* Hide unimportant lines you don't want to see.
* Highlight lines of text you do not want to accidentally miss.
* Modify portions of the lines received from the game.
* Save data in a variable for later use. Such as how much gold you picked up or the name of a player that hit you.

The basic usage of triggers is similar to that of [[aliases]] or [[keybinds]]. One thing to be careful of is that by default, triggers can match anywhere in the received text, not only at the beginning (you can change the ''Matching Type'' accordingly, if desired).

== How to Create a New Trigger ==

Triggers are a reflex. They are created and managed from the Reflexes tab in the settings window. To open the settings window, click on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your main game screen

=== Step 1. Open the settings page and click the 'Reflexes' tab. ===

To create a new trigger, open your settings window by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

In the settings window, click on the 'Reflexes' tab as shown in the image below.

[[File:tab-reflexes.png|frame|center|Setting window displaying the reflexes tab.]]

=== Step 2. Click the 'Add' Button and select 'Add a Trigger'. ===

There are several different reflexes you can create. We want to create a trigger. In order to do this, click the 'Add' button located in the left pane and then click on 'Add a Trigger'. This will create a new, undefined trigger.

Should you want to delete a trigger, you can select the trigger from the list, and then click the 'Remove' button.

[[File:Trigger-create.png|frame|center|Example of creating a new trigger.]]

=== Step 3: Triggers Options. ===

There are two main option sections for triggers; '''Matching''' and '''Actions'''.

'''Matching''' is used to find the text you would like to use for this trigger. When the game sends text to your character that matches, it will automatically send the action defined below it.

'''Actions''' is what will happen when the trigger matches text from the game. Actions can be used to automatically send text to the game, highlight you want to stand out, create complicated functions, and other things.

[[File:trigger-blank.png|frame|center|This is a blank trigger. It will not do anything until you add text to match and an action to do when that text is matched.]]

== Matching Options Explained ==

Matching is used to find text sent from the game to create an action for. You can match entire lines of text, single words, partial lines, and lines of text with variable words.

[[File:trigger-matching.png]]

There are five options for matching text.

=== Trigger Text ===

This field is required and contains the text to match.

Examples of Trigger Text:
* You have recovered balance.
* You have recovered
* recovered balance.
* You have recovered balance.

This works hand in hand with the '''Matching Type''' option. See below.

There are times when you'll want to use wildcard matches in your triggers. Say you want to make an alert when someone enters the room, you can surround a word in <>'s to assign it to a variable. If an example line is ''Jeremy enters from the north'', you could configure your trigger to match on ''<person> enters from the <direction>''. As an added bonus, you can then use @person and @direction as variables in the trigger actions.

=== Matching Type ===

There are four options for matching text.

* '''Contains''': This will match any line that has your trigger text in it.
* '''Begins with''': Will only match a line that starts with your trigger text in it.
* '''Exact match''': Will only match a line that matches exactly like your trigger text.
* '''Regular expression''': This will match any regular expression patterns. This is advanced, but good to learn.

In most cases you will want to use ''Contains'' option unless you have more complicated situations.

=== Whole Words Only ===

If checked, the trigger will only match whole words.

For example; you create a trigger with trigger text set to 'You have recovered bal'.

If the game sends the text - You have recovered balance. - it will '''NOT''' match, because 'balance.' is a different whole word than 'bal'.

If I uncheck 'Whole words only', the trigger would work.

In almost all cases you will just want to keep 'Whole words only' turned on and be sure to include the full trigger text. Remember that whole words are separated by spaces and punctuation is considered part of a word.

=== Match Case ===

If checked, capitalization must match.

For example, if checked, 'You have recovered balance' is not the same as 'You HAVE reCOvered balance'.

If unchecked, the example above will work.

=== Trigger Name ===

(Optional) The name of the trigger. The name is an identifier that will show up in your list of triggers. It is used for organizing your triggers. It is not required for your trigger and has nothing to do with the actual operation of the trigger.

== Action Options Explained ==

Once you have matched text from the game, you can initiate a single action, or a series of multiple actions. Actions will fire in the order they are listed.

[[File:trigger-actions.png]]

Above is a simple example of three separate actions that will happen when a trigger fires.

=== Simplified Scripting ===

The Nexus client allows for fifteen different [[SimplifiedScripting|simplified scripting]] actions. In most cases instantly returning a command is the best option. However, the Nexus client will allow you to loop through commands, use if statements, wait commands, highlight text, and much more.

All of these options, with full explanations and examples can be found here: [[SimplifiedScripting|simplified scripting]].

=== Advanced Scripting ===

There are two main [[AdvancedScripting|advanced scripting]] options. You can ''Call function'' or you can ''Execute script''. Both options allow for the use of javascript. You can learn more and [[functions]] here and more about [[javascript]] here.

== Examples ==
You can view some example triggers on the [[examples]] page.

== Regular Expression Help ==
* http://www.regular-expressions.info/

Triggers

2016-02-19T05:20:49Z

Justin:

Triggers are a very powerful and versatile type of reflexes. Triggers allow you to automatically react when text (and other events) is sent to your character from the game.

A few brief examples of things triggers can do:

* Automatically send commands to the game when certain text is received.
* Hide unimportant lines you don't want to see.
* Highlight lines of text you do not want to accidentally miss.
* Modify portions of the lines received from the game.
* Save data in a variable for later use. Such as how much gold you picked up or the name of a player that hit you.

The basic usage of triggers is similar to that of [[aliases]] or [[keybinds]]. One thing to be careful of is that by default, triggers can match anywhere in the received text, not only at the beginning (you can change the ''Matching Type'' accordingly, if desired).

== How to Create a New Trigger ==

Triggers are a reflex. They are created and managed from the Reflexes tab in the settings window. To open the settings window, click on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your main game screen

=== Step 1. Open the settings page and click the 'Reflexes' tab. ===

To create a new trigger, open your settings window by clicking on the gear icon [[File:Settings_icon.jpg|text-bottom]] in the lower right part of your game screen. This will popup a new window in your browser.

In the settings window, click on the 'Reflexes' tab as shown in the image below.

[[File:tab-reflexes.png|frame|center|Setting window displaying the reflexes tab.]]

=== Step 2. Click the 'Add' Button and select 'Add a Trigger'. ===

There are several different reflexes you can create. We want to create a trigger. In order to do this, click the 'Add' button located in the left pane and then click on 'Add a Trigger'. This will create a new, undefined trigger.

Should you want to delete a trigger, you can select the trigger from the list, and then click the 'Remove' button.

[[File:Trigger-create.png|frame|center|Example of creating a new trigger.]]

=== Step 3: Triggers Options. ===

There are two main option sections for triggers; '''Matching''' and '''Actions'''.

'''Matching''' is used to find the text you would like to use for this trigger. When the game sends text to your character that matches, it will automatically send the action defined below it.

'''Actions''' is what will happen when the trigger matches text from the game. Actions can be used to automatically send text to the game, highlight you want to stand out, create complicated functions, and other things.

[[File:trigger-blank.png|frame|center|This is a blank trigger. It will not do anything until you add text to match and an action to do when that text is matched.]]

== Matching Options Explained ==

Matching is used to find text sent from the game to create an action for. You can match entire lines of text, single words, partial lines, and lines of text with variable words.

[[File:trigger-matching.png]]

There are five options for matching text.

=== Trigger Text ===

This field is required and contains the text to match.

Examples of Trigger Text:
* You have recovered balance.
* You have recovered
* recovered balance.
* You have recovered balance.

This works hand in hand with the '''Matching Type''' option. See below.

There are times when you'll want to use wildcard matches in your triggers. Say you want to make an alert when someone enters the room, you can surround a word in <>'s to assign it to a variable. If an example line is ''Jeremy enters from the north'', you would enter ''<person> enters from the <direction>'' as your trigger text. As an added bonus, you can then use @person and @direction as variables in the trigger.

=== Matching Type ===

There are four options for matching text.

* '''Contains''': This will match any line that has your trigger text in it.
* '''Begins with''': Will only match a line that starts with your trigger text in it.
* '''Exact match''': Will only match a line that matches exactly like your trigger text.
* '''Regular expression''': This will match any regular expression patterns. This is advanced, but good to learn.

In most cases you will want to use ''Contains'' option unless you have more complicated situations.

=== Whole Words Only ===

If checked, the trigger will only match whole words.

For example; you create a trigger with trigger text set to 'You have recovered bal'.

If the game sends the text - You have recovered balance. - it will '''NOT''' match, because 'balance.' is a different whole word than 'bal'.

If I uncheck 'Whole words only', the trigger would work.

In almost all cases you will just want to keep 'Whole words only' turned on and be sure to include the full trigger text. Remember that whole words are separated by spaces and punctuation is considered part of a word.

=== Match Case ===

If checked, capitalization must match.

For example, if checked, 'You have recovered balance' is not the same as 'You HAVE reCOvered balance'.

If unchecked, the example above will work.

=== Trigger Name ===

(Optional) The name of the trigger. The name is an identifier that will show up in your list of triggers. It is used for organizing your triggers. It is not required for your trigger and has nothing to do with the actual operation of the trigger.

== Action Options Explained ==

Once you have matched text from the game, you can initiate a single action, or a series of multiple actions. Actions will fire in the order they are listed.

[[File:trigger-actions.png]]

Above is a simple example of three separate actions that will happen when a trigger fires.

=== Simplified Scripting ===

The Nexus client allows for fifteen different [[SimplifiedScripting|simplified scripting]] actions. In most cases instantly returning a command is the best option. However, the Nexus client will allow you to loop through commands, use if statements, wait commands, highlight text, and much more.

All of these options, with full explanations and examples can be found here: [[SimplifiedScripting|simplified scripting]].

=== Advanced Scripting ===

There are two main [[AdvancedScripting|advanced scripting]] options. You can ''Call function'' or you can ''Execute script''. Both options allow for the use of javascript. You can learn more and [[functions]] here and more about [[javascript]] here.

== Examples ==
You can view some example triggers on the [[examples]] page.

== Regular Expression Help ==
* http://www.regular-expressions.info/

GMCP

2016-02-16T23:45:58Z

Justin:

[[File:Aetolia-dwarf.jpg|right|frame|caption|A dwarf Terradrim from Aetolia.]] General MUD Telnet Protocol (GMCP) is a protocol used to send data from the game server to the player client. This data transfer happens behind the scenes and is not seen by the players. This allows the game server to send messages to the client to update basic character, room, and game information. Character health is an example of information that is continually passed to the client from the game.

These messages can also be accessed by the player for use in [[reflexes]]. We are working simplifying the process of capturing GMCP data for use in the client in a future version of the client.

There is a configuration option in the Advanced Settings tab that will allow you to see GMCP messages as they happen.

Module and message names are not case sensitive. JSON key names are case sensitive.

=== Supported modules ===

This documentation covers the following GMCP messages for the Iron Realms Games.

* Core: core functionality
* Char: information about a character
* Char.Afflictions: information the characters afflictions
* Char.Defences- information the characters defences
* Char.Items: information about items in inventory and room, with live updates
* Char.Skills: information about skills known by the player
* Comm.Channel: identification of communication channels and player lists
* Room: various information about the current room
* Redirect: redirect outpot to another window
* IRE.Composer: IRE-specific, used to edit bigger texts client-side
* IRE.FileStore: used internally by the Nexus client
* IRE.Misc: used internally by the fMUD and Nexus clients
* IRE.Rift: IRE-specific, transmits information about the Rift contents
* IRE.Sound: Yes. Sound can be sent.
* IRE.Target: information about the current player target.
* IRE.Tasks: information about tasks, quests, and achievements.
* IRE.Time: information about the current time and date conditions in the game.
* IRE.Wiz: used internally by the Nexus client

=== Supported messages by modules ===

==== Core ====
* Sent by client:
** Core.Hello
*** Needs to be the first message that the client sends, used to identify the client
*** Message body is an object with keys "client" and "version", containing the client's name and version
*** '''Example''': Core.Hello {"Client":"Mudlet","Version":"3.0.0"}
** Core.Supports.Set
*** Notifies the server about packages supported by the client
*** If another Core.Supports.*** package has been received earlier, the list is deleted and replaced with the new one
*** Message body is an array of strings, each consisting of the module name and version, separated by space
*** Module version is a positive non-zero integer
*** Most client implementations will only need to send Set once and won't need Add/Remove; exceptions are module implementations provided by plug-ins
*** '''Example''': Core.Supports.Set [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Add
*** Similar to Set, but appends the supported module list to the one sent earlier
*** If no list was sent yet, the behaviour is identical to Set
*** If the list includes module names that were already included earlier, the new version number takes precedence over the previously sent one, even if the newly sent number is lower
*** Message body format is identical to that of Set
*** '''Example''': Core.Supports.Add [ "Char 1", "Char.Skills 1", "Char.Items 1" ]
** Core.Supports.Remove
*** Removes specified modules from the list of supported modules
*** Message body format is similar to Set, except that module version numbers are optional and ignored if given
*** '''Example''': Core.Supports.Remove [ "Char", "Char.Skills", "Char.Items" ]
** Core.KeepAlive
*** Causes the server to reset the timeout for the logged character, no message body
** Core.Ping
*** causes the server to send a Core.Ping back
*** message body is a number which indicates average ping time from previous requests, if available
*** '''Example''': Core.Ping 120

* Sent by server:
** Core.Ping
*** Sent in reply to Core.Ping. No body.
** Core.Goodbye
*** Sent by server immediately before terminating a connection
*** Message body is a string to be shown to the user - it can explain the reason for the disconnect
*** '''Example''': Core.Goodbye "Goodbye, adventurer"

==== Char ====
* Sent by client:
** Char.Login
*** Used to log in a character, only interpreted if no character is logged in for that connection
*** Message body is an object with keys "name" and "password"
*** '''Example''': Char.Login { "name": "somename", "password": "somepassword" }

* Sent by server:
** Char.Name
*** Sends the character name and full name which includes the title. This is only sent on login.
*** '''Example''': Char.Name { "name": "Olad", "fullname": "Neophyte Olad" }
** Char.Vitals
*** Basic character attributes such as health, mana, etc.
*** Message body is an object containing several variables
*** Additionally, each variable is included in a string, in the format name:cur/max
*** Interpretation of the variables is game specific
*** It is generally safe to assume that the known values are numbers (even though encoded as strings), but other datatypes can be present
*** The "charstats" attribute, if present, holds a list of strings that the client may choose to display to the player in a client-specific way, these hold information about the character state that the game wishes to show to the player
*** '''Example''': Char.Vitals { "hp": "4500", "maxhp": "4800", "mp": "1200", "maxmp": "2500", "ep": "15000", "maxep": "16000", "wp": "14000", "maxwp": "15000", "nl": "10", "string": "H:4500/4800 M:1200/2500 E:15000/16000 W:14000/15000 NL:10/100" }
<table>
<div class="row">
<div class="large-4 columns">
'''Achaea'''
* All classes: Bleed, Rage
* Apostates: Essence
* Bard: Stance, Voice Balance
* Blademaster: Stance
* Druid: Current Morph, Sunlight Energy
* Infernal: Essence, Weaponmastery Spec
* Magi: Channels
* Monk: Kai Energy, Tekura stance
* Occultist: Karma, Entity Balance
* Paladin: Devotion, Weaponmastery Spec
* Priest: Devotion
* Runewarden: Weaponmastery Spec
* Sentinel: Current Morph
* Serpent: Secreted Venom
* Shaman: Number of spirits bound
* Sylvan: Elemental Channels, Sunlight Energy
</div>
<div class="large-4 columns">'''Aetolia'''</div>
<div class="large-4 columns">'''Imperian'''</div>
<div class="large-4 columns">'''Lusternia'''</div>
<div class="large-4 columns">'''MKO'''</div>
</div>
</table>
** Char.StatusVars
*** Sent by server after a successful login or after the module is enabled
*** Contains a list of character variables (level, race, etc)
*** Message body is an object
*** Each object element is a name-caption pair, name is the internal name and caption the user-visible one
*** '''Example''': Char.StatusVars { "level": "Level", "race": "Race", "guild": "Guild" }
** Char.Status
*** Values of character values defined by StatusVars.
*** A full list is sent by server right after StatusVars, and changes are sent in subsequent messages as they occur.
*** With the exception of the initial Status message, messages only contain changed values; if a variable is not included, it has not changed since the previous Status message.
*** Message body is an object.
*** Each object element is a name-value pair, name is the internal name defined by the StatusVars message and value is the variable value.
*** '''Example''': Char.Status { "level": "58", "city": "Antioch" }

==== Char.Afflictions ====
* Sent by server:
** Char.Afflictions.List
*** Sends an array of current character afflictions.
**** name: The name of the affliction
**** cure: The basic cure of the affliction. This is used for links to cure even though other options may exist to cure the affliction.
**** desc: A description of what this affliction does.
*** '''Example''': Char.Afflictions.List [ { "name": "weariness", "cure": "eat kelp", "desc": "Decreases cutting and blunt damage that you inflict by 30%." }, { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }, { "name": "slow herbs", "cure": "apply epidermal", "desc": "Increases the time needed to regain herb balance by 1.25 seconds." }, { "name": "nausea", "cure": "eat nightshade", "desc": "Causes periodic vomiting, which does damage and increases hunger." } ]
** Char.Afflictions.Add
*** Add an affliction to the character.
*** '''Example''': Char.Afflictions.Add { "name": "asthma", "cure": "eat kelp", "desc": "Makes you unable to smoke pipes." }
** Char.Afflictions.Remove
*** Removes an affliction from the character.
*** '''Example''': Char.Afflictions.Remove [ "asthma" ]

==== Char.Defences====
* Sent by server:
** Char.Defences.List
*** Send an array of all the defences a character currently has.
**** name: The name of the defence.
**** desc: The description of the defence.
*** '''Example''': Char.Defences.List [ { "name": "deaf", "desc": "deaf" }, { "name": "blind", "desc": "blind" }, { "name": "nightsight", "desc": "nightsight" } ]
** Char.Defences.Add
*** Sent when a defence is added to a character.
*** '''Example''': Char.Defences.Add { "name": "deaf", "desc": "deaf" }
** Char.Defences.Remove
*** Sent when a defence is removed from a character.
*** '''Example''': Char.Defences.Remove [ "blind" ]

==== Char.Items ====
* Sent by client:
** Char.Items.Contents
*** Request for the server to send the list of items located inside another item.
*** Message body is a number identifying the item.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Item.Contents 12345
** Char.Items.Inv
*** Request for the server to send the list of items in player's inventory.
*** Message body is empty.
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Inv ""
** Char.Items.Room
*** Sent by the client to refresh the items in a room.
*** Message body is empty
*** Causes the server to send back an appropriate Char.Items.List message.
*** '''Example''': Char.Items.Room ""

* Sent by server:
** Char.Items.List
*** List of items at a specified location (room, inv, held container)
*** Message body is an object with keys "location" and "items"
*** Location value is a string, "inv", "room", or "repNUMBER" - the last one is container identification
*** Items value is an array, whose each item is an object with keys "id", "name" and optionally "attrib"
*** ID is a number identifying the item, name is a string containing a short player-visible item description
*** Icon is the image the item is associated with in the client.
*** Attrib is a string consisting of characters describing item properties:
**** "w" = worn,
**** "W" = wearable but not worn
**** "l" = wielded
**** "g" = groupable
**** "c" = container
**** "t" = takeable
**** "m" = monster
**** "d" = dead monster
**** "x" = should not be targeted (guards, ...)
*** '''Example''': Char.Items.List { "location": "inv", "items": [ { "id": "12807", "name": "a personal journal", "icon": "scroll", "attrib": "l" }, { "id": "303060", "name": "a gold nugget", "icon": "commodity" } ] }
** Char.Items.Add
*** Informs the client about an item being added to the specified location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an object with the same structure as one item from the items array of List
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "c" } }
*** '''Example''': Char.Items.Add { "location": "room", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
*** '''Example''': Char.Items.Add { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity", "attrib": "t" } }
** Char.Items.Remove
*** Informs the client about an item being removed from the location
*** Message body is an object with keys "location" and "item"
*** Location is same as with List, item is an integer value identifying the item
*** '''Example''': Char.Items.Remove { "location": "room", "item": { "id": "239602", "name": "an elegant white letter", "icon": "container", "attrib": "t" } }
*** '''Example''': Char.Items.Remove { "location": "inv", "item": { "id": "303060", "name": "a gold nugget", "icon": "commodity" } }
** Char.Items.Update
*** Informs the client about an item's attributes being changed - only sent for inventory items
*** Message body syntax the same as with Add
*** '''Example''': Char.Items.Update { "location": "inv", "item": { "id": "60572", "name": "an ornate steel rapier" } }

==== Char.Skills ====
* Sent by client:
** Char.Skills.Get
*** Sent by client to request skill information
*** Message body is an object with keys "group" and "name"
*** If both group and name is provided, the server will send Char.Skills.Info for the specified skill
*** If group is provided but name is not, the server will send Char.Skills.List for that group
*** Otherwise the server will send Char.Skills.Groups
*** '''Example''': Char.Skills.Get {"group":"Perception"}
*** '''Example''': Char.Skills.Get {"group":"perception","name":"Deathsight"}

* Sent by server:
** Char.Skills.Groups
*** Groups of skills available to the character
*** Sent by server on request or at any time (usually if the list changes)
*** For IRE games, groups are skills like Survival or Elemancy
*** Message body is an array including the name and current rank of each skill the character has.
*** '''Example''': Char.Skills.Groups [ { "name": "Perception", "rank": "Transcendent (100%)" }, { "name": "Survival", "rank": "Inept (0%)" }, { "name": "Weaponry", "rank": "Inept (0%)" }, { "name": "Tattoos", "rank": "Inept (0%)" }, { "name": "Evasion", "rank": "Inept (0%)" }, { "name": "Engineering", "rank": "Inept (0%)" }, { "name": "Taming", "rank": "Inept (0%)" }, { "name": "Concoctions", "rank": "Inept (0%)" }, { "name": "Toxins", "rank": "Inept (0%)" }, { "name": "Smithing", "rank": "Inept (0%)" }, { "name": "Malignosis", "rank": "Adept (1%)" }, { "name": "Necromancy", "rank": "Inept (0%)" }, { "name": "Evileye", "rank": "Adept (40%)" } ]

** Char.Skills.List
*** List of skills in a group available to the character
*** Sent by server on request only
*** For IRE games, this is the list visible on AB <skillname>
*** Message body is an object with keys "group", "list", and "desc".
*** The list value is an array of strings, each being the name of one skill
*** '''Example''': Char.Skills.List { "group": "perception", "list": [ "Looking", "Glancing", "Secrets", "Decaylist", "Squinting", "Flyers", "Observe", "Farsight", "Containerlist", "Vigilance", "Treewatch", "Deathsight", "Pipelist", "Elixlist", "Search", "Letterlist", "Booklist", "Skywatch", "PowerNodes", "Keylist", "Alertness", "Rites", "Traps", "Magicklist", "Nightsight", "Hypersight", "Thirdeye", "Tattoos", "Discernment", "Wormholes", "Rivensense", "Contemplation", "Scan", "Telesense", "Appraise", "Trueassess", "Artifactlist", "Warning", "Viewshrine", "Landsense" ], "descs": [ "Gain knowledge of your immediate surroundings.", "See summarized information about your surroundings.", "Discover hidden exits.", "How much more time do those items have?", "See extended distances in your line of sight.", "Take notice of those in the skies.", "Gain information about your extended surroundings.", "Attempt to locate another player from afar.", "What do you have in your containers?", "Increase your resistance to hypnosis.", "Watch the forest canopies for movement.", "Attune yourself to the Underworld.", "Scan your pipes with utmost speed.", "Quickly discover what elixirs and salves you are holding.", "Search your location for hidden beings.", "Quick glance of all your letters.", "Scan the titles of books you own.", "Watch the skies for movement.", "Detect the nodes of power in your area.", "See a list of your keys and which doors they open.", "Heightened awareness of your surroundings.", "View the holy rites operating in your location.", "The ability to search for traps in your location.", "Check the status of your magickal items.", "Use infravision to see in the dark.", "See the actions of cloaked players.", "Give yourself the power of the third eye.", "Discover what tattoos are on another player.", "Discover what defences are protecting an individual.", "The ability to sense wormholes in your location.", "Sense the bodies of the recently slain.", "Perceive the state of another's mental strength.", "Seekout the locations of your allies and enemies.", "Heighten your awareness to telepathic attempts.", "Quickly take note of someone's carried possessions.", "Gain more detailed information concerning your foe.", "See what artifact powers surround an individual.", "Watch for the prying eyes of the enemy.", "Gain a detailed understanding of a shrine.", "The ability to recognize mortals entering the realm." ] }

** Char.Skills.Info
*** Information about a single skill, only sent upon request
*** Message body is an object, keys are "group", "skill", and "info", values are strings
*** Group and skill identify the request, info is a description (usually multi-line) of the skill's functionality and usage
*** '''Example''': Char.Skills.Info { "group": "perception", "skill": "deathsight", "info": "Syntax: DEATHSIGHT\n RELAX DEATHSIGHT\n\nUsing this ability, your mind is now capable of attuning itself to the realm of the dead. While doing so, you will be alerted whenever anyone dies." }
==== Comm.Channel ====
* Sent by client:
** Comm.Channel.Players
*** Request for the server to send Comm.Channel.Players
*** No message body.
*** '''Example''': Comm.Channel.Players ""
** Comm.Channel.Enable
*** Used to tell the game to turn on a character channel without typing in a command line command.
*** Example: Comm.Channel.Enable "newbie"
*** Example: Comm.Channel.Enable "clt Consortium"

* Sent by server:
** Comm.Channel.Players
*** List of players and organizations (city, guild, ...) that they share with this player
*** Message body is an array with each element describing one player
*** Each element is an object with keys "name" and "channels", name is a string, channels is an array
*** The channels array may be omitted if empty; if given, it is a list of organization names
*** '''Example''': Comm.Channel.Players [{"name": "Player1", "channels: ["Some city", "Some guild"]}, {"name": "Player2"}]
*** '''Example''': Comm.Channel.Players [ { "name": "Ahkan", "channels": [ "The City of Stavenn" ] }, { "name": "Sharatar", "channels": [ "The City of Stavenn", "The Revenants" ] } ]

** Comm.Channel.List
*** List of communication channels available to the player, sent on login/negotiation and if changed
*** Message body is an array of objects, each object representing one channel
*** Each object has keys "name", "caption" and "command" - name is internal name, caption is player-visible name, command is command used to communicate over this channel
*** '''Example''': Comm.Channel.List [{"name":"ct", "caption":"Some city", "command":"ct"}, {"name":"gt", "caption":"Some guild", "command":"gt"}]
*** '''Example''': Comm.Channel.List [ { "name": "newbie", "caption": "Newbie", "command": "newbie" }, { "name": "market", "caption": "Market", "command": "market" }, { "name": "ct", "caption": "Stavenn", "command": "ct" }, { "name": "gt", "caption": "Revenants", "command": "gt" } ]

** Comm.Channel.Start
*** Informs the client that text that follows is something said over a communication channel
*** Message body is a text containing the channel name
*** For tells from/to another player, the channel name is "tell Name"
*** '''Example''': Comm.Channel.Start "ct"
*** '''Example''' :Comm.Channel.Start "tell Jeremy"
** Comm.Channel.End
*** Ends a channel text started by Comm.Channel.Start
*** Message body is a text containing the channel name
*** '''Example''': Comm.Channel.End "tell Jeremy"

** Comm.Channel.Text
*** The text of the communication that you heard, who spoke, and which channel it was on
*** '''Example''': Comm.Channel.Text { "channel": "says", "talker": "Tecton", "text": "(Tecton the Terraformer says, \"Are we releasing dragon lairs or the phase artefact first?\"" }
*** '''Example''': Comm.Channel.Text { "channel": "tell Jeremy", "talker": "Olad", "text": "\u001b[0;1;33mYou tell Jeremy, \"Hi.\"\u001b[0;37m" }
*** '''Example''': Comm.Channel.Text { "channel": "newbie", "talker": "Olad", "text": "\u001b[0;1;32m(Newbie): You say, \"Hello.\"\u001b[0;37m" }

==== Room ====
* Sent by server:
** Room.Info
*** Contains information about the room that the player is in. Some of these may be IRE-specific
*** Message body is an object with the following keys
**** "num" - number identifying the room
**** "name" - string containing the brief description
**** "area" - string containing area name
**** "environment" - string containing environment type ("Hills", "Ocean", ...)
**** "coords" - room coordinates (string of numbers separated by commas - area,X,Y,X,building, building is optional
**** "map" - map information - URL pointing to a map image, followed by X and Y room (not pixel) coordinates on the map
**** "details" - array holding further information about a room - shop,bank,...
**** "exits" - object containing exits, each key is a direction and each value is the number identifying the target room
*** '''Example''': Room.Info {"num": 12345, "name": "On a hill", "area": "Barren hills", "environment": "Hills", "coords": "45,5,4,3", "map": "www.imperian.com/itex/maps/clientmap.php?map=45&level=3 5 4", "exits": { "n": 12344, "se": 12336 }, "details": [ "shop", "bank" ] }
** Room.WrongDir
*** Sent if the player attempts to move in a non-existant direction using the standard movement commands
*** Upon receiving this message, the client can safely assume that the specified direction does not lead anywhere at this time
*** Message body is a string with the name if the non-existant exit
*** Example: Room.WrongDir "ne"
** Room.Players
*** Object containing player details, each key is the short name of the player and each value is the full name including titles for the player
*** '''Example''': Room.Players {"tecton":"Tecton, the Terraformer", "cardan":"Cardan, the Curious"}!
** Room.AddPlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being added to the room.
*** '''Example''': Room.AddPlayer { "name": "Cardan", "fullname": "(Cardan, the Curious)" }!
** Room.RemovePlayer
*** Message body has the same object structure as Room.Players except that it only contains the one player being removed from the room.
*** '''Example''': Room.RemovePlayer "Cardan"

==== Redirect ====
* Sent by server:
** Redirect.Window
*** Specifies a window to redirect further input to
*** Message body is a string specifying the window to redirect to
*** The main window is referred to as "main", and is the default if the message body is omitted or empty
*** Example: Redirect.Window "map"

==== IRE.Composer ====
* Sent by server:
** IRE.Composer.Edit
*** Sent by the server when the player enters an in-game editor. Body is an object, with keys "title" and "text". Text contains the current buffer, title is a title that can be shown to the user.
*** '''Example''': IRE.Composer.Edit { "title": "Composer", "text": "" }

* Sent by client:
** IRE.Composer.SetBuffer
*** Sent by the client upon successfully editing a text which was sent to the client in an IRE.Composer.Edit message earlier
*** Sending this message only changes the edit buffer, but does not end the editing session
*** On IRE games, the client may send the command ***save to save a text, or command ***quit to abort editing (IRE.Composer.SetBuffer is not sent in this case) - this behaviour is IRE-specific and is one of the reasons why the Composer module is in the IRE namespace
*** '''Example''': IRE.Composer.SetBuffer "This is a bunch of text."

==== IRE.Misc ====
* Sent by client:
** IRE.Misc.Voted
*** Informs the game a vote button was clicked.
*** Example: IRE.Misc.Voted ""

* Sent by server:
** IRE.Misc.RemindVote
*** Message sent to remind the player to vote.
*** '''Example''': IRE.Misc.RemindVote "http://www.imperian.com/vote"

** IRE.Misc.Achievement
*** Used to send basic achievement data to the client.
*** '''Example''': IRE.Misc.Achievement [{"name": "HighestLevelAchieved", "value": "89" }]

** IRE.Misc.URL
*** Sends a url to the client to open in a window when clicked.
*** '''Example''': IRE.Misc.URL[{"url": "http://www.imperian.com/tos", "window": "ire_game_tos" }]

** IRE.MISC.Tip
*** Sends a line of text to the client.
*** '''Example''': IRE.Misc.Tip "This is a tip!"

==== IRE.Rift ====
* Sent by server:
** IRE.Rift.List
*** contents of a Rift storage
*** sent upon receiving the IRE.Rift.Request message
*** message body is an array, with each element being an object containing three keys - "name" is item name, "amount" is a number holding the item's amount, and "desc" is user-visible description
** IRE.Rift.Change
*** sent whenever the item amount in a Rift changes
*** message body is an object with the same structure as one element of an array sent with the IRE.Rift.List message

* Sent by client:
** IRE.Rift.Request
*** asks the server to send the Rift contents using the IRE.Rift.List message

==== IRE.Sound ====

* Sent by server:
** IRE.Sound.Play
** IRE.Sound.Stop
** IRE.Sound.Stopall
** IRE.Sound.Preload

==== IRE.Target ====
* Sent by client:
** IRE.Target.Set
*** Sends the currently set target to the server to be used by the internal alias system.
*** '''Example''': IRE.Target.Set "1101"
* Sent by server

** IRE.Target.Set
*** Sends the target the client is trying to set. This is called from cycling targets with tab targeting.
*** '''Example''': IRE.Target.Set "1101"
** IRE.Target.Info
*** Sends an array with the current target information.
*** '''Example''': IRE.Target.Info { "id": "1101", "short_desc": "a brawny goblin smith", "hpperc": "100%" }
** IRE.Target.Request

==== IRE.Tasks ====

* Sent by client:
** IRE.Tasks.Request

* Sent by server:
** IRE.Tasks.List
*** This is used to send a list of quest, tasks, and achievements, depending on what the game supports.
*** Sends an array of items with the following keys:
**** id: A numeric identifier
**** name: The name of the quest, task, or achievement.
**** type: Is this a quest, task, or achievement.
**** cmd: The command to get more information for the quest. Good for MXP links.
**** desc: The description of the event.
**** status: 0 or 1 based on if it is completed or not.
**** group: What group should this be assigned to. This is mainly for client display purposes.
*** '''Example''': IRE.Tasks.List [ { "id": "184", "name": "For the sake of the village", "desc": "The herbs in Maeven's garden are painstakingly cared for so that her fellow villagers can stay healthy. She won't object to borrowing a bit of the magick power the bakuls have, if it can help with her work.\n\nThe bakul herbalist might have something Maeven wants.", "type": "quests", "cmd": "quest For the sake of the village", "status": "0", "group": "Current Quests" }, { "id": "313", "name": "Apostate", "desc": "Destroy a Shrine.", "type": "achievements", "cmd": "achievement apostate", "status": "0", "group": "Sects" } ]
** IRE.Tasks.Update
** IRE.Tasks.Completed

==== IRE.Time ====
* Sent by client:
** IRE.Time.Request

* Sent by server:
** IRE.Time.List
*** A list of the current time condition in the game world.
*** Used in the client to display the the day/night indicator.
*** '''Example''': IRE.Time.List { "day": "1", "mon": "1", "month": "Letum", "year": "98", "hour": "41", "daynight": "80" }
** IRE.Time.Update
*** Used to update time conditions.
*** '''Example''': IRE.Time.Update { "daynight": "112" }

Functions

2016-02-16T20:06:42Z

Justin:

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

=== Misc. ===
* '''to_number(val)''' - Convert a string number to a value.

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

== Examples ==
[[GMCP Data|GMCPData]]: This example reads some data coming over via [[GMCP]] and assigns it to variables.