Actions

Main Page: Difference between revisions

From Iron Realms Nexus Client Documentation

← Older edit
Jeremy (talk | contribs)
Bureaucrats, Administrators
1,264 edits
Replace Forums section with per-game Discord invites; update help paragraph to reference Discord instead of forums
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Nexus 3.0==
__NOTOC__
Iron Realms Entertainment is in the process of a major Nexus update. Nexus 3.0 will be a cross-platform client that offers a consistent experience on desktop and mobile platforms.
<table>
<div class="row">
<div class="large-8 columns">
Welcome to the official documentation wiki for the Iron Realms Nexus 3.0 client, simply known as Nexus.


===New Feature List===
Are you looking for Nexus 2.0 documentation? You can find it here: [[Nexus 2.0|Nexus 2.0 Documentation]]
* Desktop and mobile applications.  
* Speed and responsiveness improvements.
* Access all IRE games from a single client.
* Adjust settings while not logged in with your character.
* Character management screens.
* Auto-login options.
* Improved character creation
* Connect to and play other MUDs


===Future Plans===
[[File:Nexus_3_Play_Window.png|alt=Screenshot of the Nexus 3 client's main play window]]
The development of Nexus will be ongoing. Here is a list of upcoming, planned features.
* Improved VI support.
* Messaging and News support when not logged in. (currently done in the unsupported IRE Helper App)
* Improved UI/UX.
* Implement Awesome Fonts completely for items, afflictions, and defenses. Producers can call which one is displayed game-side with the awesome font name, instead of our renamed versions.
* Lua support.
* Improve simplified and advanced scripting. Particularly for power users.
* Improve display for Who and Skill tabs.
* Party, Help, and News Tabs
* Improved Avatars. Displayed in chat, party tabs, etc.
* Improve the character select screen (basic character info, level, credits, etc)


===Client Downloads===
Key features of the Iron Realms Nexus Client include:
We are currently doing open beta testing for the browser, desktop, and android versions of the client. They are located here:
* Browser Version: https://betaclient.ironrealms.com
* Desktop Version: https://ironrealms.com/local/nexus-snapshot.exe
* Android Version: https://ironrealms.com/android
* iOS Version: Coming soon.


===How to Submit Bugs===
'''Windowed output''': The client offers separate windows for various functions such as main output, inventory, communication, graphical map, and more.
Please submit all bugs to the websites listed below. All of the following websites use the same database, but they allow you to log in as your character to submit bug reports.


* https://client.achaea.com/bugs
'''Adaptive window resizing''': If you are playing in your browser or desktop client, the windows automatically adjust their size based on the dimensions of your browser window.
* https://client.aetolia.com/bugs
* https://client.imperian.com/bugs
* https://client.lusternia.com/bugs
* https://client.starmourn.com/bugs


'''High customization''': Users have the ability to modify their client interface by removing or adding windows, moving tabs between windows, resizing windows, dragging column width and row height, changing the client's appearance, including colours and fonts, and even switching to full-screen mode. Additionally, users can control audio settings such as turning off music while keeping sound effects enabled.


There is an option to submit feedback in the client. Please do not use this. '''Use the websites listed above to submit bugs''' as it will allow you to see if the bug has been submitted already.
'''Cross-platform compatibility''': The Nexus Client is compatible with multiple operating systems, including Windows, Mac, Linux, iOS, and Android. You can find all of the applicable versions to access or install here: [[Client_Download|Download Nexus]]


You can find a changelog here: https://nexus.ironrealms.com/Changelog.
'''Cross-device functionality''': Nexus allows users to save macros and triggers, making them accessible across different devices. This means that macros and triggers created on a desktop can be used on a mobile device and vice versa. There are some limitations with this, mainly revolving around the use of custom javascript.


===Nexus 3.0 Documentation===
'''Graphical UI elements''': The client provides graphical enhancements such as graphical character creation, health and mana bars, icons that indicate common afflictions, balance and equilibrium icons, and more.
Listed below is the current documentation for Nexus 3.0. The documentation is a work in progress and will be updated heavily during the beta testing process.


====The Basics====
'''Scripting capabilities''': Nexus offers two types of scripting options - Simplified Scripting and Advanced Scripting. Advanced scripting is done in JavaScript and utilizes the General Mud Communication Protocol (GMCP), enabling users to track various in-game elements such as inventory, health, and room items from within their scripts. Simplified Scripting, on the other hand, is designed for users without any coding knowledge, allowing them to create powerful keybindings, macros, and aliases.
* [[client_overview|Overview]]
* [[3.0_Game_Client|The Game Client]]
* [[3.0_windows_and_tabs|Windows and Tabs]]
* [[3.0_keys_gauges|Keys, Gauges, Avatars]]
* [[3.0_general_functions|General Functions]]
* [[3.0_configuration_options|Configuration Options]]


====Client Settings====
'''Comprehensive documentation''': The official documentation wiki provides thorough resources examples and other supporting materials to assist users in making the most out of the Nexus Client. In addition, we have an active Discord community that can provide support as well. [https://discord.gg/Tz7t5SaD4q Join the Nexus Discord]
* [[3.0_display_options|Display Options]]
 
* [[3.0_colors|Colors]]
Please refer to this documentation for further guidance on utilizing the Iron Realms Nexus Client, its features, and customization options.
* [[3.0_buttons|Buttons]]
 
* [[3.0_reflex_packages|Reflex Packages]]
[[File:Nexus_3_Character_Creation.png|alt=Screenshot of the Nexus 3 graphical character creation screen]]
* [[3.0_reflexes|Reflexes]]
 
* [[3.0_variables|Variables]]
</div>
* [[3.0_import_export|Import/Export]]
<div class="large-4 columns">
* [[3.0_advanced|Advanced]]
 
* [[3.0_feedback|Feedback]]
===Need help?===
* [[3.0_help|Help]]
 
====Scripting====
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.
* [[3.0_simplified_scripting|Simplified Scripting]]
 
* [[3.0_advanced_scripting|Advanced Scripting]]
For example: '''newbie Can someone help me?'''
* [[GMCP|GMCP]]
 
* [[Predefined_variables|Predefinied Variables]]
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 than happy to assist you.
 
If that doesn't work, try asking on the game's Discord (linked below).
 
You can also use the in-game help system. Just type '''HELP''' to see the directory and instructions.
 
===Play===
* [https://play.achaea.com Achaea]
* [https://play.aetolia.com Aetolia]
* [https://play.imperian.com Imperian]
* [https://play.lusternia.com Lusternia]
* [https://play.starmourn.com Starmourn]
 
===Discord===
* [https://discord.gg/2v2upFTj8G Achaea Discord]
* [https://discord.gg/x2s7fY6 Aetolia Discord]
* [https://discord.gg/yjHU2ks Imperian Discord]
* [https://discord.gg/d8PECxD739 Lusternia Discord]
* [https://discord.gg/2e3WX3D Starmourn Discord]
 
===Game websites===
* [https://www.achaea.com Achaea]
* [https://www.aetolia.com Aetolia]
* [https://www.imperian.com Imperian]
* [https://www.lusternia.com Lusternia]
* [https://www.starmourn.com Starmourn]
 
{{Nexus_3_Sidebar}}
</div>
</div>
</table>

Latest revision as of 05:01, 19 May 2026

Welcome to the official documentation wiki for the Iron Realms Nexus 3.0 client, simply known as Nexus.

Are you looking for Nexus 2.0 documentation? You can find it here: Nexus 2.0 Documentation

Screenshot of the Nexus 3 client's main play window

Key features of the Iron Realms Nexus Client include:

Windowed output: The client offers separate windows for various functions such as main output, inventory, communication, graphical map, and more.

Adaptive window resizing: If you are playing in your browser or desktop client, the windows automatically adjust their size based on the dimensions of your browser window.

High customization: Users have the ability to modify their client interface by removing or adding windows, moving tabs between windows, resizing windows, dragging column width and row height, changing the client's appearance, including colours and fonts, and even switching to full-screen mode. Additionally, users can control audio settings such as turning off music while keeping sound effects enabled.

Cross-platform compatibility: The Nexus Client is compatible with multiple operating systems, including Windows, Mac, Linux, iOS, and Android. You can find all of the applicable versions to access or install here: Download Nexus

Cross-device functionality: Nexus allows users to save macros and triggers, making them accessible across different devices. This means that macros and triggers created on a desktop can be used on a mobile device and vice versa. There are some limitations with this, mainly revolving around the use of custom javascript.

Graphical UI elements: The client provides graphical enhancements such as graphical character creation, health and mana bars, icons that indicate common afflictions, balance and equilibrium icons, and more.

Scripting capabilities: Nexus offers two types of scripting options - Simplified Scripting and Advanced Scripting. Advanced scripting is done in JavaScript and utilizes the General Mud Communication Protocol (GMCP), enabling users to track various in-game elements such as inventory, health, and room items from within their scripts. Simplified Scripting, on the other hand, is designed for users without any coding knowledge, allowing them to create powerful keybindings, macros, and aliases.

Comprehensive documentation: The official documentation wiki provides thorough resources examples and other supporting materials to assist users in making the most out of the Nexus Client. In addition, we have an active Discord community that can provide support as well. Join the Nexus Discord

Please refer to this documentation for further guidance on utilizing the Iron Realms Nexus Client, its features, and customization options.

Screenshot of the Nexus 3 graphical character creation screen

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 than happy to assist you.

If that doesn't work, try asking on the game's Discord (linked below).

You can also use the in-game help system. Just type HELP to see the directory and instructions.

Play

Discord

Game websites


Nexus 3.0 Documentation

The following links describe how to use the Nexus Client.

The Basics

Client Settings

Scripting

Retrieved from "https://nexus.ironrealms.com/index.php?title=Main_Page&oldid=1771"