View source for MacroQuest

EZServer is a boxing server. People on this server play 6 / 12 or more characters. In order to do this efficiently, and without completely losing your mind, you have to use a character management system.<br>
Enter MacroQuest.<br><br>
MacroQuest, along with EQBCServer, allows you to use one character to remotely control all of your other characters. It also allows you to do a few tricks that would not be possible without it. While in general MQ2 is allowed, some specific macro plugins are not. The simple rule of thumb is a direct quote from Hateborne:

''"If you set it up where the casters continually assist, on their own, which frees you up to make a sandwich, mow the yard, or otherwise step away....THIS IS *NOT* OK! I am ok with a puppetmaster approach where a tank can, like a puppetmaster, pull strings to perform a basic action. The puppetmaster does not have the ability to pull one string to make a puppet dance, shake, follow, and perform autonomously...neither shall you."''

Along those same lines using mq2twist is fine for bard songs and epic click, but IS NOT to be used by other classes to eternally cast heals, debuffs, item clicks, etc.. 

== Installing MacroQuest ==
1. Download [http://mqemulator.net/downloads.php Macroquest]. Select "ROF2" Legacy for the client, and "EZServer or Classic" for the build, then click download<br>
2. Extract the files to a new folder under your EverQuest directory (or any location you can remember)<br>
3. Copy the files from the Macroquest/UI folder into your Everquest/UIFiles/Default folder - failure to do this may cause mq2 errors when in game<br>
4. Run "MacroQuest2.exe" and "EQBCServer.exe" before launching client<br><br>

Both programs should automatically detect EverQuest when launched, so there is no additional setup required.

Additional plugins can be started using "/plugin Name" or by adding them to the .ini file directly. and using "/plugin Name unload" or edit the .ini to remove.<br>
Some of the more useful ones that are included in the RoF2 EzServer Classic download:

     [http://www.macroquest2.com/wiki/index.php/MQ2ItemDisplay MQ2ItemDisplay] Cleans up the item information window.
     [http://www.macroquest2.com/wiki/index.php/MQ2Map MQ2Map] Allows you to hide, show and/or highlist items on the map.
     [http://www.macroquest2.com/wiki/index.php/MQ2MoveUtils MQ2MoveUtils] Provides the /stick command and /moveto id.
     [http://www.macroquest2.com/wiki/index.php/MQ2NetBots MQ2NetBots] Provides useful information about the other characters connected to EQBC.
     [http://www.macroquest2.com/wiki/index.php/MQ2Targets MQ2Targets] Allows you to setup notification on spawns.  Much needed starting with Tier 5 (Abyss)
     [http://www.macroquest2.com/wiki/index.php/MQ2AutoLogin MQ2AutoLogin] Automatically logs in your army of characters.
     [https://www.mmobugs.com/wiki/index.php/MQ2AutoGroup MQ2AutoGroup] Automatically accept group/raid invites.

== Uses for MacroQuest ==

MacroQuest creates items called TLO (Top level objects), these are variables, or just information about things.<br>
These are accessed with ${ }. A great use of them is to check on something really quick.<br>
/echo ${Me.Level} - Will print your level in the macroquest window.<br><br>
These are useful to see what is going on with your characters at a glance. Some useful ones are <br>
${Target.CleanName} shows your targets clean name.<br>
${Zone.Name} shows what zone you are in.<br>
${Me.Combat} shows if attack is on.<br>

All items that you can interact with in everquest has a ID number. You can access this from macroquest with the ID part of most TLOs.<br>
${Me.ID} will get you your ID<br>
${Target.ID} will give your target's ID<br>
${Me.Pet.ID} will give your pet's ID<br><br>

'''Auto Login''' <br>
To automatically log you into the world. Detailed guide can be found in [http://wiki.ezserver.online/MQ2_Autologin_Setup here]<br>
Autologin with Profiles set up found [[Autologin_Setup with Profiles|Here]]<br><br>
'''CFG Files'''<br>
CFG files are files which contain commands to be run at certain times. The file must contain commands the same as you would use them normally.<br>
Each command will be executed in order, however there are NO macro blocks, events, etc, in a CFG file.<br>Click [[CFG Files|Here]] for more info<br><br>
'''Dynamic Map'''<br>
MacroQuest populates your map with the location of all NPCs in real time. - you can right click the NPC on the map to target it<br><br>
'''Map Commands'''
* "/mapshow NPC" - shows ALL NPC's on map
* "/maphide skele" - hides all NPC's on map with "skele" in their name
* "/highlight NPC" - highlights the color of all NPC's in zone
* "/highlight color # # #" - changes the color MQ2 uses to highlight mobs. the 3 numbers will create a color based off of RGB color codes. Some examples are "/highlight color 255 255 255" for white, "/highlight color 0 0 0" for black<br><br>
'''Target'''<br>
"/target NPC" - Targets any NPC in zone<br>
Example: "/target skeleton" - targets the nearest NPC with "skeleton" in its name<br>
"/target ${ME.pet}" - Targets the players pet<br>
"/tar id 123" or "/tar id ${Target.ID}" useful for when you have 12 orcs, this allows you to specify which orc.<br>
"/bca //tar id ${Target.ID}" will send a command to all other characters you have logged in, telling them to target your specific target.<br>
"/rsay the corpse is id: ${Target.ID}" is useful so that you can go to another character and  type "/tar id #" and then "/loot" and you will target the correct corpse in the pile and loot it.<br><br>
'''Radius'''<br>
Checking the radius is always a good idea.  This will prevent you from telling a character that is too far away to do an action.<br>
Lets say you wish your group to attack the target.<br>
/noparse /bca //if (${SpawnCount[pc radius 100 warriorsname]}>0) /attack on<br>
This would tell everyone BUT the one issuing the command to turn attack on IF warriorname is within 100 units of them.<br><br>
'''Stick'''<br>
* This is a MUCH better version of /follow from EQLive.
* add ''"uw"'' after stick to make characters look down when sticking, this helps with water following or levitation (e.g. "/stick uw")
* add a number after stick to specify the distance to follow (e.g. "/stick 1" -or- "/stick 20")
* add ''"behind"'' to stay behind an NPC (useful for rogues, or to avoid rampage damage) (e.g. "/stick behind")
* add ''"moveback"'' to stay at the set range from an NPC (useful to avoid being so close you can't attack) (e.g. "/stick 20 moveback")
* Any of the above commands can be combined (e.g. "/stick 15 behind uw")<br>
'''[http://www.macroquest2.com/wiki/index.php/MQ2MoveUtils Moveto]'''<br>
If your target is not going to be moving, another command to use is <br>
* /moveto id
You can target another character of yours and /moveto id and you will run up to them and stop.
You can target a corpse in a pile with /tar id #, then use /moveto id and you will run up to the corpse.
The default distance is set to 20, but you can change this with
* /moveto 5
and that will move you to within 5 of the target.<br><br>
'''Sending Commands - EQBC'''
* '''/bcaa //command''' - Sends a command to all of your characters, INCLUDING the one you are currently on<br>
** Example: "/bcaa //stick 10" - make ALL of your characters stick to what they are targetting at a distance of 10<br>
* '''/bca //command''' - Sends a command to all of your characters, EXCEPT the one you are currently on<br>
** Example: "/bca //stick 10" - make all of your OTHER characters stick to what they are targetting at a distance of 10<br>
* '''/bct name //command''' - Sends a command to a specified character
** Example: "/bct Darpey //stick 10" - makes Darpey stick to what he is targetting, at a distance of 10<br><br>
'''Channels in EQBC'''

* All people with pets should have pet channel
* All people with whom you wish to punch with should be in a DPS channel
* All tanks should be in a tank channel
* All casters in caster channel
* All healers in a heal channel

<b>Examples</b><br>
/bccmd channels tank<br>
/bccmd channels dps pet<br>
/bccmd channels caster pet dps<br>
/bccmd channels tank heal<br><br>

So, a [[Beastlord]] would be in all 3 channels since he both casts, has a pet, and does dps 
[[Cleric]]s [[Paladin]]s and [[Shaman]] are in /bccmd channels tank heal because I want them to attack from the beginning and for the occasional heal. 
If you log out your boxes using camp, they will retain the channels you put them in.<br><br>
[[File:Itemnotify Values.jpg|Right|frame|x450px|]]
<b>Nuke:</b><br>
Now casters are in their own group because I have "/bct casters //keypress 7"<br><br>

<b>Heal:</b><br>
"/bct heal //keypress 5"<br><br>

Cleric could be be '/cast "Word of Vivication"'<br><br>

For everyone else they all have a heal spell [http://ezserver.online/forums/index.php?topic=3803.0 MQ2 Macros Forum Post]<br><br>

'''Item Notify:'''<br>
* Clicks a specified item<br>
* Example: "/itemnotify [[Slot Names|slotname]] rightmouseup" - right clicks the item in the specified slot<br>
* Example: "/itemnotify "Noobie Item v1" rightmouseup" - right clicks the named item (must be exact)<br><br>


'''Use Item:'''<br>
* Clicks a specified item<br>
* Example: "/useitem [[Slot Names|slotname]] (bagslot#(0-9) RoF2 only)" - right clicks the specified item<br><br>

'''Door/Portal:'''<br>
* "/doortarget"  - Targets nearest door/portal <br>
* "/click left door"   - left click door/portal if within range 20 <br>
<br>

'''Twist'''<br>
* Allows your [[bard]] to continuously sing multiple songs<br>
* Example: "/bct Bardname //twist 1, 2, 4" - Makes [[bard]] sing songs 1, 2 and 4 on his spell gems.<br>
* Use "/twist off" to stop singing<br>
* Also can twisting their epic clicky. 
:: 1. If using the Newever version of MacroQuest
::    Edit server_char.ini your MQ2 folder "''EZ (Linux) x4 Exp_[bardname].ini''" and set with following.<br>
:::[MQ2Twist] <br>
:::Delay=33 <br>
:::Quiet=0 <br>
:::Adjust=1 <br>
:::Recast=0 <br>
:::21_CastTime=-1 <br>
:::21_ReCastTime=33 <br>
:::21_Name=DISABLED <br>
:::21_Slot=mainhand <br>

::Then on main toon you can have hotkey: "/bct Bardsname //twist 1 2 3 21"<br>
::Number 21 is for the [21] section you just did in the server_char.ini.<br>
::The Delay and ReCastTime may need to be adjusted depending on the epic.<br><br>

:: 2. If using the older version of MacroQuest. <br>
::    Edit mq2twist_bardname in your MQ2 folder and replace [Click_13] with following. <br>
:::[Click_13] <br>
:::Cast Time=20 <br>
:::ReCast Time=600 <br>
:::Name=Disabled <br>
:::Slot=mainhand <br> 

::Then on main toon you can have hotkey: "/bct Bardsname //twist 1 2 3 13" <br> 
::Number 13 is for the [Click_13] you just did in the mq2twist file. <br> 

'''Multiline'''<br>
* Allows you to fit more than one command in one hotbutton line (as long as it doesn't extend beyond the frame)<br>
* Example: "/multiline ; /bca //stick 10 behind ; /stick 10" - Makes all OTHER characters stick behind, and your main character stick in front.<br><br>

'''Filtering'''<br>
* Allows you to filter what shows in your chat box. You can add an asterisk before the text to act as a wild card, otherwise it will only filter lines which begin with what you type. Wild cards will be filtered if they pop up anywhere in a certain line.<br>
* Example: "/filter name add *begins to glow" - Filters out all messages about glowing items from focus effects. The * is only needed before the filter, and is assumed after it
* Example: "/filter name add You strike through" - Filters out all messages about striking through your opponents defenses. It doesn't need a wild card because it is the start of the text.
* Some popular wild card filters for EZ: *begins to glow (charm focus effect), *has died (NPC death), *beams a smile (lifetap emote), *is struck by a cyclone (every warrior epic), *glows blue (more charm spam), *has been slain by (NPC death), *contorts with rage (Warrior Anger proc), *your wounds close (Druid Skin proc)
* Some popular standard filters for EZ: You have slain (NPC death), You strike through (in-game filter doesn't work for this), You resist the (Resist messages), Your faction standing with (faction messages)<br><br>

'''Self Buffing Your Own Group''' (This will allow you to have your boxes Target their pets (if they have them) and buff themselves.)<br>

*'''Line One:''' "/bca //useitem [[Slot Names|slotname]] (bagslot#(0-9) RoF2 only)"
*'''Line Two:''' "/noparse /bca //target ID ${Me.Pet.ID}" - /noparse is a must at the beginning because if it's not there, your boxes will try to target your Main Box's Pet.
*'''Line Three:''' "/bca //say buffs" - This will buff each of your boxed characters with their clicky pets from your main box ([[Caster's Guild Quest]] Flag required).<br><br>

'''Hide Corpse''' (not MacroQuest, but still useful)<br>
* /hidecorpse looted (hides corpse after it has been inspected)<br>
* /hidecorpse all (hides all corpses in zone other than your own)<br>
* /hidecorpse off (makes all corpses in zone visible)<br>

== Hotbutton Examples ==
'''Assist'''<br>
/bca //target id ${Target.ID}<br>
/bca //stick 15 uw behind<br>
/stick 10<br>
/bcaa //attack on<br>
/bcaa //pet attack<br><br>
'''Follow'''<br>
/bca //target id ${ME.ID}<br>
/bca //stick 10<br><br>
'''Gate to Nexus'''<br>
/bcaa //itemnotify 19 rightmouseup<br><br>
'''Loot Corpse'''<br>
/target corpse<br>
/stick 1<br>
/loot<br><br>
'''Make Alt Loot Corpse''' (Alt targets corpse that you are currently on, waits 2 seconds for you to get off corpse, then loots all of corpse's contents)<br>
/bct Brotedo //target id ${Target.ID}<br>
/bct Brotedo //stick 1<br>
/pause 20<br>
/bct Brotedo //lootall<br><br>
'''Alt Nuke Target'''<br>
/bct Wizardname //target id ${Target.ID}<br>
/bct Wizardname //cast 2 -maxtries|4<br><br>

'''Alt Cast Spell on Target'''<br>
/bct Toonname //target id ${Target.ID}<br>
/bct Toonname //casting (spell ID number)<br>
( e.g. /bct Aamadex //casting 125262 )<br><br>

'''Force Boxes to Only Render UI''' (Reduces Lag)<br>
/bca //viewport 1 1 1 1<br><br>

'''Render Reset''' (see above)<br>
/bca //viewport reset<br><br>

== Optimizing Everquest ==
  While macroquest is a great tool for playing multiple characters on one computer at the same time, there are some things to know and keep in mind to make your game play as enjoyable as possible.
  Some things can be accomplished locally to your computer without having to send a command to the server and get a response back.  An example of this is during combat.<br>
  Lets say you just pulled 4 orcs, and you have got them back to camp and the army is going to pounce.  You could make a hotbar social that reads:
  '''/bca //assist maintank'''
  '''/pause 5'''
  '''/bca //stick 10 behind uw'''
  '''/bca //attack on'''
  While this works and works rather well, what happens is, you send a command from maintank to the eqbc, which in turn sends that command to all other characters you have logged in.
  Now each character on it's own does a /assist maintank.  This /assist maintank has your eq client send a command to the server and asks it, "who is maintank targeting?" then it waits for a response.
  Once it gets the answer from the server, the client then targets the maintanks target and turns attack on.<br>
  To remove the request from the server and the wait for the answer, with macrquest you can do the following.
  '''/bca //tar id ${Target.ID}'''
  '''/pause 2'''
  '''/bca //stick 10 behind uw'''
  '''/bca //attack on'''
  In this example, maintank issues a command to eqbc, which in turn sends that command to all other characters you have logged in.
  Now each character on it's own does a /tar id #.  Instantly everyone is targeting the right npc. No request of ezserver, no wait.<br>


[[Category:Guides]]