MQ2GMCheck - MMOBugs Wiki

Plugin Info
Name	MQ2GMCheck
Author	htw
Link	Wiki Link
Commands	/gmcheck
Source Available	No
Uses INI File	Yes

Description

Alerts when GM in zone, as long as they are not in "stealth"

Features

• This plugin has the ability to alert you in different ways such as sound and visual messages if a GM is detected.

Commands

• /gmcheck status Displays plugin status and options.
• /gmcheck [off|on] Toggles gm checking on/off, or force on/off.
• /gmcheck quiet [off|on] Toggles all gm alert and reminder sounds, or force on/off (resets at next zone).
• /gmcheck sound [off|on] Toggles playing the sound files for alerts, or force on/off.
• /gmcheck beep [off|on] Toggles making beeping sounds for alerts, or force on/off.
• /gmcheck popup [off|on] Toggles showing a popup msg for alerts, or force on/off.
• /gmcheck chat [off|on] Toggles showing gm alerts in the mq2 chat window, or force on/off.
• /gmcheck corpse [off|on] Toggles filtering of alerts for GM corpses, or force on/off.
• /gmcheck rem ## Change alert reminder interval, in seconds (0 to disable).
• /gmcheck save Saves current options to MQ2GMCheck.ini
• /gmcheck load Load settings from MQ2GMCheck.ini
• /gmcheck test [enter|leave|remind] Tests alerts & sounds for the indicated type.
• /gmcheck ss [enter|leave|remind] SoundFileName Set the filename (wav/mp3) to play for indicated alert. Full path if sound file is not in your MQ2 dir.
• /gmcheck help Shows command syntax and help.

Example Usage

This command will turn on GM checking.

• /gmcheck on

This command will turn stop all alert sounds (Resets upon zoning).

• /gmcheck quiet on

This command will turn on the use of sound files for alerts.

• /gmcheck sound on

This command will turn on the use of beeps for alerts.

• /gmcheck beep on

This command will turn allow the use of popups for alerts.

• /gmcheck popup on

This command will set the reminder interval to 60 seconds.

• /gmcheck rem 60

This command will disable the reminder alert.

• /gmcheck rem 0

This command will save the current configuration to MQ2GMCheck.ini file.

• /gmcheck save

Macro Data

This plugin adds a new TLO called GMCheck.

ExampleType

• ${GMCheck} : string - Return TRUE if GM in zone.
• ${GMCheck.Status} : bool - Return TRUE if GM checking is active.
• ${GMCheck.GM} : bool - Return TRUE if GM in zone.
• ${GMCheck.Names} : string - Return string with comma delimited list of names of the GMs in zone.
• ${GMCheck.Sound} : bool - Return TRUE if GMSound is on.
• ${GMCheck.Beep} : bool - Return TRUE if GMBeep is on.
• ${GMCheck.Popup} : bool - Return TRUE if GMPopup is on.
• ${GMCheck.Corpse} : bool - Return TRUE if GMCorpse is on.
• ${GMCheck.Quiet} : bool - Return TRUE if GMQuiet is on.
• ${GMCheck.Interval} : int - Return number of seconds for reminder interval.
• ${GMCheck.Enter} : string - Return GM enter sound filename.
• ${GMCheck.Leave} : string - Return GM leave sound filename.
• ${GMCheck.Remind} : string - Return GM reminder sound filename.
• ${GMCheck.LastGMName} : string - Return name of last GM alerted for.
• ${GMCheck.LastGMTime} : string - Return time last GM alerted at.
• ${GMCheck.LastGMDate} : string - Return date last GM alerted at.
• ${GMCheck.LastGMZone} : string - Return zone last GM alerted in.
• ${GMCheck.GMEnterCmd} : string - Return the GMEnterCmd option.
• ${GMCheck.GMEnterCmdIf} : string - Return the evaluated result of the GMEnterCmdIf option.
• ${GMCheck.GMLeaveCmd} : string - Return the GMLeaveCmd option.
• ${GMCheck.GMLeaveCmdIf} : string - Return the evaluated result of the GMLeaveCmdIf option.

Configuration

The MQ2GMCheck.ini file can have the following options, some of which correspond to parameters available via slash commands in game:

[Settings] section:

• GMCheck - GM checking is active by default, on plugin load.
• Sound - Play sound files for alerts.
• Beep - Beep the PC speaker for alerts (or play PC beep).
• Popup - Show popup overlays for alerts.
• Corpse - Exclude GM corpses from alerts.
• RemInt - Number of seconds for reminder interval.
• EnterSound - Alert enter sound filename.
• LeaveSound - Alert leave sound filename.
• RemindSound - Alert reminder sound filename.
• GMEnterCmd - Command to execute when 1st GM enters zone.
• GMEnterCmdIf - Optional evaluation to fine tune GMEnterCmd.
• GMLeaveCmd - Command to execute when last GM exits zone.
• GMLeaveCmdIf - Optional evaluation to fine tune GMLeaveCmd.

In addition, you can have a Section Name corresponding to a GM name, and those custom enter/leave sounds will be played for that GM instead:

[GMFirstName] section:

• EnterSound - GM enter sound filename for this GM.
• LeaveSound - GM leave sound filename for this GM.

Sample Configuration

MQ2GMCheck.ini

[Settings]
GMCheck=on
GMSound=on
GMBeep=off
GMPopup=on
GMChat=on
GMCorpse=off
RemInt=30
EnterSound=c:\mq2\sounds\gmenter.mp3
LeaveSound=C:\MQ2\Sounds\gmleave.mp3
RemindSound=C:\MQ2\Sounds\gmremind.mp3
GMEnterCmdIf=${If[${Zone.ID}==344 || ${Zone.ID}==345,1,0]}
GMEnterCmd=/multiline ; /end ; /camp desktop
GMLeaveCmdIf=${If[${Zone.ID}==344 || ${Zone.ID}==345,1,0]}
GMLeaveCmd=

[Deodan]
EnterSound=C:\MQ2\Sounds\prickishere.wav
LeaveSound=C:\MQ2\Sounds\thankgod.wav

Availability

This plugin is included with the MMOBugs Compile.