Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
htwmmo committed Jan 21, 2024
1 parent 3666c14 commit f6c8533
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Expand Up @@ -28,6 +28,7 @@ MQ2GMCheck provides one command with several options:
<span style="color: blue;">/gmcheck popup [off|on]</span> : <span style="color: green;">Toggles showing a popup msg for alerts, or force on/off.</span>
<span style="color: blue;">/gmcheck chat [off|on]</span> : <span style="color: green;">Toggles showing gm alerts in the mq2 chat window, or force on/off.</span>
<span style="color: blue;">/gmcheck corpse [off|on]</span> : <span style="color: green;">Toggles filtering of alerts for GM corpses, or force on/off.</span>
<span style="color: blue;">/gmcheck exclude [off|on]</span> : <span style="color: green;">Toggles GM alerts being excluded for zones defined in ExcludeZoneList.</span>
<span style="color: blue;">/gmcheck rem ##</span> : <span style="color: green;">Change alert reminder interval, in seconds (0 to disable).</span>
<span style="color: blue;">/gmcheck load</span> : <span style="color: green;">Load settings from MQ2GMCheck.ini</span>
<span style="color: blue;">/gmcheck test [enter|leave|remind]</span> : <span style="color: green;">Tests alerts & sounds for the indicated type.</span>
Expand Down Expand Up @@ -56,6 +57,7 @@ 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.
ExcludeZoneList - Pipe (|) separated list of zone short names to exclude from GM checks/alerts

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:

Expand All @@ -75,6 +77,7 @@ GMBeep=off
GMPopup=on
GMChat=on
GMCorpse=off
ExcludeZones=on
RemInt=30
EnterSound=c:\mq\resources\sounds\gmenter.mp3
LeaveSound=c:\mq\resources\sounds\gmleave.mp3
Expand All @@ -83,6 +86,7 @@ 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=
ExcludeZoneList=nexus|poknowledge

[Deodan]
EnterSound=c:\mq\resources\sounds\prickishere.wav
Expand All @@ -97,3 +101,8 @@ Finally, your INI stores a history of GM names you've encountered in your travel

* **htw** - *Initial work*
* **ChatWithThisName** - *Refactor and merge two versions features together*
* **Knightly** - *Refactor and cleanup*
* **htw** - *Added imgui options*
* **htw** - *Fixed corpse logic*
* **htw** - *Added zone exclusion option*
*

0 comments on commit f6c8533

Please sign in to comment.