Actions

Nexus Client 3.0 Overview: Difference between revisions

From Iron Realms Nexus Client Documentation

(Created page with "__NOTOC__ <table> <div class="row"> <div class="large-8 columns"> ''You can find the documentation for the beta release of the Nexus 3.0 client here.'' === 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 thorou...")
 
No edit summary
 
(19 intermediate revisions by the same user not shown)
Line 3: Line 3:
<div class="row">
<div class="row">
<div class="large-8 columns">
<div class="large-8 columns">
''You can find the documentation for the beta release of the [[Nexus_3.0|Nexus 3.0]] client here.''
=== 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.
}}


Welcome to the official documentation wiki for the Iron Realms Nexus Client 3.0.


'''Core Features include:'''
'''Core Features include:'''


* '''[[Windows_and_Tabs|Windowed output]]'''. Separate windows for main output, inventory, communication, graphical map, and more!
* '''Truly cross-platform'''.
** Windows auto-resize based on browser window size.
** The Nexus client has browser, desktop, and Android versions. (iOS is coming soon) [[Client_Download|Find them here.]]
** Your character settings are saved in the cloud so they can be accessed from any device you're currently using.
** Save all of your characters to a single Nexus account. Log in with a single click.
** Access all IRE games from a single client.  
** Add login information for other games.
** Edit settings while not logged in to your character.


* '''[[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!
* '''[[3.0_windows_and_tabs|Windowed output]]'''.  
** Separate windows for main output, inventory, communication, graphical map, and more!
** Can easily grab tab to move windows around into any position or size you would like.
** Windows auto-resize based on app size.
** Swipe right and left to access special windows in mobile.


* '''Truly cross-platform'''. Nexus works on Windows, Mac, Linux, iOS, and Android!  
* '''[[3.0_windows_and_tabs|Highly customizable]]'''. You can get rid of windows or create new ones, move tabs from one window to another, resize windows, change colors, fonts, and more. Go full-screen! Turn music off but keep sound effects on!
** 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!
* '''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.
* '''[[3.0_keys_gauges|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.
* '''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.
** [[3.0_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.
** [[3.0_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.
** 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 ====
==== Screenshots ====
Line 60: Line 37:
<ul class="small-block-grid-3">
<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_-_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>
</ul>


</div>
</div>


<div class="large-4 columns">
<div class="large-4 columns">
{{Nexus_3_Sidebar}}


==== Need Help? ====
==== Need Help? ====
Line 81: Line 50:
For example: '''newbie Can someone help me?'''
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.
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, you might try asking on the forums for that game (see below).
If that doesn't work, you might try asking on the forums for that game (see below).
Line 87: Line 56:
And of course, you can always look for the answer in our extensive HELP systems. Just type HELP to see the directory and instructions.
And of course, you can always look for the answer in our extensive HELP systems. Just type HELP to see the directory and instructions.


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


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


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

Latest revision as of 23:21, 17 May 2023

Welcome to the official documentation wiki for the Iron Realms Nexus Client 3.0.

Core Features include:

  • Truly cross-platform.
    • The Nexus client has browser, desktop, and Android versions. (iOS is coming soon) Find them here.
    • Your character settings are saved in the cloud so they can be accessed from any device you're currently using.
    • Save all of your characters to a single Nexus account. Log in with a single click.
    • Access all IRE games from a single client.
    • Add login information for other games.
    • Edit settings while not logged in to your character.
  • Windowed output.
    • Separate windows for main output, inventory, communication, graphical map, and more!
    • Can easily grab tab to move windows around into any position or size you would like.
    • Windows auto-resize based on app size.
    • Swipe right and left to access special windows in mobile.
  • Highly customizable. You can get rid of windows or create new ones, move tabs from one window to another, resize windows, change colors, fonts, and more. Go full-screen! Turn music off but keep sound effects on!
  • 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.
  • 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 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 can be used by anyone without any coding knowledge at all.
    • Easily create powerful keybindings/macros and aliases with no prior experience.

Screenshots

  • Main Client default skin.

Important Links

Nexus 3.0 Documentation

The following links describe how to use the Nexus Client.

The Basics

Client Settings

Scripting

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, 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 Forums

Need more help? Try asking on the forums.


Game Websites

You can also explore the individual game websites.