• Run MQ2Auth.exe from where the file was unzipped, this will create a file called MQ2Auth0.h in the MQ2Main directory.
• If MQ2Auth.exe is not run where an MQ2Main folder exists, MQ2Auth0.h will be created in the same directory as the MQ2Auth.exe file.
• The file can then be copied to the MQ2Main folder.

• If you are compiling MacroQuest2 for someone else, they need to run MQ2Auth.exe on their computer. They must return the file generated to you. The MQ2Auth0.h file can be used to hold your generated information and that of whoever you are compiling MacroQuest2 for.
• MQ2Auth.exe will append information generated on different computers to MQ2Auth0.h. This allows you to compile one version of MacroQuest2 that will run on any computer which has it's information in the MQ2Auth0.h file.

1. Have Person 1 run (double click) MQ2Auth.exe from their C: drive. This will create an MQ2Auth0.h file on their C: drive
2. Person 1 passes the MQ2Auth0.h file that was created to Person 2, who places MQ2Auth0.h on their C: drive along with the MQ2Auth.exe program
3. Person 2 then runs (double clicks) the MQ2Auth.exe, his information is appended to the MQ2Auth0.h file.
4. Continue until your last friend has run MQ2Auth.exe from their C: drive with the MQ2Auth0.h file, who then passes the MQ2Auth0.h file to the person who will compile MacroQuest2.
5. The person who is compiling MacroQuest2 can then place the MQ2Auth0.h file in the MQ2Main folder of the MacroQuest2 source directory.
6. This person then double clicks the MQ2Auth.exe program that exists in the main MacroQuest2 folder to have his information appended to the MQ2Auth0.h file that was placed in he MQ2Main folder.

1. Install Visual C++ 6.0 or Visual Studio 6.0
2. If you are installing VC6++ please make sure you have installed SERVICE PACK 6. You can find Service Pack 6 here: Service Pack 6
3. Download the MacroQuest2 source files
4. Unzip it into any new folder
5. Go to the newly created folder and double click MQ2Auth.exe
6. Double click macroquest2.dsw file. This will Open Visual C++
7. Select Build -> Set Active Config and select MQ2main. Click OK
8. Select Build -> Build MQ2main.dll or press F7
9. Select Build -> Batch Build. Make sure everything in the batch build window that says release has a check by it.
10. Click the Build button. All should compile with no errors or warnings.

1. Download the MacroQuest2 source files
2. Unzip it into any new folder
3. Right click the folder, select Properties, and remove the Read only flag
4. Double-click MQ2Auth.exe. This will create the file necessary for compiling MQ2 in the MQ2Main folder.
5. Double-click the Macroquest2.sln file. VC.net will open the MacroQuest project
6. Go to the Build menu and select Configuration Manager
7. Select Release, and place a check in each dll you want compiled. Click the Close button

8. Go to the Build menu and select Build Solution
9. The dll files will compile and be placed in the Release folder.

1. Create a new folder anywhere, such as c:\MQ2
2. Create four new folders within this folder, named configs, ini, logs, and macros
3. Copy the Macroquest2.exe, the compiled dll's, the ini files, and the .txt files from the Release folder to c:\MQ2:

1. Access other web sites
2. Access the MacroQuest2 forums
3. View the Readme
4. Edit your MacroQuest2 ini file

1. We need to know the actual error. The address, the address that was probably trying to be read, etc. Copy and paste from the debugger.
2. We need to know if the crash itself was in EVERQUEST, or MACROQUEST2. If it was in MacroQuest2, the debugger will show you the source line. If not, it will show you some disassembly and an offset in eqgame.exe (most likely).
3. Inside MacroQuest - The error information from #1 as well as the source line that caused the crash. If you can, copy and paste us the surrounding code block and let us know which source file it was in (e.g. MQ2Utilities.cpp)
4. Inside EverQuest - The error information #1 including the offset in eqgame.exe, copy and paste a couple lines of the disassembly if you can, AND GET THE FUNCTION CALL STACK. If we get the function call stack, it may be VERY easy to fix the problem. If not, may be very DIFFICULT to fix the problem.

