-
Notifications
You must be signed in to change notification settings - Fork 18
03. Interface
The status bar is a customizable bar that has ten slots for displaying game information of your choosing. This can range from any variables (global or self-created) to specific text of your choosing. The status bar can be displayed at the top or bottom of your screen, or left off altogether.
Two types of information can be output to your status bar slots: variables and specific text. The syntax for outputting is #statusbar followed by the number of the slot you wish to use (between 1 and 10), and then the information to be displayed. For example, if you wanted to output the name of your current character, you could do this two ways. The first, using specific text, is:
#statusbar 2 Bob
The second, using a variable, is:
#statusbar 2 $charactername
Triggers work well to automatically send updates to your status bar when specific events occur. For example, let's say you want a status bar entry that displays the skill you are being taught. You could set up a trigger as:
Trigger
^You begin to listen to (\w+) teach the (.+) skill
Action
#statusbar 10 Listening to $1 teach $2
If the teacher, the lesson, or both change, your status bar will automatically update itself thanks to the trigger you have set up.
You can incorporate the #statusbar command into macros in a similar way, which is useful for things like displaying your stance while in combat.
Eval triggers give you a way of monitoring specific variables and updating your status bar when that a variable changes. For details on how to set up an eval trigger, check out the Triggers section.
Say you want a status bar entry that displays the number of favors that your character has. This involves two triggers: the initial trigger that captures the number of favors and saves it as a variable:
Trigger
^You have (\d+) TDPs
Action
#var tdp $1
And the eval trigger that updates the status bar every time the variable changes:
Trigger
$favor
Action
#statusbar 1 Favors: $1
More advanced use of the status bar includes things like using #math to set up counters. For example, you might keep track of how many mobs you've killed in a specific hunting session. This would involve two triggers: the first saves a variable that records a running count of the mobs you've searched:
Trigger
You search the
Action
#math crittercount add 1
And a second eval trigger that outputs this variable to your status bar every time it changes.
Trigger
$crittercount
Action
Mobs Killed: $crittercount
Windows are the different boxes of content laid out within the Genie 4 program frame that display information about the game. In most cases this is information received from the game that is then being funneled into different windows so that you can more easily locate different pieces of content.
To add a new window, go to Edit > Configuration... Under the Layout tab you will find Windows and Settings tabs. In the Windows tab, select Add and enter a name for your window in the Title field. You can select the background and text colors by using the two icons to the right of the Color box.
Some plugins will require you to create specific windows to display the new information they gather. Review the documentation for that plugin to determine what window it needs you to create.
To close a window from your interface, right click on it and select Close Window. To delete the window entirely, go to Edit > Configuration... Under the Windows tab, select the window you want to remove, and click the Remove button at the top of the list.
To reopen a default or custom window that is no longer visible, click Windows in the menu bar and then select the window from the list. This will bring that window to the top of your screen.
All windows can have their content redirected to another window if the original window is closed. To select which window the content will be sent to, go to Edit > Configuration..., into the Layouts tab and then the Windows tab. Select the window who's content you want to redirect. Select the window to redirect to in the 'Redirect if Closed' dropdown.
You can resize a window by clicking and dragging from one of the edges of the window, or by using the #windows position command (see Position section for more details). When a window nears the edge of another window, Genie 4 will automatically align your windows for convenience.
Windows positioning can be set using the #window position command.
#window position Main W H T L //Moves the genie client window
#window position Game W H T L //Moves the genie main text window
#window position ABC W H T L //Moves all other windows
"W" is the width in pixels. "H" is the height in pixels. "T" (stands for top) is the vertical coordinate of the top edge. "L" (stands for left) is the horizontal coordinate of the left edge.
To change the font of any window, go to Edit > Configuration..., into the Layouts tab, and then the Windows tab. Select the window you want to edit from the list of windows. Click the font button and select a font, style, and size that suits you. You will be able to see a sample of your choices in the sample window.
Certain windows benefit from using a fixed width font, which is a font where every letter takes up the same horizontal space. This can help align text within a window so that it's easier to read, especially for Plugins that output information in a table-like manner.
When the Time Stamp Output? box for a window is checked, Genie 4 will add a time stamp to each separate line of text. This is especially useful for speech based windows. You can also add or remove time stamp to a window by right clicking on it, and toggling it from the displayed menu.
Genie 4 gives you the ability to adjust how much extra spacing is added between various pieces of data coming into Genie from the game. There are four different settings to let you customize this.
Replace the default prompt indicator of ">" with another symbol (or symbols) of your choice.
#config {prompt} {>}
This adds a linebreak before the status prompt. Default setting is True.
#config {promptbreak} {true}
When set as true, the game looks like this:
Joe quickly locks the keepsake box and pockets the key.
>
Joe sets about picking his keepsake box. With a faint *CLICK* it opens.
>
When set as false, the game looks like this:
> Joe quickly locks the keepsake box and pockets the key.
> Joe sets about picking his keepsake box. With a faint *CLICK* it opens.
Will force the placement of a prompt AFTER each line, even when one is not received from the game. Default is False.
#config {promptforce} {false}
This removes all linebreaks that aren't received as part of the text stream. Default is False.
#config {promptbreak} {true}
When set as false, the game looks like this:
>attack
< You jab a haledroth nightstick at a giant mechanical mouse. A giant mechanical mouse dodges.
[You're winded, mighty, nimbly balanced and in superior position.]
[Roundtime 1 sec.]
R>
>attack
< You draw a haledroth nightstick at a giant mechanical mouse. A giant mechanical mouse evades.
[You're winded, mighty, nimbly balanced and in very strong position.]
[Roundtime 3 sec.]
R>
When set as true, the game looks like this:
>attack
< You jab a haledroth nightstick at a giant mechanical mouse. A giant mechanical mouse dodges.
[You're winded, mighty, nimbly balanced and in very strong position.]
[Roundtime 1 sec.]
R>
>attack
< You feint a haledroth nightstick at a giant mechanical mouse. A giant mechanical mouse fails to evade.
The nightstick lands a light hit (1/23) to the mouse's chest.
[You're winded, mighty, adeptly balanced and in dominating position.]
[Roundtime 1 sec.]
Layouts are a way of saving the settings and arrangements of your windows and bars so that you can swap between layouts easily. Genie 4 has a default layout that is loaded when it starts. You can override this layout by going to Layout > Save Default Layout. Similarly, you can load the default layout by going to Layout > Load Default Layout.
Multiple layouts can be saved and reloaded, even if they are not your default layout. This lets you have different layouts for different characters, computers, or situations, controlling what your interface looks like at specific times.
To save your current layout, go to Layout > Save Layout As. To load a saved layout, go to Layout > Load Layout. Be careful to save changes after altering your windows or layout, either in the default position or as a saved layout. If you do not, your changes will be lost when you exit Genie 4.
The placement of a number of status bars can also be controlled through the Layout menu option, including:
- Icon Bar: This bar contains the Roundtime display, exit compass, the contents of the left and right hand, and the spell prep timer. The docking options are dock top and dock bottom.
- Script Bar: This bar displays all currently active scripts and lets you pause, resume, or cancel them. The docking options are dock top or dock bottom.
- Health Bar: This bar displays you health (vitality), concentration, stamina (fatigue), and spirit. The docking options are dock top or dock bottom.
- Magic Panel: This option adds or removes the Mana Bar to your Health Bar, and adds or removes your currently prepared spell to your icon bar.
- Status Bar: This bar lets you display text or variables of your choosing. For more information, see the status bar section of this wiki. The options are to display or not display.