EQTitan.com - View topic - Modbot basic .ini setup guide (2024)

Joined: Mon Sep 27, 2010 4:54 pm
Posts: 560
Location: UF Client

I started writing this as a guide to help someone, but knowing how confusing modbot can be to setup for the first time, I expanded it and am posting it here for everyone to make use of. This guide covers just getting up and running, more advanced settings can be found at the modbot wiki.

FAQ:
What is Modbot? Modbot is a macro created by many people over several years. For EMU purposes, it is maintained by ptarp.
What is a macro? A macro is one or several text files that MQ2 can execute to have a character do semi-automatic to fully automatic tasks. The files are saved in your \macros\ folder, which is inside your MQ2 main folder.
What do I need to run Modbot? For starters, you need MQ2. You can get it pre-compiled at mqemulator.net. The PEQ version contains only approved plugins. Approved plugins can be found here. If you compile your own version, you need these plugins.
What is a plugin? Plugins are coded .dll files that you can load into MQ2, and will add functionality to MQ2. You can load as many plugins as you need/want, but keep in mind the approved list.
How do I get Modbot? One way is to become a VIP member of the MQ2 forums, done by donating $10+. After becoming VIP, download here in the EMU folder, and save all files. The other way, is to request access from ptarp. While donating to ptarp would be awesome, he doesn't seem to have a paypal set up on the MQ2 site. Instead, consider donating to the server!

Additional resources for making an .ini: (Good to look at after you read, and understand, the rest of the guide)
Examples from other people, sorted by class

http://www.macroquest2.com/wiki/index.php/Script_Examples

-Thank you wakkedup for the links

Joined: Mon Sep 27, 2010 4:54 pm
Posts: 560
Location: UF Client

Before you use Modbot, there are some terms that will be useful to understand (edit: Some things have changed with revisions to ModBot, and I may not have documentation for all changes):
TarCnt

	Quote: How many targets have to be present to automatically cast this spell. If it's a (group) heal, the number of targets need to be under the health percent. (AHTarCnt[#]=2 means 2 characters under the AHClass health percentage) If this is set to 0, it'll never cast this spell without being manually told to.

AHClass

	Quote: Example1: AHClass1=pc group hp65 war30 shd30 pal30 rng40 mnk40 rog40 brd bst40 ber40 shm clr dru wiz mag enc nec Cast on tank classes at 30%, melees at 40% and the rest of the group starting at 65%. Example2: AHClass2=pc group hp80 shm clr dru wiz mag enc nec Cast on casters starting at 80%. Example3: AHClass3=pc group hp70 war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec AHTarCnt3=3 Cast when 3 people in the group go under 70%

ABTarType

	Quote: tank war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec self mypet grp pet cbt idle *Several of these cannot be used with each other. Tank, mypet, and self cannot exist together, each must be used in its own entry. Example1: ABTarType1=tank war shd pal rng mnk rog brd bst ber grp cbt Cast on melees, but only during combat (cbt) Example2: ABTarType2=shd pal rng bst shm clr dru wiz mag enc nec grp cbt idle Cast on people that can cast spells, in or out of combat (cbt idle) Example3: ABTarType3=self cbt Cast this on myself, during combat.

ADTarType -

	Quote: * Designate one target type to cast this debuff on. * Valid target types: o 0 = All mobs o 1 = MA Target only o 2 = All except MA Target o 10 = All mobs before next spell o 11 = MA target only before next spell o 12 = All but MA target before next spell * Priority Debuffs(10, 11, 12) should be placed first most (prior to non-priorities). Meaning - settings of 10, 11, and 12 need to be in top spells slots (ADGem1, ADGem2, etc)

To get Modbot working for the first time, place modbot.mac and all the related .inc files in your \macros\ folder. Start modbot by typing "/mac modbot" in game. When it's finished starting, (it will wink at you) feel free to type "/end".
You will now have a .ini file in your \macros\ folder, named mb_charname.ini. Open that up (I recommend using Notepad++), and you're ready to start modifying it to your needs.