1. How to attach a debugger to the process, and how to enable trapping of the 0xC0000005 exception (the majority of crash bugs)
2. Where to find the debug spew as well as crash information (for #1) when eqgame.exe crashes
3. Where to find the source line (for #2a) when eqgame.exe crashes inside MacroQuest2
4. Where to find the disassembly (for #2b) when eqgame.exe crashes
5. Where to find the function call stack (for #2b) when eqgame crashes

1. Debug menu->Processes option. In the "Available Processes" list. Select eqgame.exe
2. Click "Attach". In the "Attach to Process" box that pops up, select only "Native" in the list. Click OK. The popup closes and the debugger attaches. Click "Close" in the processes window.
3. To enable trapping of the 0xC0000005 exception, open Debug->Exceptions (alternatively ctrl+alt+E). Expand "Win32 Exceptions". Select "c0000005 Access violation". Select the two "Break into the debugger" options. Click OK.
4. Debug spew can be found in the "Output window" by pressing ctrl+alt+O, or by going View->Other Windows->Output. The crash information will be displayed there when eqgame.exe crashes.
5. VS.NET will automatically point to the source file and put a green arrow by the source line that caused the problem, assuming MacroQuest2 was compiled on the computer you are running this on.
6. If the disassembly does not show up, you can switch to the disassembly window by hitting alt+8 or by going debug->windows->disassembly
7. The function call stack can be found in the toolbar that contains "Program", "Thread" and "Stack Frame". The call stack will be seen in the "stack frame" combo box. Pull it down and take note of the top few if not the entire list.

1. Build menu->Start Debug->Attach to process...
2. Check the "Show System Processes" button. Select "eqgame.exe" in the list. Click OK.
3. The c0000005 exception trapping can be enabled by going Debug->Exceptions. Select c0000005 Access violation. Click "Stop always". Click Change. Click OK
4. Debug spew can be found in the "Output window" by hitting alt+2, or by going View->Output. The crash information will be displayed there when eqgame.exe crashes.
5. VS6 should automatically point to the source file and put a green arrow by the source line that caused the problem, assuming MacroQuest2 was compiled on the computer you are running this on.
6. If the disassembly does not show up, you can switch to the disassembly window by hitting alt+8 or by going View->Debug Windows->Disassembly
7. The function call stack can be found in the "Call Stack" window, found by pressing alt+7 or by going View->Debug Windows->Call Stack

[MQ2]Echo - [MQ2] no combat - ending
[MQ2]WriteChatColor([MQ2] no combat - ending)
[MQ2]WriteChatColor(Cleared the following: Timers Arrays)
[MQ2]EndMacro - Ended
[MQ2]WriteChatColor(The current macro has ended.)
>>>First-chance exception at 0x03002e30 (MQ2Main.dll) in eqgame.exe: 0xC0000005: Access violation reading location 0x0127bde8.

>>>MQ2Main.dll!HideDoCommand(EQData::_SPAWNINFO * pChar=0x423338e8, char * szLine=0x0127bde8, int delayed=0) Line 118 + 0x9 C++
MQ2Main.dll!DoNextCommand() Line 40 C++
MQ2Main.dll!Heartbeat() Line 255 + 0x5 C++
MQ2Main.dll!Detour_ProcessGameEvents() Line 270 C++
eqgame.exe!004acd5f()
ntdll.dll!77f944a8()
ntdll.dll!77f57d70()
ntdll.dll!77f58a3a()
ntdll.dll!77f5d760()
ntdll.dll!77f8696d()
ntdll.dll!77f59bf9()
ntdll.dll!77f5d90e()
ntdll.dll!77f5d8e2()
ntdll.dll!77f944a8()
ntdll.dll!77f944a8()
ntdll.dll!77f57d70()
ntdll.dll!77f58a3a()

MQ2CommandAPI.cpp (line 118)
if (Pos==0) {
if (pCommand->Parse) {
pCommand->Function(pChar,ParseMacroParameter(pChar,szParam));
}
else
pCommand->Function(pChar,szParam);
>>>strcpy(szLastCommand,szLine);
return;
}

pCommand->Function(pChar,szParam);
03002E15 mov eax,dword ptr [pChar]
03002E18 lea edx,[esp+1018h]
03002E1F push edx
03002E20 push eax
03002E21 call dword ptr [esi+40h]
03002E24 add esp,8
strcpy(szLastCommand,szLine);
03002E27 mov edx,offset _szLastCommand (3075528h)
03002E2C mov eax,ebx
03002E2E sub edx,ebx
>>>03002E30 mov cl,byte ptr [eax]
03002E32 mov byte ptr [edx+eax],cl
03002E35 inc eax
03002E36 test cl,cl
03002E38 jne HideDoCommand+340h (3002E30h)
return;

Sub Main
   :OnExit
/return

|This is a single line comment

|** This is a multiple line comment where
you could use this form of commenting **|

Example
#define Me charactername
When the macro executes, when Me occurs, it will be replaced with charactername

Example
#event SpellFizzle "Your spell fizzles"

Matching Sub:

Sub Event_SpellFizzle


/return

global
Variables of global scope ALWAYS exist until they are deleted or macroquest ends

outer
Variables of outer scope exist while a macro is running

local (default)
Variables of local scope only exist while within a macro function or "Sub"

1. The default type is string
2. The default scope is local
3. The default value is nothing (empty string, or 0)

Examples

/declare MyVar int outer
Creates an int variable named MyVar that exists while the macro is running

/declare MyVar local
Creates a string variable named MyVar that exists within the Sub it was created in

/declare MyTimer timer outer 3000
Creates a timer named MyTime that is set to 3000 at creation and exists while the macro is running

Array Examples

MyArray[10] int
Creates a single-dimension local array of int with 10 elements (1-10) all 0

MyArray[10,10] int outer 5
Creates a 2-dimensional 10x10 elements(1-10,1-10) int array of scope outer with all values of 5

MyArray[4,5,6] string outer UNDEFINED-ARRAY-ELEMENT
Creates a 3-dimensional array with 4x5x6 elements (1-4,1-5, 1-6) with UNDEFINED-ARRAY-ELEMENT in each location

Examples

/varset MyString ${MyString}stuff
concatenate a string variable

/varset MyString stuff${MyString}
inserts stuff at the front of ${MyString}

/varset MyInt 123
Sets MyInt to 123

/varset MyTimer 123s
Sets MyTimer to 123 seconds

/varset MyFloat 1.23
Sets MyFloat to 1.23

/varset MyIntArray[n] 123
Sets array element n to 123

Examples

/varcalc MyInt 1+2*2+1

/varcalc MyInt 1+(2*2)+1

Example

/vardata MyFloat Math.Calc[${Me.X}+${Me.Y}]

Example

${MyString${MyVar}}
The parser first evaluates ${MyVar}. If MyVar's value is 1, this is then ${MyString1}.
${MyString1} is then evaluated, giving the value of whatever MyString1 is.

Sub Main
.
code
.
/return

1. You do not have to define parameters for a sub
2. Parameters passed to a Sub without defined parameters will default to Param0, Param1, ... Paramn
3. Default parameters are of type string
4. If you define the parameters of a Sub, the parameters can be of any data type that exists in MQ2DataVars
5. If the type of a defined parameter is not given, it will default to string
6. When you define the parameters, you may use the parameter names as variables in the sub
7. If parameters are undefined, you would use Param0, Param1,...Paramn as the variable names

Sub Main(int MyParam1, MyParam2, float MyParam3)
/if (${Defined[MyVar2]}) /goto :DoThis
/call MySub ${var1} ${var3}
/echo This value was returned from MySub: ${Macro.Return}
/return

Sub without defined parameters

Sub MySub
/if (${Defined[Param0]}) /goto :DoThis
.
execute this code when /call MySub is executed. Parameters are not necessary.
.
/return [value|${varname}]

Sub with defined parameters

Sub MySub(int MyParam0, bool MyParam1, MyParam2)
.
execute this code when /call MySub is executed.
.
/return [value|${varname}]

Sub Event_Chat[(ChatType,Sender,ChatText)]

ChatType : Channel of message (tell, group, say)
Sender : Name of the person who sent the message
ChatText : Text they sent

Example

Sub Event_Chat[(ChatType,Sender,ChatText)]
.
This code is executed when /doevents finds(queues) text in the channel defined by #chat "channel"
.
/return [value|${varname}]

Sub Event_Timer[(Timer,OriginalValue)]
Timer: Timer that fired
OriginalValue : Value timer was originally set to

Example

Sub Event_Timer[(Timer,OriginalValue)]
.
This code is executed when /doevents detects(queues) any defined timer reaching 0
.
/return [value|${varname}]

Old Event system
#Event SelfEcho "[MQ2] Genbot "

Here is what the new Event look like:
#Event SelfEcho "[MQ2] Genbot #1#"

1. Because this system lets you pick the parameter number of any portion of the message, some parameters might not get made (e.g. wont be ${Defined}... it's up to you to make sure you get the ones you need defined.
2. The MQ2Data is not immediately parsed when the event is made, it gets parsed when the system checks to see if the event is a match.
3. If you need to SKIP a portion of the text (dont care about it, just need to ignore part of the text that might not match, whatever), you can use #*#.

Example

#Event SkillUp "You have become better at #1#! (#2#)"

Sub Event_SkillUp(SkillUpText,Skill,int Amount)
/popup ${Skill} increased - ${Amount} ...
/echo ${Skill} increased - ${Amount} ...
/return

SkillUpText = "You have become better at #1#! (#2#)"
Skill = Parameter 1 = #1#
Amount = Parameter 2 = #2#

Examples

/alert add 1 "spawnname"	Adds spawnname to alert list 1
/alert clear #	Clears all members from alert list 1
/alert list #	Lists all members of alert list 1
/alert add 1 npc radius 300 'spawnname'	Sets alert(1) to TRUE if 'spawnname' is within radius of 300 from your location
/alert add 2 npc range 30 200 'spawnname'	Sets alert(2) to TRUE if any 'spawnname' are within 30 to 200 range from your location

/alias list
Lists all aliases

/alias /hp /echo My health is ${Me.PctHPs}
Typing /hp in the EQ chat box will display: My health is % in the EQ chat window

/alias aliasname delete
Deletes aliasname from Macroquest.ini

Examples:

/bind forward e	Binds the forward command to key e
/bind ~forward up	Binds the forward command to alternate key uparrow
/bind forward clear	Clears the key used for the forward command
/bind '/bind cast1 shift+1	Binds ''Cast gem 1'' to shift 1 key combination

Note: Changing EQ binds will not immediately update the display in the options window. Change the bind
list selection in the options window to see the updated keys.

Examples

/call MySub	Executes Sub MySub
/call MySub varname1 varname2 ...[varname#]	Executes Sub Mysub and passes parameters

Player1 is linked to /shownames 1
Player2 is linked to /shownames 2
Player3 is linked to /shownames 3
Player4 is linked to /shownames 4

Example

Player1=${If[${NamingSpawn.Trader},Trader,]}${If[${NamingSpawn.Invis},(${NamingSpawn.DisplayName})

Use "\n" to add a new line when setting captions

Example

/caption update 20
Sets the number of nearest spawns for MQ2 to update the name of each pass to 20. By default, this is 35.

Examples

/captioncolor list
/captioncolor pcclass on
/captioncolor pctrader on
/captioncolor pctrader 255 128 0

PC OFF (Default color for PCs)
PCCon OFF (PCs by con color)
PCPVPTeam OFF (PCs by PVP team color)
PCRaid OFF (Raid members))
PCClass OFF (PCs by class color(raid settings))
PCGroup OFF (Group members))
PCTrader ON Color: 255 127 0. (Traders)
NPC OFF (NPC default color))
NPCCon ON (NPCs by con color))
NPCClass OFF (NPCs by class color (raid settings))
NPCMerchant ON Color: 255 127 0. (NPC Merchants)
NPCBanker ON Color: 200 0 255. (NPC Bankers)
NPCAssist ON Color: 255 255 0. (NPCs from main assist))
NPCMark ON Color: 255 255 0. (Marked NPCs)
PetNPC OFF (Pet with NPC owner)
PetPC OFF (Pet with PC owner)
PetClass OFF (Pet by class color (raid settings))
Corpse OFF (Corpses))
CorpseClass OFF (Corpse by class color (raid settings))

/cast "complete heal"
/cast "${SpellName}"
/cast 1
/cast item "mana robe"
/cast list

Examples

/click left	Performs a left mouse click at the current mouse position
/click left 100 100	Performs a left mouse click at 100 100
/click left +30 -30	Performs a left mouse click 30 pixels right and 30 pixels up from the current location
/click right target	Performs a right click on your current target
/click left center	Performs a left click in the center of the viewport area

Example

/combine pack8

• "/custombind list" will list all of your custom binds names and commands (the key combinations must be set using /bind)
• "/custombind add name" will add a new bind name for use here, with /keypress, /bind, etc.
• "/custombind delete name" will remove a custom bind
• "/custombind clear name [-down|-up]" will clear a specific command for a custom bind. If up or down is not specified, defaults to down.
• "/custombind set name [-down|up] command" will set a specific command for a custom bind. If up or down is not specified, defaults to down.

Example usage (NOTE: MQ2's very first bind command is "RANGED" so you do not need to do this, but for example)

/custombind add mybind
/custombind set mybind /ranged
/bind mybind n

Binds the /ranged command to the n key

Examples

/delay 5	Delays the macro execution for 5 tenths of a second
/delay 1s	Delays the macro for 1 second
/delay 1m	Delays the macro for one minute

Example of condition usage:

/keypress forward hold
/delay 1s ${Spawn[1234].Distance}<${Spawn[1234].MaxMeleeTo}
/keypress forward

Will execute /keypress forward when ${Spawn[1234].Distance}<${Spawn[1234].MaxMeleeTo} evaluates to TRUE or after 1 second passes.

Example

/docommand ${If[${Me.Sitting},dotrue,dofalse]}

Examples

/doevents chat	doevents will only run chat events
/doevents flush	Clears all events in the /doevents queue
/doevents SpellFizzle	doevents will only run SpellFizzle events

Example:

/echo My current health is at ${Me.PctHPs}

Examples

/face	Turns you to face and look at your selected target
/face nolook	Faces your target without changing your vertical view angle
/face fast	Immediately turns your character to face and look at the target
/face fast predict	Immediately turns your character to face and look at the target's estimated position
/face fast nolook	Immediately turns your character to face your target without changing your vertical view angle
/face fast nopredict	Immediately turns your character to face and look at your target's estimated position
/face item	Faces and looks at the item from /itemtarget
/face fast item	Immediately faces and looks at the item from /itemtarget

/for varname value1 to|downto value2 [step val3]
.
commands
.
/next varname

/goto :MyLabel

/highlight color # # #

Sets the highlight color to an RGB value

Note: You can use search filters for spawnname

Example

/if (${firstvar.Equal[This is true]}) {
/echo TRUE
} else /if (!${secondvar}) {
/echo FALSE
/mqlog secondvar equals: ${secondvar}
} else {
/echo It's Something else
}

Example

stuff.ini contains:

[MySection]
Key1=123
Key2=This is cool!
Key3=Wheeee... 15

/ini "stuff.ini" "Section2" "ANewKey" "Some Data!"

stuff.ini after the above command is executed:

[MySection]
Key1=123
Key2=This is cool!
Key3=Wheeee... 15

[Section2]
ANewKey=Some Data!

notification can be:

leftmouse	No action
leftmouseup	Removes the item and puts it on cursor (same as left clicking it)
leftmouseheld	For making hotkeys (you know, hold down left button)
leftmouseheldup	No action
rightmouse	No action
rightmouseup	Casts the effect, or opens the container (same as right clicking it)
rightmouseheld	Opens item display window
rightmouseheldup	Closes the item display window for that item

Examples:

Exchange of item in primary slot:
   /itemnotify pack8 leftmouseup
   itemnotify mainhand leftmouseup
   itemnotify pack8 leftmouseup

Click grim aura earring:
   itemnotify rightear rightmouseup

Examples

/keypress jump	Taps the key mapped as the jump key
/keypress forward hold	Holds down the mapped forward key
/keypress forward	Releases the mapped forward key after /keypress forward hold

AutoExec.CFG
Executed on the first pulse

CharSelect.CFG
Executed when you are put at character select

server_character.CFG
Executed when this character enters the world

mapshortname.CFG
Executed when you zone into this zone

pluginname-AutoExec.CFG
Executed when this plugin is loaded (after its initialization is complete)

Examples of file names:
tallon_lordsoth.cfg
character

oot.cfg, soldungb.cfg, soldunga.cfg, take.cfg
maps

MQ2Map-AutoExec.CFG, MQ2ChatWnd-AutoExec.CFG
plugins

Examples

/look 50	Changes your look angle to +50
/look -75	Changes your look angle to -75 (down)

Example

/mapclick lalt+shift /mycommand %i
leftalt+shift right click on a spawn will cause /mycommand to be executed.

Examples

/maphide reset
Re-generates the spawn list.

/maphide npc range 1-39
Hides all spawns level 39 and below

Here are a few examples as a guide

/mapnames normal [%l %R %C] %N

/mapnames target [%l %R %C] %N (%x, %y, %z)

Example

/memspell 1 "complete heal" memorizes Complete Heal in spell gem 1

Example

/multiline ; /stand ;/rude ;/sit

Example

/noparse /ini blah blah blah ${stuff}

Note: ${stuff} is literal instead of changing it to the current value of stuff.

Examples

/notify hotbuttonwnd HB_Button1 leftmouseup	Activates the first hotkey
/notify somewindow SomeSlider newvalue 100	Moves the referenced slider in the window to 100
/notify trackingwnd 0 close	Closes the tracking window
/notify TradeskillWnd RecipeList listselect 1	Selects the first item in the RecipeList listbox

/plugin name noauto
loads name without updating Macroquest.ini

/plugin name unload noauto
unloads name without updating Macroquest.ini

/popup Current Mana: ${Me.CurrentMana}
/popup Run away! Run away!

Example

Sub MySub
.
<code>
.
/return [value|${varname}]

/seterror clear
Clears the last error value

Example

/shiftkey /itemnotify pack1 leftmouseup
Pick up an entire stack

Examples

/skills	Lists all of your skills with skill level
/skills pottery	Returns your pottery skill

/squelch /filter mq on
<do your stuff here>
/squelch /filter mq off

Examples

   /substitute mom Mother
   /substitute omg Oh my god!
   /substitute k "%omg, kill %t before I tell your %mom"

The final example if you typed "/say %k" would produce:

   Oh my god!, kill targetname before I tell your Mother

Please note the following rules/reminders:

1. You don't use the percent signs when creating the substitutions or editing your config file.
2. You can use MQ's subsitutions without spaces around them (unlike EQs!) (ie: /echo "%omg%mom" would return "/echo Oh my god!Mother"
3. Substitutions do not currently work in macros.
4. /sub is currently a valid shorthand for "/subsitute"
5. You can use EQ's wildcards (ie: %t) within your substitutions; however, you have to leave spaces around them (yes, they suck)
6. You cannot CURRENTLY replace EQ wildcards with MQ substitutions (ie, you can't make a replacement for %m (This may be supported in the future.)

Example

/timed 10 /echo 1 second has passed

Example

/varcalc MyVar ${Me.CurrentMana} - ${Spell[Complete Heal].Mana}

Example

/vardata MyFloat Math.Calc[${Me.X}+${Me.Y}]

Examples

/varset myvar 25	Sets myvar to 25
/varset array[3] 10	Sets the value of array[3] to 10
/varset casttimer 30	Sets the timer to 3 seconds
/varset array[2,12] 45	Sets the value of array[2,12] to 45
/varset casttimer 3m	Sets the Timer to 3 minutes

Examples

/where	Lists the closest pc or npc
/where pc	Lists the closest pc
/where npc	Lists the closest npc
where npc "orc pawn"	Lists where the closest orc pawn is

float Distance
Distance from player in (x,y)

/echo Distance to target is: ${Target.Distance}

Example

Using the int immediate type member with a spawn reference type member:

If you wanted to convert the float value Distance to an int value, you could append one of the members of the float immediate type.

${Target.Distance.Int}

int Screw

${TopLevelObject[index](cast).Member[index](cast).Member[index](cast)}

${Target}(bool)

${If[${Target}(bool),true,false]}

Example

/varset myvar ${Spawn[1](int)}
/echo ${Int[${myvar}](spawn).Name}

Do NOT do that! It will only work until the memory address changes. Instead, use the ID as you always have:

/varset myvar ${Spawn[1].ID} /echo ${Spawn[${myvar}].Name}

1. The TLO type is indicated by the italic text preceding the name
2. The TLO has access to the type members
3. The TLO name is static and it cannot be changed

Examples

/echo ${AltAbility[Combat Stability].RequiresAbility}}
Returns the pre-requisite AA ability needed to train in this Ability

/echo ${AltAbility[n].RequiresAbility}}
Returns the pre-requisite AA ability needed to train in the Ability with the number n

Examples

/declare MyVar bool

/varset MyVar ${Bool[This is true]}
/echo ${MyVar} would echo TRUE

/varset MyVar ${Bool[NULL]}
/echo ${MyVar} would echo FALSE

int CurrentHPs Current hit points

Example

/echo ${Me.CurrentHPs}

Example

/if ${Corpse.Open} {
Do this stuff
}

If the loot window is open Do this stuff

Example

/if (${Cursor.ID} ) /autoinv
If something is on your cursor, drop it into the autoinventory

Example

/if (${Defined[varname]}) { Do this stuff }

If the variable has been declared execute Do this stuff

Example

/echo ${Ground.Distance}
Echos the distance to the ground item you have targeted

Examples

/itemnotify ${FindItem[sprinkler].InvSlot} leftmouseup
Picks up your cleric epic from your corpse

/itemnotify ${FindItem[swirling].InvSlot} leftmouseup
Picks up any item containing the word swirling from the opened corpse

Example

/echo ${FindItem[=Swirling Shadows]}
This is a simple example with little use, but If the item is found, the name of the item will be echoed

Example

/echo ${FindItemBankCount[Swirling]}
Returns how many Swirling Shadows you have in your bank

Example

/echo ${FindItem[=Water Flask]}
Echoes the number of Water Flask you have in your inventory

Example

${Float[12.345].Deci}
Creates a float object of 12.345 and truncates the decimal to one decimal place

Example

/echo ${GameTime.Date}
Echos todays real time date to the chat window

Examples

/echo ${Heading[15].ShortName}
Echos the shortname of the heading of 15 degrees.

/echo ${Heading[-342,700].ShortName}
Echos the shortname heading to the location -342,700

Examples

/docommand ${If[${Me.Sitting},/stand,/echo I am not sitting down]}
If I am sitting, stand up, Otherwise echo I am not sitting down

/docommand ${If[${Me.CurrentHP}<50,/cast "Gate",/goto :Continue]}
If my hp percent is below 50 cast the Gate spell, otherwise goto the Continue label

1. The section, key, and default do not need to be given
2. section and key may be set to -1 to skip them and give a new value.
3. If section or key are not given, multiple values are read.

Example

sample.ini contains:

[KeyOne]
value1=foo
value2=bar

[KeyTwo]
Value3=foobar

${Ini[sample.ini,KeyOne,value1]} returns foo
${Ini[sample.ini,KeyOne] returns value1|value2||
${Ini[sample.ini] returns KeyOne|KeyTwo||

Example

/echo ${Int[123].Hex}
echos the result of the conversion of 123 to an int in hexadecimal

Examples

/if (!${Window[pack${bag}].Open}) /itemnotify pack${bag} rightmouseup
If the container in slot pack${bag} isn't opened, open it

/if (${InvSlot[bank${index}].Item.Container}) /call CheckPack bank${index}
Is the item in bank${index} a container, if so /call CheckPack and pass the parameter bank${index}

Examples

/echo ${LastSpawn[10].ID}
Echos the spawnID of the 10th mob to spawn in the zone

/echo ${LastSpawn[-10]}
Echos the name of the 10th to last spawn in the zone

Example

/echo ${LineOfSight[20,40,-20:100,-300,70}
Returns TRUE if Line of Sight is clear between the two locations

Example

/echo This macro has been running for: ${Macro.RunTime.Second} seconds

Example

/echo ${MacroQuest.LastTell}
Returns the name of the last person to send you a tell

Example

/echo ${Math.Sqrt[49]}
Echos the square root of 49

/echo ${Math.Rand[500]}
Echos a random number between 0 and 500

/echo ${Math.Calc[49%6+25]}
Echos the result of 49%6+25, or 1+25

Example

/echo ${Merchant.Name}
Echos the name of the merchant whos window you have open

Player1= what is displayed using /shownames 1
Player2= what is displayed using /shownames 2
Player3= what is displayed when using /shownames 3
Player4 = what is displayed when using /shownames 4

Examples

/echo ${NearestSpawn[npc range 100 "orc pawn"]}
Finds any npc containing orc pawn in its name that is within 100 of you

/echo ${NearestSpawn[1]}
Finds the closest spawn to you

Example

/echo ${Raid.Members}
Echos the number of members in your raid

Examples

/echo ${Select[${Stuff},this,that,another]}

If ${Stuff} is equal to this, the value 1 will be echoed
If ${Stuff} is equal to that, the value 2 will be echoed
If ${Stuff} is equal to another, the value 3 will be echoed

If ${Stuff} isn't equal to this,that, or another the value 0 will be echoed

Examples

/if (${SelectedItem.Charges}<1)
Determines if the selected item is out of charges

/if (${SelectedItem.Name.Equal[rusty dagger]})
Checks to see if the selected item is a rusty dagger

Examples

/echo ${Skill[1].ReuseTime}
Displays the reuse time of skill 1

/echo ${Skill[backstab]].ID}
Displays the skill number of the backstab skill

Examples

/echo ${Spawn[n]}
Displays the name of the spawn with id number n

/target ${Spawn[npc radius 500 trakanon]}
Targets the npc with the name Trakanon only if within a radius of 500

Examples

/echo ${SpawnCount}
Displays the count of all spawns

/echo ${SpawnCount[range 45 50}
Displays the count of all spawns in the level range of 45 to 50

Examples

/echo ${Spell[n].MyCastTime}
Returns your adjusted cast time for spell with id n

/echo ${Spell[spellname].PushBack}
Returns the pushback amount of spellname

Examples

/echo ${Switch.Heading}
Returns the direction to the switch

/echo ${Switch.Open}
Returns TRUE or FALSE

Examples

/echo ${Target.Level}
Echos the level of your target(if it has one)

/echo ${Target.Name.Equal[iron oxide]}
Echoes a boolean value of whether your item targetted is Iron Oxide

Example

/echo ${Time.DayOfWeek}
Returns the day of the week

Examples

/if ${Type[MyParam].Name.NotEqual[bool]} {
/echo This variable is not of type bool
}

${Type[spawn].Member[ID]}
Determines if a member of a type exists

${Type[spawn].Member[${n}]}
Enumerate members of a type using a loop

Examples

/echo ${Window[MerchantWnd].Open}
Returns TRUE if a Merchant window is open

/echo ${Window[windowname]}
Returns TRUE if the WindowName exists, but doesn't have to be opened.

/echo ${Window[MerchantWnd].Minimized}
Returns TRUE if the Window is opened and minimized

${Window[TradeskillWnd].Child[RecipeList].List[=Inky Shadow Silk]}
Find an item in the tradeskill item list box by the exact name Inky Shadow Silk

${Window[TradeskillWnd].Child[RecipeList].List[1]}
Get the first-column text for the 1st item in the tradeskill item list box

Examples

/echo ${Zone.Type}
Returns an integer representing the zone you are in

/echo ${Zone[zonename].ID}
Returns the ID of zonename, even if you aren't in the zone

/echo ${Zone[zoneid].ShortName}
Returns the short name of the zone with ID zoneid

Example

Sub Main
/declare MyVar string local
/varset MyVar THIS,,IS,A,,TEST
/echo Using Arg: ${MyVar.Arg[2,,]}
/echo Using Token: ${MyVar.Token[2,,]}
/return

The output from the above would be:

Using Arg: IS
Using Token: (empty string)

/echo ${Me.Buff[1]}
/echo ${Me.Buff[1].Duration.Time}
/echo ${Me.Buff[name].Duration.Time}
/if (${Target.Distance}<11)&&(${Me.AbilityReady[Bash]}) /doability "Bash"

${Me.Inventory[slot]}
/if (${InvSlot[pack${index}].Item.Container})
/if (!${InvSlot[pack${index}].Item.Container} && ${InvSlot[pack${index}].Item.ID})
${Window[Enviro].Open}

${Group[1].Name}
${Target.Name}
${Group[1].Pet.Name}

/echo ${Cursor.ID}
/echo ${Me.Gem[3].ID}
/echo ${Group[3].ID}
/echo Bat 1: ${NearestSpawn[1,npc bat].ID}
/echo Bat 2: ${NearestSpawn[2,npc bat].ID}
/echo Bat 3: ${NearestSpawn[3,npc bat].ID}

/target id ${NearestSpawn[1,pc].ID}
Target the nearest PC

/if (!${Defined[myVar]}) {
/declare myVar int local 0
}

/docommand ${If[Cursor.Name.Compare[itemname],/autoinv,/destroy}
/if (${Param1.Equal[yourself]}
/if (${Param1.NotEqual[${Me.Name}]})

/if (${AttackOnAssist}==1)
/if (${Target.ID}==${Int[${Param0}]})
/if (${Target.Distance.Int}<100)
/if (!${Me.Combat} && ${DoTraps}==1)

${Window[SpellBookWnd].Open}
${Me.Casting}
${Me.Gem[1].Name}

/if (${Math.Distance[${AnchorX},${AnchorY}]}>${AnchorRadius})
${Math.Calc[${Target.Y}-${Math.Cos[${Target.Heading}]}]}
${Math.Distance[${Math.Calc[${Target.Y}-${Me.Y}]}]}

/varset DoEvade ${Ini[${IniFile},Combat,DoEvade]}

Window closed
/if (!${Window[pack${PackNum}].Open}) {/echo not open}
/if (${Window[pack${PackNum}].Open}==FALSE) {/echo not open}
/if (${Window[pack${PackNum}].Open}==NULL) {/echo not open}

Window Open
/if ${Window[pack${PackNum}].Open} { do this }

Window Lists
${Window[TradeskillWnd].Child[RecipeList].List[1]}
Get the first-column text for the nth item in a list box

${Me.NearestSpawn[1,trigger].Distance}
${Me.NearestSpawn[1,trap].Distance}
${Me.NearestSpawn[1,timer].Distance}
${Me.NearestSpawn[1,untargetable].Distance}

<Label item =&Target_Level&>
   <ScreenID>TargetLevel</ScreenID>
   <EQType>2000</EQType>
   <Font>2</Font>
   <RelativePosition>true</RelativePosition>
   <Location>
      <X>24</X>
      <Y>33</Y>
   </Location>
   <Size>
      <CX>22</CX>
      <CY>14</CY>
   </Size>
   <Text>0</Text>
   <TextColor>
      <R>255</R>
      <G>255</G>
      <B>0</B>
   </TextColor>
   <NoWrap>true</NoWrap>
   <AlignCenter>false</AlignCenter>
   <AlignRight>true</AlignRight>
   <AlignLeft>false</AlignLeft>
</Label>

<EQType>9999</EQType>
<TooltipReference>${variable}</TooltipReference>

Example

<Label item ="BW_Buff0_Duration">
   <ScreenID>Buff0Duration</ScreenID>
   <EQType>9999</EQType>
   <TooltipReference>${Me.Buff1.Duration}</TooltipReference>
   <Font>2</Font>
   <RelativePosition>true</RelativePosition>
   <Location>
      <X>23</X>
      <Y>3</Y>
   </Location>
   <Size>
      <CX>153</CX>
      <CY>14</CY>
   </Size>
   <Text></Text>
   <TextColor>
      <R>255</R>
      <G>255</G>
      <B>255</B>
   </TextColor>
   <NoWrap>true</NoWrap>
   <AlignCenter>false</AlignCenter>
   <AlignRight>false</AlignRight>
</Label>

/loadcfg server_charactername.CFG
Loads a CFG file for the character

/custombind add lootcorpse
/custombind set lootcorpse /multiline ; /target corpse radius 17; /loot
/bind lootcorpse f

AutoExec.CFG Executed on the first pulse
CharSelect.CFG Executed when you are put at character select
server_charactername.CFG Executed when this character enters the world
mapshortname.CFG Executed when you zone into this zone
pluginname-AutoExec.CFG Executed when this plugin is loaded (after its initialization is complete)

Character
tallon_lordsoth.cfg

Maps
oot.cfg, soldungb.cfg
soldunga.cfg
take.cfg

Plugins
MQ2Map-AutoExec.CFG
MQ2ChatWnd-AutoExec.CFG

MQ2Bzsrch -- a bazaar search plug-in
MQ2Chat -- Directs MQ2 output to the regular chat window
MQ2ChatWnd -- Directs MQ2 output to a special chat window (safer)
MQ2EQBugFix -- fix a crash(!) when exiting with no journal entries
MQ2EQIM -- EQIM
MQ2CustomBinds -- Allows you to specify custom commands to execute on a key combination
MQ2FPS -- frame limiter (similar to EQPlayNice)
MQ2IRC -- IRC plugin
MQ2ItemDisplay -- Add extra data to item windows
MQ2Label -- allows custom UI labels
MQ2Map -- enhanced map
MQ2Telnet -- act as a telnet server for macro output

/plugin MQ2Chat unload

/plugin MQ2Chat

/plugin mq2chat
loads the default chat plugin (normal chat window)

/plugin mq2chatwnd unload
unloads the MacroQuest2 chat window

/custombind list | [a dd| delete| clear] name [ -down| -up] | set name [ -down| -up ] command

/custombind list
Lists all of your custom binds names and commands (the key combinations must be set using /bind)

/custombind add name
Will add a new bind name for use here, with /keypress, /bind, etc.

/custombind delete name
Removes a custom bind

/custombind clear name
Clears a specific command for a custom bind. If -up or -down is not specified, defaults to -down.

/custombind set name [-down|-up] command
will set a specific command for a custom bind. If up or down is not specified, defaults to down.

Example usage (NOTE: MQ2's very first bind command is "RANGED" so you do not need to do this, but for example)

/custombind add mybind
/custombind set mybind /ranged
/bind mybind g

To set the real RANGED bind, do "/bind ranged "

/maxfps fg|bg #
Sets the foreground or background framerate

/fps mode [absolute|calculate]
Changes the mode used by /maxfps to absolute or calculate. You can specify the mode, or use /fps mode to toggle between the two.

/fps on|off
Enables or disables the framerate display

/render fg|bg #|~#
Sets the foreground or background rendering rate. This is how many out of n frames MQ2FPS will allow to be drawn. You keep moving full speed, the client responds to mouse or keys, the UI is still drawn... but, the world itself will not be drawn as often.

The use of # will cause MQ2FPS to draw 1 of # frames.
The use of ~# will cause MQ2FPS to draw n - 1 frames, where n is #. Examples

/render bg 3 Draws 1 out of 3 frames /render bg ~3 Draws 2 out of 3 frames

Example

/loadhud bard

In this case, the [bard] section in MQ2HUD.ini could also be [BARD]

The command to load the default HUD specifically is /defaulthud

[Elements]
;The order is TYPE,X,Y,RED,GREEN,BLUE,TEXT
TargetInfo=3,5,35,255,255,255,${Target}
GMIndicator=3,5,45,0,0,255,${Spawn[gm]}
CursorItemName=7,-15,-15,255,255,255,${If[${Cursor.ID},${Cursor},]}
ClickMeForFun=6,-25,-25,255,255,255,${If[!${Cursor.ID},click me,]}

TYPE is currently any combination of the following:

1 - Display in non-full screen mode
2 - Display in full screen mode ("f10 mode")
4 - X,Y is based on cursor location

e.g. 1+2+4=7. 7 means all 3 of the above. 6 means 2 and 4. 3 means 1 and 2. Just add them together. There is no way to end up with a number that could mean two different combinations.

/classhud
Loads a class specific hud. This HUD must have a [hudname] section in MQ2HUD.ini

/defaulthud
Load the default HUD specifically

/hud normal|underui|always

normal will make the HUD display as it would normally on top of UI, not at char select or in "f10 mode"
underui will make the HUD display as normal except UNDER the UI, and not at char select or in "f10 mode"
always will make the HUD display under the UI, at char select, and in "f10 mode"

/loadhud hudname (not case sensitive)
Loads a HUD by the name hudname. This HUD must have a [hudname] section in MQ2HUD.ini

/zonehud
Loads a HUD specific to a zone.This HUD must have a [hudname] section in MQ2HUD.ini

Note: There is currently no command to add or remove these from inside the game. One will probably be added soon. The plugin will automatically re-load the list from the .ini when you modify and save the .ini.

Example

/mapclick lalt+shift /mycommand %i
leftalt+shift right click on a spawn will cause /mycommand to be executed.

/mapfilter Ground
Toggles ground spawns on or off

/mapfilter custom npc range 40 65
Displays all npcs of level range 40 to 65

/mapfilter custom npc range 60 65 radius 50
Displays all npcs of level 60 to 65 within a radius of 50

/mapfilter custom npc range 60 65 radius 50
Displays all npcs of level 60 to 65 within a radius of 50

/mapfilter Trigger color 200 200 0
Sets the color of Triggers

Note: The use of custom is a one time event, it is not persistent.

/maphide "spawnname" [reset]
command to hide spawnname from the map. Hidden spawns are in effect until the mapped spawns are re-generated (such as changing some map filters)

/maphide reset
Re-generates the spawn list.

/maphide npc range 1-39
Hides all spawns level 39 and below

/mapnames normal [%l %R %C] %N /mapnames target [%l %R %C] %N (%x, %y, %z)

${MapSpawn.ID}

Set Enabled=1 and set a valid Port=###

;**********************************************************************
; for use with the telnet server plugin -- mq2telnet
;**********************************************************************
[Telnet Server]
; port = 0 off, else put the port number here
Port=6669
; localonly boolean -- supposedly does a get peer name to compare address
; but you must use the hostname not 127.0.0.1 or localhost when connecting
LocalOnly=0
Welcome=YAY!!! ya made it!!! n00b!
LoginPrompt=login:
PasswordPrompt=password:
[Users]
;username=password
wassup=ubahmanualguy
twister=god

Example

    mkplugin myplugin

This will create a plugin named "MQ2Myplugin"

If you don't know how to use DOS, you should do this:

   Start->Run: c:\mq2\mkplugin myplugin

Replacing c:\mq2\ with the path to where you have the MacroQuest2 source files at.