Difference between revisions of "MQ2WinTitle" - MMOBugs Wiki

(→‎Commands: Corrected ini entries, and added KeepOriginalTitle)
(Updated for latest single command change and ini entries)
Line 4: Line 4:
 
|usesini=Yes
 
|usesini=Yes
 
|commands=
 
|commands=
/winload
+
/wintitle
 
}}
 
}}
 
__TOC__
 
__TOC__
Line 10: Line 10:
 
==Description==
 
==Description==
  
<font class="highlight">MQ2WinTitle</font> is a plugin that will change your EQ window titlebar (caption) text, to display data of your choice.  The specific text that is displayed is configurable via INI file.  The plugin will also indicate, if you wish, if a tell was recieved in a background EQ session, by changing the titlebar to user defined text.
+
<font class="highlight">MQ2WinTitle</font> is a plugin that will change your EQ window titlebar (caption) text, to display data of your choice.  The specific text that is displayed is configurable via INI file.  The plugin will also indicate, if you wish, if a tell was received in a background EQ session, by changing the titlebar to user defined text.
  
  
 
==Commands==
 
==Commands==
  
MQ2WinTitle provides one command and several options for configuration:
+
MQ2WinTitle provides one command:
  
* <font class="highlight2">/winload</font> forces immediate reload of the MQ2WinTitle.ini entries.
+
* <font class="highlight2">/wintitle reload</font> Reload configuration from ini file
 +
* <font class="highlight2">/wintitle fixtitle [state]</font> Call function to 'fix' title based on game state
 +
* <font class="highlight2">/wintitle debug [off|on]</font> Toggle displaying debugging messages to chat, or force on/off
 +
* <font class="highlight2">/wintitle petdebug [off|on]</font> Toggle displaying pet debugging messages to chat, or force on/off
 +
* <font class="highlight2">/wintitle [help]</font> This help
  
  
 
<font class="highlight">The MQ2WinTitle.ini file:</font>
 
<font class="highlight">The MQ2WinTitle.ini file:</font>
  
There is one section, titled: <font class="highlight2">[Settings]</font>
+
There is one section: <font class="highlight2">[Settings]</font>
  
 
Entries:
 
Entries:
 
* <font class="highlight2">InGame</font> The titlebar format to use while in game (not zoning, foreground).
 
* <font class="highlight2">InGame</font> The titlebar format to use while in game (not zoning, foreground).
* <font class="highlight2">Tell</font> The titlebar format to use if you recieve a tell while EQ is in the background.
+
* <font class="highlight2">Tell</font> The titlebar format to use if you receive a tell while EQ is in the background.
 
* <font class="highlight2">Other</font> The titlebar format to use at other times (such as char select).
 
* <font class="highlight2">Other</font> The titlebar format to use at other times (such as char select).
 
* <font class="highlight2">Zoning</font> The titlebar format to use while zoning.
 
* <font class="highlight2">Zoning</font> The titlebar format to use while zoning.
 
* <font class="highlight2">ShowHotKey</font> Whether to append the hotkey as shown by WinEQ2 or InnerSpace, if used.
 
* <font class="highlight2">ShowHotKey</font> Whether to append the hotkey as shown by WinEQ2 or InnerSpace, if used.
* <font class="highlight2">KeepOriginalTitle</font> Whether to append the MQ2WinTitle entry to the original title or not.  If this is off, then any entry will overwrite the original title.
 
  
 
The ShowHotKey entry is either on or off.
 
The ShowHotKey entry is either on or off.
Line 39: Line 42:
 
==Availability==
 
==Availability==
  
This plugin comes with the MMOBugs binary and install distributions. Source code is not available.
+
This plugin comes with the MMOBugs binary and install distributions. Source code is available on the github repo.
  
 
[[Category: Needs Screenshot]]
 
[[Category: Needs Screenshot]]

Revision as of 14:16, 22 January 2023

Plugin Info
Name MQ2WinTitle
Version 1.0
Author htw
Commands /wintitle
Uses INI File Yes

Description

MQ2WinTitle is a plugin that will change your EQ window titlebar (caption) text, to display data of your choice. The specific text that is displayed is configurable via INI file. The plugin will also indicate, if you wish, if a tell was received in a background EQ session, by changing the titlebar to user defined text.


Commands

MQ2WinTitle provides one command:

  • /wintitle reload Reload configuration from ini file
  • /wintitle fixtitle [state] Call function to 'fix' title based on game state
  • /wintitle debug [off|on] Toggle displaying debugging messages to chat, or force on/off
  • /wintitle petdebug [off|on] Toggle displaying pet debugging messages to chat, or force on/off
  • /wintitle [help] This help


The MQ2WinTitle.ini file:

There is one section: [Settings]

Entries:

  • InGame The titlebar format to use while in game (not zoning, foreground).
  • Tell The titlebar format to use if you receive a tell while EQ is in the background.
  • Other The titlebar format to use at other times (such as char select).
  • Zoning The titlebar format to use while zoning.
  • ShowHotKey Whether to append the hotkey as shown by WinEQ2 or InnerSpace, if used.

The ShowHotKey entry is either on or off. All other entries are parsed as macro parameters, such as used by MQ2Hud.

If no INI exists when you load the plugin, one will be created with default values.

Availability

This plugin comes with the MMOBugs binary and install distributions. Source code is available on the github repo.