JGRotPro AddOn Protocol Specification

Reg.RootKey HKEY_CURRENT_USER
RegInterfaceKey "\Software\JGRotPro\Interface"


NOTE: All value written to the registry are string values at this time.
Key ValueName JGRotPro AddOn App Description
AppReg Clears after Read Writes "Name" When a AddOn wants to be added to the JGRotPro list of AddOns it needs to Register itself by writing its name to this key. The name is generally the same as the AddOns Window Title Bar Caption. At a minimum AddOn Registration should be done when the AddOn is first started. AddOns may also periodicaly check the AddOnRegList to make sure they are registered. If not (in the event JGRotPro is resterted) they can then re-register themselves
AppUnReg Clears after Read Writes "Name" When an AddOn is shutting down it should Unregister itself with JGRotPro by writing its name to this key.
AddOnRegList Writes "Name" of all currently Registered AddOns to this string key. Names in this list are comma delimited. Read Only This list can be used by all AddOns to verify they are registered with JGRotPro. Useful if the AddOn is started before JGRotPro or if JGRotPro was shutdown and restarted. Also used to verify AddOn registration name is not all ready registered by another AddOn or instance.
AppExe Clears after Read Writes "Name" When the Addon registers itself with JGRotPro it should write its full path and file name to this key. This is for future use to allow JGRotPro to keep a list of addons and be able to start them up when JGRotPro start(selectable)
ActiveAddon Writes "Name" Read Only When a AddOn has been selected by navigating through the JGRotPro/JGPD console menu this key will notify all of the AddOns just who was selected and who the cursor and input reg key were meant for. No other AddOn should respond to either cursor or input values. Cleared when appropriate AddOnRelease key value is received.
AddOnRelease Clears after Read Writes "Name" Whenever the Addon enters its first menu level (the upper most AddOn menu level), it MUST signal that state to JGRotPro (read: whenever showing your AddOn's main/upper most menu, set the "AddOnRelease" reg key with your app's name). When at first level and the UPLEVEL key is pressed by the user, the Addon is made inactive by JGRot.
RequestPopUp Clears after Read Writes "Name" When the Addon wants to have its data "popup" it should first write the Title and Line# data it wants displayed. Then write its NAME to the RequestPopUp key. When JGRotPro recognizes the popup request it will make the requesting addon the ActiveAddOn. At that time whatever data is in the Title and Line# keys is displayed.
Cursor Write pressed cursor keys Clears after Read Up (UpList), Down (DownList), Left (UpLevel), and Right (DownLevel) (as defined in JGRotPro keymapping) key names are sent when an AddOn is active. These are used by the AddOn to allow navigation through an AddOn generated Menus and Lists. Alternat functions are definable by using key combinations. Shift+Up (ShiftUpList), Shift+Down (ShiftDownList), Cntrl+Up (CntrlUpList), Cntrl+Down (CntrlDownList), Cntrl+Left (CntrlUpLevel), and Cntrl+Right (CntrlDownLevel). NOTE: Shift+Left and Shift+Right are reserved for scrolling text left and right. (handled by JGRotPro)
Input Write user input text string Clears after Read Text entered to the chat line is always sent to this key. If ActiveAddOn is empty then any AddOn may respond to the data. If there is a specific AddOn named in the ActiveAddOn then only that AddOn should be allowed to respond.
DataReady Clears after Read Writes registered NAME when Data is Ready When an AddOn has ListHighLight, Title, and/or Line text written to the registry and ready for JGRotPro to read it must write its NAME to this key
ListHighLight Read Only Writes a value 1-15 The value written to this key by the AddOn is a line index that JGRotPro uses to determine which 1 of the 15 text lines will be highlighted. This is generally used as the scroll indication while navigating through menus.
Title Read Only Writes title text string This is the top line of text shown on the JGRotPro/JGPD console. This line is not HighLightable.
Line1 Read Only Writes text string for line 1 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line2 Read Only Writes text string for line 2 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line3 Read Only Writes text string for line 3 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line4 Read Only Writes text string for line 4 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line5 Read Only Writes text string for line 5 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line6 Read Only Writes text string for line 6 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line7 Read Only Writes text string for line 7 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line8 Read Only Writes text string for line 8 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line9 Read Only Writes text string for line 9 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line10 Read Only Writes text string for line 10 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line11 Read Only Writes text string for line 11 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line12 Read Only Writes text string for line 12 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line13 Read Only Writes text string for line 13 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line14 Read Only Writes text string for line 14 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable
Line15 Read Only Writes text string for line 15 This is a line of text that will be shown on corresponding the JGRotPro/JGPD console text line. This line is HighLightable

Last Updated on 7/11/2003
By Mogar