Some settings you can leave as FALSE in the .ini, and temporarily change to TRUE in game, by typing "/bc letsroll". These settings are: DoCures, DoBuffs, DoHeals, DoMelee, DoEvents, DoDebuffs. Leaving them as FALSE in the .ini keeps toons from acting right as the macro starts up. This resets each time you zone, so the macro doesn't start attacking mobs right after zoning.

	Quote: [Settings] DoMelee=FALSE (can leave as FALSE) DoHeals=FALSE (can leave as FALSE) DoBuffs=FALSE (can leave as FALSE) DoDebuffs=FALSE (can leave as FALSE) DoEvents=FALSE (can leave as FALSE) DoCures=FALSE (can leave as FALSE) DoPull=FALSE/TRUE (Uses the AdvPull section) DoPet=FALSE/TRUE (Cast pet? Set up in AdvBuff section) DoSit=FALSE/TRUE (Sit down to med?) DoLoot=FALSE/TRUE (Loot when no mobs are nearby? Uses loot.ini file) DoFW=FALSE (Cast food/water spells?) DoForage=FALSE (Forage? Uses forage.ini file) ForageIni=forage.ini DoAfk=FALSE (Respond with AfkMessage?) DoMount=FALSE (Cast mount item?) MountCast= (ex: Black Silken Bridle|item) MasterList=${NetBots.Client} (Who is allowed to control the bot? Individual names can be here, seperated with a comma.) TankName=Swordnshield (Main Assist) Radius=100 SitAggroRadiusCheck=75 AfkMessage=Not now, thanks DeathSlot=FALSE (Camp to desktop to save rez timer?) FollowDistance=20 ("/bc follow" distance) FollowStick=20 hold uw ("/bc follow close" setting. Uses mq2moveutils's sticklogic) PetAggro=FALSE (Pet taunt) PetAssist=1 PetShrink=TRUE PetShrinkSpell=pet shrink spell name|gem# (Tiny Companion|gem1)

	Quote: [Melee] OffTank=FALSE/TRUE (True=assist TankName once, then stay on that until it dies. False=change target when TankName changes) ACLeash=50 (Mob's distance from bot to start engaging) ACAssistPct=98 (Assist TankName at this percent) ACManaPct=40 (Stop attacking and sit down when mana hits this percent) ACMeleeCmd=/melee plugin=1 (suggested to leave this as is)

	Quote: [AdvHeal] - Important! Put your most vital heals first. Fast casting save-your-hide heals. AHCount=3 (How many heal spells in this section) AHCheckTime=2 AHHealOOBC=TRUE (Heal people that are in group, but not in your EQBC channel?) AHHealMode=0|0|12 AHInterruptLevel=2 (AHSpell that can be interrupted for a lower number spell. 2=AHSpell1 will never be interrupted, but AHSpell2 can be) AHClassPriority=enc,wiz,mag,nec,clr,dru,shm,pal,shd,war,bst,rng,ber,rog,brd,mnk AHAllowDismount=TRUE If you put AHCount=1, you will get an entry that looks like this: Quote: AHDurMod1=0 AHSpellMinMana1=0 AHTarCnt1=0 AHClass1=pc pet group hp0 war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec tnt mypet self AHPreCondition1=TRUE Several of the AHClass1 settings cannot go together. Self, tnt, and mypet need their own entry to work. Self means only cast on the bot, mypet is obvious, and tnt is TankName's target. tnt is used for Lifetap spells. Example: Quote: AHGem1=3 (Do not put gem3, valid entries are 'gem number', alt, ability, item, script, potionbelt) AHSpell1=Superior Healing (Spell/ability/item name) AHDurMod1=0 (For HoT spells) AHSpellMinMana1=10 (minimum mana percentage to be allowed to cast this spell) AHTarCnt1=1 AHAnnounce1=/g (Optional, any chat channel works) AHSpellAlias1=Heal (Use this to manually call this spell. /bc cast Heal, or /bc BotName cast Heal, or /bc cast Heal BleedingToon) AHClass1=pc group hp65 war30 shd30 pal30 rng40 mnk40 rog40 brd bst40 ber40 shm clr dru wiz mag enc nec AHPreCondition1=TRUE (Must resolve as TRUE to be casted)

	Quote: [AdvDebuff] - Important! Put your most vital debuffs first! Mezzes and slows should go first. ADCount=1 ADMobMax=10 (20 or 30 is more than enough, a lower setting uses less memory and takes less time to cycle) ADCheckTime=2 ADAggroOnly=0 ADHold=0|1|1| 1=on 0=off|Debuff spell #|Time to wait for debuff| Setting ADCount= to 1 will get you the following entry: Quote: ADDurMod1=0 ADSpellMinMana1=0 ADSpellRecast1=0 ADSpellDelay1=0 ADTarCnt1=0 ADTarType1=0 ADTarBegHP1=0 ADTarEndHP1=0 ADUseHoTT1=0 ADPreCondition5=TRUE Example: Quote: ADGem1=2 (Do not put gem2, valid entries are 'gem number', alt, ability, item, script, potionbelt) ADSpell1=Drones of Doom (Spell/ability/item name) ADSpellAlias1=Drones (manual calling, /bc cast Drones, /bc cast Drones %t) ADDurMod1=0 (Ext enhancement %, valid entries are the percent number (5, 20) ADSpellMinMana1=45 (minimum mana required to be allowed to cast) ADSpellRecast1=0 (Recast if spell is resisted) ADSpellDelay1=0 (Seconds between casts, useful for nukes) ADTarCnt1=1 (0=manual call only, 1=Single target spell, 2=2 mobs in aggro radius, etc) ADTarType1=0 ADTarBegHP1=98 (Mob's health to start casting) ADTarEndHP1=30 (Stop casting at this percent of mob's health) ADUseHoTT1=0 (Checks mob for raid or group member. If raid/group member is not on HoTT, mob is skipped) ADSpellCastonResist1= (SpellAlias to cast if this spell is resisted. Useful for casting malo/tash after slow/mez is resisted. ADSpellRecast1= must be set to 1 for this to work.) ADPreCondition1=TRUE

	Quote: [AdvBuff] ABCount=1 (Number of Buffs) ABMobMax=18 (Max number of toons to keep track of) ABCheckTime=8 Setting ABCount= to 1 will get you the following entry. Some TarTypes won't work together, take out the ones you don't need. Quote: ABDurMod1=0 ABSpellMinMana1=0 ABTarCnt1=0 ABTarType1=tank war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec self mypet grp pet cbt idle ABRecast1=FALSE ABPreCondition1=TRUE Example: Quote: ABGem1=6 (Valid entries are 'gem number', alt, ability, item, script, potionbelt) ABSpell1=Spirit of the Jaguar ABSpellAlias1=Proc (/bc cast Proc, /bc cast Proc MeleeName, /bc cast Proc grp (cast on the entire group)) ABDurMod1=30 (Extended percent) ABSpellMinMana1=50 (Minimum mana percent to be allowed to cast) ABTarCnt1=1 (0=manual call only, 1=single target buff, 2+=group buff) ABTarType1=tank war shd pal rng mnk rog brd bst ber grp cbt (Cast only on the TankName, and only during combat) ABRecast1=FALSE ABPreCondition1=TRUE Summoning pet example: (DoPet must be TRUE to work) Quote: ABGem2=8 ABSpell2=Monster Summoning ABSpellMinMana2=30 ABTarType2=petspell ABTarCnt2=1 ABDurMod2=0 ABRecast2=0 ABPreCondition2=TRUE Bard Song examples: Quote: ABGem5=4 ABSpell5=Rizlona's Call of Flame ABSpellAlias5=ohaste (Add to the twist list by using /bc (name optional) sing ohaste) ABDurMod5=0 ABSpellMinMana5=0 ABTarCnt5=0 (Bard songs should always have the TarCnt for buffs set to 0) ABTarType5=self brd cbt (Only sing this song while in Combat mode) ABRecast5=FALSE ABPreCondition5=TRUE ABSpellFoci5= ABAnnounce5= ABSpellIcon5= ABGem1=1 ABSpell1=Selo's Accelerating Chorus ABSpellAlias1=selos ABDurMod1=0 ABSpellMinMana1=0 ABTarCnt1=0 ABTarType1=self brd idle (Only sing this song while not meleeing) ABRecast1=FALSE ABPreCondition1=TRUE ABSpellFoci1= ABAnnounce1= ABSpellIcon1=

There! You should now have a very basic working .ini file. Some helpful commands to know in game:
/bc letsroll - Turns DoMelee, DoBuffs, DoDebuffs, DoEvents, DoHeals to TRUE
/bc holdup - Turns DoMelee, DoBuffs, DoDebuffs, DoEvents, DoHeals to FALSE
/bc follow - Follows using MQ2AdvPath, which records your path, then follows it as closely as it can. Not perfect, and will get stuck behind trees.
/bc follow close - Uses MQ2MoveUtils sticklogic to follow. Bots will get closer, and is generally more useful when underwater.
/bc makecamp - Sets current location as camp location. Bots will return to location after killing a mob.
/bc stop - Turns off follow mode and makecamp mode.
/bc cast SpellAlias - Calls a SpellAlias to be cast. Can be used with several formats, i.e. /bc BotName cast SpellAlias, /bc cast SpellAlias TargetName, /bc cast SpellAlias %t
/bc sing SpellAlias - Adds song to the Twist list.
/bc sung SpellAlias - Removes song from the Twist list.

All /bc commands can be used on the Bot's own screen, and only for that bot, if you use /mb in place of /bc, i.e. /mb stop, to just stop one bot from following.

Advanced commands:
/varset - Changes a setting in game only. Useful to change who the tank is on the fly, or change if a spell is manual cast or auto cast. Can also be used to raise or lower a heal spell's HP threshold. Works well when used with /bca or /bcaa
Examples:
/varset TankName Lolpaladin
/varset ABTarCnt[1] 1
/varset AHClass[1] pc group hp65 war shd pal (Very useful to raise/lower HP% when CH is cast. Can help to conserve mana)
/varset AHClass[1] pc group hp55 war shd pal
/bc ClericName //varset AHClass[1] pc group hp45 war shd pal

Joined: Sun Aug 08, 2010 11:17 am
Posts: 455

Thanks for this Keichii. Sorry for the edit above, but mostly looks good at the first glance. Most of this info is in the wiki for modbot, but maybe it's the "headache" inducing formatting that makes it so impossible for some to read.. lol.

And no, I didn't set up a regular paypal on the macroquest2.com site because I was really terrible at donating any more to the devs there.. I made my help with modbot my way of giving back to the community.. If there's an overriding urge to help me out, it's OK to PM me and ask for it. However, as much as it would definately help, it's definately not required.
Donating to EQTitan is a worthy cause also..

Anyways, always good to see someone willing to help. Thanks.

Joined: Thu Jul 01, 2010 4:43 pm
Posts: 323

Joined: Mon Sep 27, 2010 4:54 pm
Posts: 560
Location: UF Client

Thanks for the support I think the problem with the wiki, is that it just gives you all the info, without explaining how to use it. Much like a having a diagram of a motor shows you all the parts, but not how to assemble it. And who wouldn't be overwhelmed when told to put it together with just a picture?

I'm usually always willing to help people out with setting up Modbot. If you are having issues, feel free to PM me your .ini and I'll do my best to suggest fixes or changes.

Joined: Sun Aug 08, 2010 11:17 am
Posts: 455

	keichii wrote: Thanks for the support I think the problem with the wiki, is that it just gives you all the info, without explaining how to use it. Much like a having a diagram of a motor shows you all the parts, but not how to assemble it. And who wouldn't be overwhelmed when told to put it together with just a picture? I'm usually always willing to help people out with setting up Modbot. If you are having issues, feel free to PM me your .ini and I'll do my best to suggest fixes or changes.

I think one of the biggest issues with the modbot wiki is it's too big.. There's enough info there that a lot of people give up before they get through it and just decide to barge in head first... Sometimes that works, sometimes not...

That said, I'm usually willing to help with .ini setup and what-not for anyone that's honestly looked at the wiki and made an attempt to understand.. However, there's also some plugins that have issues right now as well depending on where you get them.. So, at times if there's functionaliy issues I hope everyone feels free to post them in the modbot thread for everyone.

Joined: Thu Jul 01, 2010 4:43 pm
Posts: 323

	Code: [Settings] DoMelee=FALSE DoHeals=TRUE DoBuffs=true DoDebuffs=true DoEvents=true DoCures=true DoPull=FALSE DoPet=FALSE DoSit=TRUE DoLoot=FALSE DoFW=TRUE DoForage=FALSE DoAfk=FALSE DoMount=FALSE DoAura=false AuraCast= MasterList=${NetBots.Client} TankName=Hust,Sloppy ExcludeList= Radius=100 SitAggroRadiusCheck=75 AfkMessage=Not now, thanks DeathSlot=FALSE FollowDistance=20 FollowStick=20 hold uw PetCast= PetAggro=FALSE PetAssist=0 ForageIni=forage.ini SummonFood= SummonDrink= PetShrink=false [Melee] OffTank=FALSE ACLeash=50 ACAssistPct=95 ACManaPct=30 ACAnnounce=/bc ACMeleeCmd=/melee plugin=1 [AdvHeal] AHCount=6 AHCheckTime=0 AHHealOOBC=FALSE AHAllowDismount=TRUE AHGem1=6 AHSpell1=Divine Barrier AHDurMod1=0 AHSpellMinMana1=10 AHSpellAlias1=da AHAnnounce1=/bca //popop ${Me} Divine Barrier AHTarCnt1=1 AHClass1=pc hp15 clr AHPreCondition1=TRUE AHGem2=alt AHSpell2=Divine Arbitration AHDurMod2=0 AHSpellMinMana2=0 AHSpellAlias2=divarb AHAnnounce2=/bca //popup Divine Arbitration << %t >> AHTarCnt2=1 AHClass2=pc group hp35 war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec AHPreCondition2=TRUE AHGem3=2 AHSpell3=Supernal Remedy AHDurMod3=0 AHSpellMinMana3=0 AHSpellAlias3=remedy AHAnnounce3=/bca //popup Healing ... << %t >> AHTarCnt3=1 AHClass3=pc group hp70 war25 shd25 pal25 rng mnk rog brd bst ber shm clr dru wiz mag enc nec AHPreCondition3=TRUE AHGem4=3 AHSpell4=Word of Replenishment AHDurMod4=0 AHSpellMinMana4=0 AHSpellAlias4=grpheal AHAnnounce4=/bca //popup Group Healing ${Me} AHTarCnt4=3 AHClass4=pc group hp60 war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec AHPreCondition4=TRUE AHGem5=alt AHSpell5=Ethereal Elixir AHDurMod5=0 AHSpellMinMana5=0 AHSpellAlias5=gregen AHAnnounce4=/bca //popup Group Healing ${Me} AHTarCnt5=3 AHClass5=pc group hp70 war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec AHPreCondition5=TRUE AHGem6=1 AHSpell6=Complete Heal AHDurMod6=0 AHSpellMinMana6=0 AHSpellAlias6=CH AHAnnounce6=/bc CH inc for << %t >> AHTarCnt6=1 AHClass6=pc hp81 war shd86 pal86 AHHealMode=0|0|12 AHInterruptLevel=2 AHClassPriority=enc,wiz,mag,nec,clr,dru,shm,pal,shd,war,bst,rng,ber,rog,brd,mnk AHPreCondition6=TRUE [AdvDebuff] ADCount=0 ADMobMax=20 ADCheckTime=2 ADAggroOnly=0 ADHold=0|1|1| 1=on 0=off|Debuff spell #|Time to wait for debuff| [AdvBuff] ABCount=4 ABMobMax=30 ABCheckTime=8 ABProactive=TRUE ABGem1=8 ABSpell1=Blessed armor of the risen ABDurMod1=0 ABSpellAlias1=selfHP ABAnnounce1=/bc ABSpellMinMana1=0 ABTarCnt1=1 ABTarType1=self ABRecast1=FALSE ABPreCondition1=TRUE ABGem2=9 ABSpell2=Bulwark of Vie ABDurMod2=0 ABSpellAlias2=vie ABAnnounce2=/bc Casting Bulwark Vie on %t ABSpellMinMana2=10 ABTarCnt2=1 ABTarType2=self Tank cbt idle ABRecast2=True ABPreCondition2=TRUE ABGem3=5 ABSpell3=Yaulp VI ABDurMod3=0 ABSpellMinMana3=1 ABTarCnt3=1 ABTarType3=self idle ABRecast3=FALSE ABPreCondition3=TRUE ABDurMod4=0 ABSpellMinMana4=0 ABTarCnt4=0 ABTarType4=tank war shd pal rng mnk rog brd bst ber shm clr dru wiz mag enc nec self mypet grp pet cbt idle ABRecast4=FALSE ABPreCondition4=TRUE [AdvEvent] AECount=1 AECheckTime=8 AEGem1=5 AESpell1=Yaulp AEDurMod1=0 AEDelay1=0 AEEventMinMana1=1 AEEventMinHP1=0 AEMinMana1=1 AEMaxMana1=99 AEMinHP1=0 AEMaxHP1=0 AETarType1=self AEAnnounce1=/bc Yaulping .... AETarCnt1=1 [AdvPull] APCheckTimer=0 APRadius=100 APSpell= APRangedMod=0 APMobMax=1 APScript=AdvPull APCheckTime=0 APRetries=1 [AdvCure] AQCount=1 AQCheckTime=8 AQGem1=alt AQSpell1=Radiant Cure AQSpellCntr1=0 AQSpellCureType1=Poisoned Diseased Cursed All AQSpellMinMana1=0 AQSpellRecast1=0 AQTarCnt1=1 AQTarType1=cbt AQSpellAlias1=rc

the above is my cleric .ini file
I'm trying to make my cleric cast yaulp VI when mana is below 100% above setting will keep casting Yaulp VI none stop
For the life of me I cant find any reference to do so spend like 3 hours on this need little help
And also I'm having trouble casting Bulwark Vie on myself, it'll only buff the Tank
Thanks advance

Joined: Mon Sep 27, 2010 4:54 pm
Posts: 560
Location: UF Client

The Bulwark of Vie part is easy, you can't have Tank and Self in the same buff. They are exclusive, and would each need their own buff entry. So your choices are to either make 2 entries, or change "self Tank cbt idle" to "clr war shd pal". That will buff any cleric and tankclass that you have in your group, which may or may not be what you're looking for anyway.

For Yaulp, you have two entries for casting Yaulp. One is in the AdvBuff section, the other in the AdvEvent section. If it's only in the AdvEvent section, it will still cast as a buff, and you can still select TarTypes as self, cbt and idle, depending on what you want. It has the minmana and maxmana settings there too, so you can tell it not to cast at 100, but at 99. Also, you need to change which Yaulp you want it to cast.

To set Yaulp up in the AdvBuff section and for it to pay attention to how much mana you have, you'd have to set it up as a 'script.' Script would be put in place of a gem number, and you'd need a spell alias. At the end of the .ini, you'd put in [Script-SpellAlias], and would look something like this: (note, this is not tested, just modified from an example of casting Canni from the Modbot Class Ini Examples.)

	Code: [Script-Yaulp] Commands=3 C1=/if (!{Me.Gem[Yaulp VI]}) /memorize ''Yaulp VI|gem7'' C2=/if ({Cast.Ready} && !{Cast.Ready[Yaulp VI|gem7]}) /delay 1s {Cast.Ready[Yaulp VI|gem7]} C3=/if ({Me.CombatState.NotEqual[Resting]} && !{Me.Mount.ID} && !{Me.Moving} && {Cast.Ready[Yaulp VI|gem7]} && {Me.PctMana}<99) /multiline ; /echo casting;/call MQ2Cast ''Yaulp VI'' gem7

edit: Forgot to add the mana check - {Me.PctMana}<99

Joined: Sun Dec 05, 2010 4:13 pm
Posts: 897
Location: Phoenix, AZ, originally from Oggok, Norrath

	keichii wrote: The Bulwark of Vie part is easy, you can't have Tank and Self in the same buff. They are exclusive, and would each need their own buff entry. So your choices are to either make 2 entries, or change "self Tank cbt idle" to "clr war shd pal". That will buff any cleric and tankclass that you have in your group, which may or may not be what you're looking for anyway.

Wow, that's amazing that I overlook one thing and thats the whole reason why none of my buffs have been working. Thanks, keichii!

:edit: Alright, now that I got buffs working for groupmates, is there something special to put in the line to have it watch buffs outside of group, like for my 2nd group's buffs?

Joined: Mon Sep 27, 2010 4:54 pm
Posts: 560
Location: UF Client