Wrayth: Difference between revisions

The official GemStone IV encyclopedia.
Jump to navigation Jump to search
No edit summary
m (Updating Unofficial Plugins section to remove content deleted on a secondary article to instead link directly to catch-all third party article.)
 
(21 intermediate revisions by 9 users not shown)
Line 1: Line 1:
'''StormFront''' is an official front end (FE) for [[GemStone IV]] and [[DragonRealms]], and works with the Windows operating system. Compared with the [[Wizard (front end)|Wizard FE]], StormFront provides more features, including a point-and-click interface, dialog boxes, and a more advanced scripting engine.
'''Wrayth''' is an official front end (FE) for [[GemStone IV]] and [[DragonRealms]], and works with the Windows operating system. Compared with the [[Wizard (front end)|Wizard FE]], Wrayth provides more features, including a point-and-click interface, dialog boxes, and a more advanced scripting engine.


Download: https://www.play.net/gs4/play/stormfront-info.asp
Download: https://www.play.net/gs4/play/wrayth-info.asp


FAQ: https://www.play.net/gs4/play/sf/faq.asp
FAQ: https://www.play.net/gs4/play/wrayth/faq.asp


Scripting Guide: https://www.play.net/dr/play/stormfront_scripting.asp
Scripting Guide: https://www.play.net/gs4/play/wrayth_scripting.asp


== Settings ==
== Settings ==


StormFront stores settings (such as highlights and scripts) separately for each character, either on the server or locally. This can be toggled inside StormFront under Options > Settings > Location.
Wrayth stores settings (such as highlights and scripts) separately for each character, either on the server or locally. This can be toggled inside Wrayth under Options > Settings > Location.


Local settings are stored as XML files in C:\Users\<Name>\AppData\Roaming\StormFront ('''not''' the folder in which StormFront is installed).
Local settings are stored as XML files in C:\Users\<Name>\AppData\Roaming\Wrayth ('''not''' the folder in which Wrayth is installed). Older installs may installed in C:\Users\<Name>\AppData\Roaming\StormFront


== Visual Skins ==
== Visual Skins ==
There are currently three user interface skins available for the StormFront FE:
Below are the available user interface skins for Wrayth FE:

*Original "Storm" Skin - Installed by default
*Original "Storm" Skin - Installed by default
*StealthFront Skin - Available via play.net [http://www.play.net/software/sfskins/stealth.skn Here]
*StealthFront Skin - Available via play.net [https://www.play.net/software/sfskins/stealth.skn Here]
{|
*NishiFront Skin - Available via third party website [http://www.rohku.com/nishifront/nishifront21.zip Here]
|- valign="top"
|[[File:Stealthnormal.png|250px|Image: 250 pixels]]
|}
*StealthFront Blue - Available via third party website [https://github.com/mrhoribu/wraythskins/raw/main/stealthblue.skn Here]
{|
|- valign="top"
|[[File:Skinblue.png|250px|Image: 250 pixels]]
|}
*NishiFront Skin - Available via third party website [https://github.com/mrhoribu/wraythskins/raw/main/NishiFront21.skn Here]
{|
|- valign="top"
|[[File:Nishi.png|250px|Image: 250 pixels]]
|}
*Brute Skin - a minimalistic light toned skin (recommended to be used with microbar.lic). Available via third party website [https://github.com/BruteGS/BruteSkin/raw/main/Brute.skn Here]
{|
|- valign="top"
|[[File:BruteSkin.png|250px|Image: 250 pixels]]
|}


The Original and StealFront skins were developed by Simutronics and they are both officially supported. NishiFront was developed by a player and it is not officially supported.
The Original and StealthFront skins were developed by Simutronics and they are both officially supported. StealthFront Blue is a variant of StealthFront with updated icons and colors developed by GM Auchand. NishiFront and BruteSkin were developed by players and are not officially supported.


To use a downloaded skin: Save the files to your StormFront directory (usually located in C:\Program Files (x86)\Simu\StormFront). You can switch your skin by going to Options > Choose Skin in StormFront.
To use a downloaded skin: Save the files to your Wrayth directory (usually located in C:\Program Files (x86)\Simu\Wrayth). You can switch your skin by going to Options > Choose Skin in Wrayth.


Wrayth skins were made with ActiveSkin (no longer in development). You can download a copy of the program from play.net [http://www.play.net/software/3rdparty/activeskin.zip here]


== Macros ==
== Macros ==
Line 32: Line 52:
:\r - Send the command.
:\r - Send the command.
:\p - pause 1 second before continuing.
:\p - pause 1 second before continuing.
:\x - Delete the contents of the command line before continuing.
:\x - Delete the contents of the command line before continuing. Must be at the beginning of the macro line.
:@ - Place the insertion marker here.
:@ - Place the insertion marker here. (example: get @ from my backpack)
:\? - Replace this with the contents of the command line before starting.
:\? - Replace this with the contents of the command line before starting.
:%variable name% - Allows you to insert a variable's value into the macro's output. (example: draw %weapon%\r)
:{pageUp} - scrolls window up one page
:{pageDown} - scrolls window down one page
:{lineUp} - scrolls window up one line
:{lineDown} - scrolls window down one line
:{historyPrev} - show the previous command you typed
:{historyNext} - show the next command you typed
:{repeatLast} - repeats the last command you typed
:{cycleWindows} - jump to the next window
:{cycleWindowsReverse} - jump to the previous window
:{bufferBottom} - Move to bottom of buffer.
:{bufferTop} - Move to top of buffer.
:{move} - Evaluates to "sneak " if you are hidden and auto sneak is activated.
:{=scriptname} - run script 'scriptname'
:{script} - opens the script dialog
:{panels} - toggles visibility of the panel bar
:{variables} - opens the variables dialog
:{macros} - opens the macros dialog
:{wounds} / {injuries} - both of these toggle the "see injuries"/"see scars" on the health panel.


== Unofficial Plugins ==
== Rest Mode ==


The keyboard command CTRL-R will put you into rest mode (which sends the EXP command every few minutes to prevent an idle timeout).
[[Lich (software)]] includes scripts that create new informational windows in StormFront, such as [[Script UberPlugins|Uberbar and Uberspells]].


== Backup ==
{|

|- valign="top"
Backup Wrayth Settings and Scripts Once A Month
|[[File:Uberbar.png|frame|none|Uberbar]]

|[[File:Uberspells.png|frame|none|Uberspells]]
All your macros, scripts, highlights, windows layout and more are held in settings for your Wrayth. You'd hate to lose this all to some accident, right? Even if you do not save your settings on the server, it's better to be safe than sorry, and plan to back them all up once a month.
|}

# In Wrayth go to your upper right corner and click on Options. Choose Settings, then select Export.
# Everything will be checked to export by default. Go ahead, leave it all checked for a complete backup.
# The default file name and directory is C:\Wrayth.xml Personally I don't rewrite old backups like this. I include the date in the file and my character name, and I save it in DropBox, not hanging on the root of my hard drive. Google Drive is another great place to save it, or once you have it saved, email it to yourself. Bottom line: Save it somewhere that you can get to in the case of a computer crash.
# Remember to do this export process for each character, because they have their own settings.

== Unofficial Plugins ==

See [[Lich:Software]].


== Other FEs ==
== Other FEs ==
*[[Wizard (front end)]] - official Windows front end
*[[Wizard (front end)]] - official Windows front end
*[[Avalon]] - official Mac OS X front end
*[[Avalon]] - official Mac OS X front end
*[[Lich (software)]] - unofficial scripting addon, works with any of StormFront/Wizard/Avalon.
*[[Lich:Software]] - unofficial scripting addon, works with any of Wrayth/Wizard/Avalon.


[[Category:Front Ends]]
[[Category:Front Ends]]

Latest revision as of 12:14, 6 June 2023

Wrayth is an official front end (FE) for GemStone IV and DragonRealms, and works with the Windows operating system. Compared with the Wizard FE, Wrayth provides more features, including a point-and-click interface, dialog boxes, and a more advanced scripting engine.

Download: https://www.play.net/gs4/play/wrayth-info.asp

FAQ: https://www.play.net/gs4/play/wrayth/faq.asp

Scripting Guide: https://www.play.net/gs4/play/wrayth_scripting.asp

Settings

Wrayth stores settings (such as highlights and scripts) separately for each character, either on the server or locally. This can be toggled inside Wrayth under Options > Settings > Location.

Local settings are stored as XML files in C:\Users\<Name>\AppData\Roaming\Wrayth (not the folder in which Wrayth is installed). Older installs may installed in C:\Users\<Name>\AppData\Roaming\StormFront

Visual Skins

Below are the available user interface skins for Wrayth FE:

  • Original "Storm" Skin - Installed by default
  • StealthFront Skin - Available via play.net Here
Image: 250 pixels
  • StealthFront Blue - Available via third party website Here
Image: 250 pixels
  • NishiFront Skin - Available via third party website Here
Image: 250 pixels
  • Brute Skin - a minimalistic light toned skin (recommended to be used with microbar.lic). Available via third party website Here
Image: 250 pixels

The Original and StealthFront skins were developed by Simutronics and they are both officially supported. StealthFront Blue is a variant of StealthFront with updated icons and colors developed by GM Auchand. NishiFront and BruteSkin were developed by players and are not officially supported.

To use a downloaded skin: Save the files to your Wrayth directory (usually located in C:\Program Files (x86)\Simu\Wrayth). You can switch your skin by going to Options > Choose Skin in Wrayth.

Wrayth skins were made with ActiveSkin (no longer in development). You can download a copy of the program from play.net here

Macros

Macros allow the user to execute a sequence of commands with a single keypress.

Special keywords that can be used in macros include:

\r - Send the command.
\p - pause 1 second before continuing.
\x - Delete the contents of the command line before continuing. Must be at the beginning of the macro line.
@ - Place the insertion marker here. (example: get @ from my backpack)
\? - Replace this with the contents of the command line before starting.
%variable name% - Allows you to insert a variable's value into the macro's output. (example: draw %weapon%\r)
{pageUp} - scrolls window up one page
{pageDown} - scrolls window down one page
{lineUp} - scrolls window up one line
{lineDown} - scrolls window down one line
{historyPrev} - show the previous command you typed
{historyNext} - show the next command you typed
{repeatLast} - repeats the last command you typed
{cycleWindows} - jump to the next window
{cycleWindowsReverse} - jump to the previous window
{bufferBottom} - Move to bottom of buffer.
{bufferTop} - Move to top of buffer.
{move} - Evaluates to "sneak " if you are hidden and auto sneak is activated.
{=scriptname} - run script 'scriptname'
{script} - opens the script dialog
{panels} - toggles visibility of the panel bar
{variables} - opens the variables dialog
{macros} - opens the macros dialog
{wounds} / {injuries} - both of these toggle the "see injuries"/"see scars" on the health panel.

Rest Mode

The keyboard command CTRL-R will put you into rest mode (which sends the EXP command every few minutes to prevent an idle timeout).

Backup

Backup Wrayth Settings and Scripts Once A Month

All your macros, scripts, highlights, windows layout and more are held in settings for your Wrayth. You'd hate to lose this all to some accident, right? Even if you do not save your settings on the server, it's better to be safe than sorry, and plan to back them all up once a month.

  1. In Wrayth go to your upper right corner and click on Options. Choose Settings, then select Export.
  2. Everything will be checked to export by default. Go ahead, leave it all checked for a complete backup.
  3. The default file name and directory is C:\Wrayth.xml Personally I don't rewrite old backups like this. I include the date in the file and my character name, and I save it in DropBox, not hanging on the root of my hard drive. Google Drive is another great place to save it, or once you have it saved, email it to yourself. Bottom line: Save it somewhere that you can get to in the case of a computer crash.
  4. Remember to do this export process for each character, because they have their own settings.

Unofficial Plugins

See Lich:Software.

Other FEs