Plugin Info | |
---|---|
Name | MQ2ClickMaint |
Author | Thez |
Link | Forum Link |
Commands | /citem, /doclicks, /cmaint |
Source Available | Yes |
Uses INI File | Yes |
Contents
Description
I just want to start this off with a huge "Thank You" to Sadge, Hawthorne, Jobey, and most especially Nightmare327 for helping with the testing of this plugin. Without their help, this would never have gotten done.
MQ2ClickMaint is a plugin intended to replace the casting part of maintaining clickies. By tracking the wear-off messages paired with the item to recast a buff, it stores which of your items need to be recast. To monitor this, the ${CMaint} TLO is a boolean that returns true if you have buffs needing to be done, and false if not. I repeat, this plugin does *NOT* automatically maintain buffs. In my opinion, coding that into a plugin to cover every situation would be impossible. As such, the intent is that you can use a macro and the ${CMaint} TLO to activate the command when you want to, or activate it on your own to take the place of a "myclicks.mac" type macro that just refreshes your buffs.
The plugin uses an INI which stores wear-off messages with the associated items to recast when the messages are found.
Commands
/doclicks
/doclicks -> immediately cast every item waiting to be cast. Will not work if you are invis.
/doclicks rez -> if you have been rezzed and want an instant-clicky to be in your first slot, this is the command for you. Enter it right after you have been rezzed to cast every item but myItem0. Once the RezEffect slot is gone, simply "/doclicks" to cast the remaining buff and have it land in your first slot!
/doclicks all -> Cast all items, regardless of which items need to be done. This is also useful for casting items that have no wear-off message. The most effective use is to put a shrink rod in the INI with no wear-off message, then add it to your personal list twice. This will cause the wand never to cast itself except when you do /doclicks all.
/citem -This command is intended to let you add items to your INI for casting from ingame. It works in this order:
-On entering this command to start adding an item, you will see this text: "Now entering 'add' sequence. The next 10 lines of chat will be saved and echoed back to you as they come."
-Once you have done this, the plugin will echo the next 10 lines of chat that it sees, with numbers in front of them. To pick the one that corresponds with the correct wear-off msg for your item, first place the item you wish to cast for that buff on your cursor, then:
-"/citem #", where # is replaced with the correct number from the list.
-If the correct message is not found (adding an item in PoK might be difficult, for example), then:
-"/citem no", which will start the plugin over on reading the next 10 messages.
/cmaint
/cmaint -> displays this list
/cmaint help ->Displays this list, and explains how to use the commands.
/cmaint list -> Lists all items defined in INI
/cmaint me -> Lists all of the items plugin is tracking for your character.
/cmaint add #|FileItem# -> Add Item<#> from INI to your character's list. Ex: 'add FileItem5' or 'add 5'
/cmaint remove #|FileItem# -> Remove Item<#> from your character's list. Ex: 'remove FileItem0' or 'remove 0'
/cmaint reload -> Reload items in the INI without having to reload the plugin.
Example Usage
sub main
:loop
/if (${CMaint}) /call DoClicks
/delay 1s
/goto :loop
/return
Sub DoClicks
|Put all of the checks Right here to Return without doing the clickies
/if (${Me.Invis}) /return
/if (${Me.Moving}) /return
/if (${Me.FeignDeath}) /return
/if (${Me.Casting}) /return
|OK, all of the criteria passed, lets do the clickies
/doclicks
/return
Macro Data
This plugin adds a new TLO called CMaint.
ExampleType
- ${CMaint} : bool - Return TRUE if you have items waiting to be cast
Configuration
Global settings for the plugin, such as clickie entries, debug, etc. are kept in MQ2ClickMaint.ini, in the [Settings] section. Individual character configuration for which clickies are on or off for that character are kept in their server_char.ini under the [MQ2ClickMaint] section (for example, povar_bubba.ini for a character named bubba on the povar server).
Global [Settings] Options:
- Debug - on or off, to show some extra debug help for helping you see if a config is working, and if not, then why
- MaxIndex - The maximum number for a FileItem that will be looked for in the config
- IntDelay - The pulse delay between processing clickies (from 50 to 1000)
Global [FileItemX] Options:
- ItemName - The name of the item
- BuffOffMsg - The message shown in game when the clickie effect wears off
Server_Char.ini [MQ2ClickMaint] Options:
- X - on or off, to turn on or off that particular clickie for FileItemX in the Global Configuration file (e.g., 5=on will turn on the item for FileItem5)
Sample Global Configuration
MQ2ClickMaint.ini
[Settings] Debug=off MaxIndex=300 IntDelay=50 [FileItem0] ItemName = The Skull of Den Lord Rakban BuffOffMsg = The black runes drift away. [FileItem1] ItemName = Ancient Werewolf Skull BuffOffMsg = The black runes drift away. [FileItem2] ItemName = Ring of the Beast BuffOffMsg = Your endurance fades. [FileItem3] ItemName = Dark Void Shoulders BuffOffMsg = Your protection fades. [FileItem4] ItemName = Shawl of Eternal Forces BuffOffMsg = Your thoughts become less methodical. [FileItem5] ItemName = Celestial Cloak BuffOffMsg = The heightened focus ends. [FileItem6] ItemName = Prismatic Ring of Resistance BuffOffMsg = Your ward fades. [FileItem7] ItemName = Spiked Bracelet of the Betrayer BuffOffMsg = Your endurance fades. [FileItem8] ItemName = Ornate Mask of Fallen Dreams BuffOffMsg = The illusionary spikes fade away. [FileItem9] ItemName = Ring of Resistance BuffOffMsg = Your soul energy fades. [FileItem10] ItemName = Silver Hoop of Speed BuffOffMsg = Your primal guard fades. [FileItem11] ItemName = Serrated Dart of Energy BuffOffMsg = The savage spirits depart. [FileItem12] ItemName = Resonant Diazophire Earring BuffOffMsg = The savage spirits depart. [FileItem13] ItemName = Bloodthirsty Granite Ring BuffOffMsg = The savage spirits depart. [FileItem14] ItemName = Mask of Lament BuffOffMsg = The hateful spirits depart. [FileItem15] ItemName = Band of Subterfuge BuffOffMsg = The Taelosian guard fades. [FileItem16] ItemName = Crystallized Serpent Eye BuffOffMsg = The brambles fall away. [FileItem17] ItemName = Silver Skin Gauntlets BuffOffMsg = The silvery hue fades. [FileItem18] ItemName = Fractured Werewolf Jawbone BuffOffMsg = The red runes drift away. [FileItem19] ItemName = Wand of Imperceptibility BuffOffMsg = [FileItem20] ItemName = Chaos-Imbued Leather Leggings BuffOffMsg = The heightened focus ends. [FileItem21] ItemName = Symbol of the Planemasters BuffOffMsg = The gleam fades from your weapons. [FileItem22] ItemName = Emlyxi's Corundus Band BuffOffMsg = Your stony skin fades. [FileItem23] ItemName = Lizardscale Plated Girdle BuffOffMsg = Your speed returns to normal. [FileItem24] ItemName = Totem of Elitist Rites BuffOffMsg = The rage subsides. [FileItem25] ItemName = Chaos-Imbued Leather Leggings BuffOffMsg = The heightened focus ends. [FileItem26] ItemName = Astral Ring of Starshine BuffOffMsg = Your stony skin fades. [FileItem27] ItemName = Death Prophet's Earring BuffOffMsg = The savage spirits depart. [FileItem28] ItemName = Torque of the Wyrmlord BuffOffMsg = The Invigoration of Rytan fades. [FileItem29] ItemName = Battleskirt of the Acolyte BuffOffMsg = Your thoughts lose their speed. [FileItem30] ItemName = BoneHook BuffOffMsg = Your thoughts become less methodical. [FileItem31] ItemName = Vitrik Claw Belt BuffOffMsg = Your thoughts lose their speed. [FileItem32] ItemName = BaneBand BuffOffMsg = Your thoughts become less methodical. [FileItem33] ItemName = Familiar of the Emerald Jungle BuffOffMsg = Your emerald sokokar departs. [FileItem34] ItemName = Hanvar's Hoop BuffOffMsg = Your stony skin fades. [FileItem35] ItemName = Crown of Deceit BuffOffMsg = Your illusion fades. [FileItem36] ItemName = Shadehorn Mask BuffOffMsg = Your endurance fades. [FileItem37] ItemName = Glyphed Mask of Renewal BuffOffMsg = Your endurance fades. [FileItem38] ItemName = Cowl of Mercy BuffOffMsg = Your endurance fades. [FileItem39] ItemName = Spelunker's Belt of Many Pouches BuffOffMsg = Your thoughts lose their speed. [FileItem40] ItemName = Visage of Bragnar Noox BuffOffMsg = Your illusion fades. [FileItem41] ItemName = Endunr's Bottled Gold BuffOffMsg = Your endurance fades. [FileItem42] ItemName = Nra`Vruu's Earring BuffOffMsg = Your histories fade from your thoughts. [FileItem43] ItemName = Hammered Gear Casing BuffOffMsg = Your stony skin fades. [FileItem44] ItemName = Flattened Ring Gear BuffOffMsg = Your endurance fades. [FileItem45] ItemName = Kranigan's Control Ring BuffOffMsg = Your histories fade from your thoughts. [FileItem46] ItemName = Mantle of Mesh BuffOffMsg = The soothing breath leaves you. [FileItem47] ItemName = Visage of the war pirate BuffOffMsg = Your illusion fades. [FileItem48] ItemName = Romix Ringlet BuffOffMsg = Your strength returns to normal. [FileItem49] ItemName = Visage of the dark arachnids BuffOffMsg = Your illusion fades. [FileItem50] ItemName = Fabled Ball of Golem Clay BuffOffMsg = Your illusion fades. [FileItem51] ItemName = Form of the Recluse BuffOffMsg = Your illusion fades. [FileItem52] ItemName = Earring of Guardian Romix BuffOffMsg = Your histories fade from your thoughts. [FileItem53] ItemName = Clockwork Torso BuffOffMsg = Your thoughts lose momentum. [FileItem54] ItemName = Gnoll Hierophant Signet BuffOffMsg = The histories fade from your thoughts. [FileItem55] ItemName = Flamepaw's Signet BuffOffMsg = The histories fade from your thoughts. [FileItem56] ItemName = Elaborate Bone Band BuffOffMsg = Your strength returns to normal. [FileItem57] ItemName = Aurantic hivebauble BuffOffMsg = The histories fade from your thoughts. [FileItem58] ItemName = Gnoll Guardian Earring BuffOffMsg = The histories fade from your thoughts. [FileItem59] ItemName = Sporali Hide Pauldrons BuffOffMsg = Your stony skin fades. [FileItem60] ItemName = Thelga's Earguard BuffOffMsg = The histories fade from your thoughts. [FileItem61] ItemName = Underquarry Engineer's Ring BuffOffMsg = The histories fade from your thoughts. [FileItem62] ItemName = Torrid Ring BuffOffMsg = Your strength returns to normal. [FileItem63] ItemName = Crystalkin Mantle BuffOffMsg = Your stony skin fades. [FileItem64] ItemName = Earring of the Stalwart BuffOffMsg = The histories fade from your thoughts. [FileItem65] ItemName = Fungusweave Cloak BuffOffMsg = The illusionary spikes fade away. [FileItem66] ItemName = Vine-Covered Spaulders BuffOffMsg = Your stony skin fades. [FileItem67] ItemName = Burynai Scoutpick BuffOffMsg = Your endurance fades.
Sample Character Configuration
server_character.ini
[MQ2ClickMaint] 0=on 1=on 2=off 3=off 4=on
Availability
This plugin is included with the MMOBugs Compile.