Latest revision as of 06:01, 31 October 2019

OgreMCP

Tab Summary

MCP = Master Control Panel. OgreMCP is used to pass commands via the uplink. To load OgreMCP, type "ogre MCP" and a new window appears.

Note: Nearly all of these buttons are sending commands through the uplink, and will affect ALL sessions connected.

With Version 15, OgreMCP was completely redesigned. It is now one of the most advanced UI windows in the Ogre collection. It has taken customization to the next level.

Types of buttons

There are four different types of buttons.

• Setup button - When you click the setup button a new window appears that allows you to customize some of the options about the MCP itself. Such as the height/width of the window, of the static window, of the buttons, and even the spacing between the buttons. Generally speaking, I'd recommend keeping the defaults.
• Frame changers - The first 4 buttons on the left most side. By default they are labeled Combat, Zones, Objects, and Other. You can rename these to anything you want. They simply change the "Frames" (or sets of buttons) on the right hand side.
• Static buttons - These are buttons that never move. This is anything on the left side. By default, this is 18 buttons. Note: Four of these buttons are the frame changers. The other buttons can hold any command.
• Frame buttons - These buttons are specific to each frame and are visible or hidden depending on which "Frame changer" is selected. By default there are 24 buttons. These buttons can hold any command.

About Commands

What is a command?

The MCP is made up of two types of files. Visual files, and command files. The visual files simply show the buttons and have a (not visible) "command" attached to it. When this button is clicked, is the command is run.

Where do I get commands?

There are two command files. One that is provided and updated by me. The other is one you can add custom commands too. The reason there are two, is so when I update the master command file, it doesn't effect yours.

How do I make/use/change/ buttons?

You simply right click a button and an edit window appears.

[Need picture of right click edit window]

From here, you select the command. If you're not sure what the command does, select it and read the description. If it requires parameters, be sure you enter them in. Under the select command is a custom button name, so you can name the button something that will make sense to you. When you are ready to save it, press the Apply button.

Default Configuration

This is just a brief description of the default setup of the MCP. For a list of commands and customization options see the commands section.

Title Bar Buttons

• Setup button -
• ForWho Button - *When MCP loads, there is now a new window. Labeled 'For Who'.
  • This will modify MCP buttons in real time. There's two sections.
    • ForWhere (OgreConsole and IRC)
      • If NONE of these are selected, then it uses whatever kind of button it was. For example: If you have a "Cast" button, that would use OgreConsole. If you have a "OgreIRC" button, that will use IRC.
      • If you select OgreConsole, then ALL buttons will be sent to OgreConsole, including those that are set as 'OgreIRC'.
      • Likewise, if you select IRC, all OgreConsole buttons will be sent to IRC. Note: IRC must be set up prior or these commands will be sent to the avoid. IRC is generally used for bot raiding.
    • ForWho
      • Any button where a ForWho is possible, and it is not specified, will be converted based on your selection. For example:
        • MCP -> Jump. If you do not specify the ForWho (leave it blank), the default is all. However, is you select something in the list, such as [x] Mages only, it will then only apply to mages. You could then select Priests only, and press it again, and only priests would jump.
      • There is a [x] Multi-select option, that lets you select more than one option. You need to be smart about this, as you can make impossible scenarios. Such as: [x] Mage only and [x] Priest only. This is an AND, not an OR. If you selected both, it means someone would need to be a MAGE and a PRIEST, which is impossible, so no one would listen to your button. Multi-select isn't used often, but cases where it is used, are usually for a specific group and a specific class. Such as: [x] G3 Only and [x] Mages only. This means Group 3 and Mages only will listen to the command.

• [x] IRC Me Only
  • This will be phased out, as using [x] OgreConsole will do the same thing
• When you hide (alt+~) MCP, it will hide the ForWho window also. When you unhide MCP (alt+~), if the ForWho window was visible before it was hidden, it will be visible again. If it was hidden before, it will remain hidden.
• This window is HIDDEN by default. You can click the [ForWho] button (beside the [Setup] button) on the MCP to show it. If you wish for it to always be shown on load, inside of [Setup] is a checkbox that will have it show on load.
• If you wish to specifically invoke this new behaviour, you can do so via command line. Using the keyword "auto" in place of any forwho, and adding a -cfw <ForWhoHere> BEFORE any commands. Example: !c -cfw g1, would result in all commands on that same line, having a default of 'g1' if it's not supplied.
• In order to complete this change, I had to manually change every single OgreConsole/MCP command that exists. That means every single button. It's possible I made a mistake/typo. If ANY button that was working prior, is not working now, please right click it (to edit it), then take a picture and send it to me. Then I can reproduce the button and fix it. Please include a picture of your ForWho UI also, so I know what you have checked.
• Enable Swapping - Will allow swapping of buttons to different locations on the MCP. Check Enable, Select the MCP button you wish to move, then Select the destination MCP Button. DONT FORGET TO TURN OFF
• IRC Me Only - Will change all IRC related buttons from !c All to !c Me. Allowing you to control only your local CPUs using IRC Commands without Un-auth'ing someone.

Main Buttons (Left side)

• There are multiple "Tabs". Clicking each of these changes which buttons appear.
  • Combat
  • Zones
  • Objects
  • Other
  • 5
  • 6
  • 7
  • 8

• There are 24 static buttons (includes the tabs from above). These never disappear, regardless of which "tab" you are on.
  • Lets go - Defaulted on when the bot loads. This is used to remove the following flags: Hold up, No move, Do not move, Camp spot, Fiegn death. You can also use a chat command of "lets go" in a tell/group/raid to activate this command. -Queued command. Happens when the bot finishes what it is doing.
  • Hold up - Turns OFF auto follow. -Forced command. This happens immediately, regardless if the bot is doing other things.
  • "OFollow" - OgreFollow
  • "OFol-Dft" - OgreFollow Defaults
  • "OFol-++" - Increases follow range (Puts more distance between you and the follow player)
  • "OFol ---" - Decreases follow range (Puts less distance between you and the follow player)
  • CS-JO-JI - CampSpot (Default), Joust Off (default), and Joust In. This is used to set all your toons to a campspot of where they are, but allow melee to fight. Gives easy access to joust out if needed.
  • Jst-Out / Jst-In / Jst-Off - See Jousting below.
  • Pause - Presses the "pause" button on the bot.
  • Resume - Resumes the bot (counter to Pausing it).

Jousting

• "Jousting" just temporary disables campspot(so move into melee range is then allowed). When Jousting is turned back on, it re-actives campspot (thus disabling move into melee range).
• USAGE:
  • Note: Move to Area must be checked on the settings tab of the character for the campspot to work.
  • Turn Campspot on
  • Use "Jst off" (Joust Off) and input anyone you do not want to be jousting (such as "casters", or "healers"). [Optional step]
  • When you wish to allow your jousters to melee, hit "Joust in"
  • When you wish your jousters to get out, hit "Joust out"
  • NOTE Currently Jousting only supports people who use "move into melee range" as their way of "Jousting in".
• Any Joust command will do nothing if you do not have Campspot enabled.
• Joust commands are added to the main queue. Meaning when the bot is finished doing it's current task, it will go through the queued commands. You can override a Joust in command with a Joust out command, assuming the bot isn't doing anything else (such as a bard in the middle of casting a spell while they are running).
• Other uses: You are fighting a mob that expodes, or you need EVERYONE to run very far away at a certain point in the fight. Go to the "safe spot" and turn campspot on for everyone, then hit "Joust in". This temporary turns off campspot. You can then move your toons any where you want. When the mob is going to explode, hit "Joust out" and they will run to your camp spot.

Combat Tab

• CmpSpot - Forces people to stay within a certain distance of a pre-designed spot. (Useful for knockbacks etc) (NOTE: Requires "Move to Area" enabled on Ogrebot)
  • Input box #1 - Camp spot for who? - Who will be listening to this command. Default is all.
  • Input box #2 - Distance - Min distance <space> max distance.
    • Min distance - How close do you stay to this spot. Default is 2 (almost right on top of it).
    • Max distance - Only move to this distance if you are within this close to it (don't need any zone-wide running). Default is 75, which is quite far away.
• CS-Dft - CampSpot Default. Equal to pressing CampSpot and pressing <Enter> twice.
• Sanct - Sanctuary - Queues up the spell Sanctuary for templars (if it's ready).
• DivineR - Casts Divine Recovery if it's available (Cleric AA).
• BDance - Makes you break dance.. err.. Will cast Blade Dance if it is available (Bard AA).
• Imm-Res - Immaculate Revival (Cleric end line ability).
  • If any priest or fighter is dead, the ability is cast.
  • If any 2 people are dead, the ability is cast.
    • If you wish to change the # of people dead to cast, you can pass it 1 parameter(in OgreMCPXML). The default is 2 and doesn't need to be specified.
• Otherwise it will not cast.

(Changed Sanctuary, Blade Dance, Divine Recovery over to the new CastFromUplink function. )

• Verdict - If you can cast Verdict, you will.
• Channel - If you can cast Channel, you will.
• C-Focus - If you can cast Channeled Focus, you will.
• F-Follow - ...
• Pet Off - Back's your pet off.
• Evac - If you can cast evac, you will.

• Come2Me - Move to the player giving the command. The following can be a prefix for the come to me command. Also works as a chat command as follows.
  • Note: The player giving the command must be authorized (in eq2chars.inc).
  • Note: You need Move To Area selected for these to work, and a target (can be yourself).
  • "come to me" - Everyone.
  • "melee come to me" - Fighters/scouts only.
  • "mages come to me" or "casters come to me" - Mages only.
  • "priests come to me" or "healers come to me" - Priests only.
  • "g# come to me" - Anyone in a raid in that group #.
  • "toonname come to me" - Anyone with that toon name, such as "Kannkor come to me".
• Coe-Sht - If you can cast Coercive Shout, you will.
• Res - Counter to "Stop Res" below. Turns Resing on ONLY if it was turned off via Stop Res.
• Stop Res - Temporarly turns resing off. Use "Res" to re-enable.
• Revive - Revive - WARNING! If there are multiple options, it does NOT choose the one you have highlighted. I haven't spent the time to determine which one it does.
• 6

• Assist - "Dynamic Assist" - Change assists on-the-fly. Note: Auto assist MUST be checked or this option does nothing.
  • Input box #1: Who should be assisting? Who will listen to this command.
  • Input box #2: Who do you want to assist?
  • Example usage: Input box#1: Mages, Input Box #2: Kannkor. This would make all mages assist Kannkor. I could then do: Input Box#1: Melee, Input box #2: Roknnak. All melee would be assisting Roknnak (while all casters are still assisting Kannkor).
  • Note: Who should be assisting can take "g1, g2, g3, g4" as options. For example, lets say you're in g1 and your botted toon is in g4, you could do assist -> g4 -> tank_in_g4_name.
  • Note: Putting a blank option in Input Box #2 clears this option for EVERYONE.
• WarMyth - Warlock Myth toggle.
• TShell - If you can cast Tortoise Shell (AOE blocker), you will.
• NoMove - "Do not move" - temporarily disables move into melee range, move behind, and auto follow. Use "Lets go" to clear.
• No Target - Clears your target. Useful to stop many various movements.
• Test - Test used by Kannkor. You can ignore this (just runs a test file that you don't have).

Zones Tab

(Zones - Has zone specific stuff. Mostly HUDs.

• Exeter - When fighting Maldonous (sp?) Exeter in Palace of Ferzhul, every 20% all 6 people in the group must click the flames. This does that for you. Click once every time he goes away.
• ScavMid - ...
• Trak hud - On-screen HUD that puts the name/distance of the closest PC and closest special to you. I use it when I kill Trak. (Toggle on off)
• Turt hud - ...
• 5
• InfoOn - Toggles information about a Named NPC or npc, and distance from your cleric/shaman/druid in your group.

• Orb-Yel - Orb clickers for Penda/Kendis
• Orb-Blck - Orb clickers for Penda/Kendis
• Orb-Purp - Orb clickers for Penda/Kendis
• 4
• 5
• 6

• Orb-Blue - Orb clickers for Penda/Kendis
• Orb-Grn - Orb clickers for Penda/Kendis
• Orb-Red - Orb clickers for Penda/Kendis
• 4
• 5
• 6

• Ld Doljon - Lord Bob, Loads it on all sessions.
• End Doljon - Lord Bob, Ends it on all sessions.
• Dol-To-Me - Lord Bob, Jump - Tells everyone to get to the pad your toon is closest too.
  • For example: When he puts 1 pad acid, if your tank is NOT on it, hit the button, everyone will come to you (they jump). If your tank is ON the acid pad, jump to a different one and hit it.
• 4
• 5
• 6

Objects

(Objects - Will have any button that controls objects commonly used out of combat. Such as repair gear, get/use the flag, hail, etc.)

• Repair - Repair your guild if you are:
  • Near a Guild Mender
  • Near a Mender
  • Near a Mender bot
  • There are a few others that are hard coded in, like the one in VP etc. If you have any other spots you want coded in let me know.
• Get Flag - If near a Guild Strategist will hail and get a flag.
• Use Flag - If near a Guild Strategist will hail and send you to the rally point.
• Call GH - Calls to your Guild Hall.
• Call Home - Calls to your home.
• ClsWdw - Close top window. This hits ESC on all your computers.

• Fly-Up - Will hold/release "Home" (to fly up on a flying mount).
• Fly-Dn - Will hold/release "End" (to fly Down on a flying mount).
• Mount - Toggles mount.
• 4
• 5
• 6

• Zone - Clicks on most zones to instances.
• Door 1 - When the option comes up of which zone to zone into, use this for option 1.
• Door 2 - When the option comes up of which zone to zone into, use this for option 2.
• Door X - When the option comes up of which zone to zone into, use this for option for an input box to enter which door number.
• Special - Double click the nearest "Special" (as per radar) to everyone.
• Run/Walk - Toggles run/walk

• AReward - Accept Reward. When you finish a quest and the reward window pops up, this will accept it. Note: Make sure you can accept the reward, and it's not a choice reward.
• Hail - Everyone will assist you, and hail your target
• Opt 1-4 - While talking to an NPC (the bubble windows) everyone will do which conversation option as you press. Useful for shard quests.

Other Tab

• Profile - ...
• Main - Toggles opens/minimized the "main" window of the bot.
• Zone Rst - Allows you to reset instance timers. The Zones window must be open on the main character in order for this to work.
• ResStone - Casts a res stone (works for all priests).
• TellWd - If the tell window has been used, it re-opens it.
• Jump - Sends a Jump command through the uplink.

• 1
• 2
• 3
• Disband - Drop group.
• Auto Run - Toggle Auto run.
• 6

• Load Bot - Loads the bot.
• Dev Bot - Loads the development version of the bot.
• End Bot - Ends the bot.
• Camp - Camps everyone to desktop.
• 5
• 6

• Load EXT - Load ISXOGRE
• Unload EXT - Unload ISXOGRE
• List IPs - Lists all the computers in the uplink.
• Connect - Connects to the computers listed in EQ2Chars.xml
• Disco - Disconnects to the computers listed in EQ2Chars.xml
• 6

List of commands

A - C

D - J

   primalz
   eq2bob
   -r
   saha
   -inviter
   saha
   blowupdoll 

   Kannkor group invites primalz
   Kannkor group invites eq2bob
   Kannkor raid invites saha
   Saha group invites blowupdoll
   The "-inviter saha" told the script to change the inviting over to saha,
   instead of Kannkor. Which is why it started inviting on saha. 

L - P

R - Z

MCP Customization and You

The out of the box settings work for a majority of users. Most people, if they need to make changes will only add and remove buttons. Before making any file changes make sure you backup and understand the changes you are making.

Files

MCP Files

• bak.MCPCommandsCustom.xml
  • Backup source of MCP Custom command file. Used for patch purposes
• LoadOgreMCP.iss
  • MCP Script. Do not screw with it if you know whats good for you.
• MCPCommands.xml
  • The complete default command list and parameters of MCP.
  • DO NOT make changes to this file. Use the MCPCommandsCustom.xml file to add any changes you may wish.
• MCPCommandsCustom.xml
  • MCP Custom command file. Use this file to add any functionality to your MCP buttons.
  • Consult the MCPCommands.xml file for file structure.
• MCPCustomSettings.xml
  • edit to make manual button and layout changes
• MCPDefaultSettings.xml
  • source file for MCP button layout. Make all changes to MCCPustomSettings.xml not this file

Functions

Examples

Adding an uplink radio button toggle

Let's say we want to change our brigand named Robin from sitting behind the mob to move to the front for one of his special abilities using a nice simple button rather than getting all clicky.

1st right click the MCP button.

Select Uplinkoption_change in the drop down list to the right of select command.

In the text box type a name for your button.

In the additional parameter section first add the player this button apply to, Robin in this case, but you can also specify all, melee, mage or any of the other general categories

Next add the parameter that will be changing.

If you dont know what the option is you need to change you have a couple methods of finding out open UplinkcontrollerXML.xml in your text editor.

Use the search function or scroll though the file to find the text of the option, in this case Move in Front of mob.

<checkbox name='checkbox_settings_moveinfront' template='chkbox'>
  <X>165</X>
  <Y>110</Y>
  <Text>Move In Front of mob</Text>{highlight}
  <OnLeftClick>
    This:RightClick
    This.Parent.FindChild[ChkBoxMoveBehindID]:UnsetChecked
    This.Parent.FindChild[ChkBoxMoveBehindID]:RightClick
 </OnLeftClick>
  <OnRightClick>
    relay all "Script[\${OgreBotScriptName}]:QueueCommand[call UplinkControllerFunction ${This.Type} checkbox_settings_moveinfront ${This.Checked}]"
  </OnRightClick>
</checkbox>

Notice you should have come up on the 4th line of this snippet of code.

On the first line of code you see name='checkbox_settings_moveinfront', this gives us the correct name of the option we want to change, checkbox_settings_moveinfront.

Alternately you can look in the OgreUIXML.xml

Use the search function(recomended) or scroll though the file to find the text of the option, in this case Move in Front of mob.

<checkbox name='checkbox_settings_moveinfront' template='EQ2OB_Checkbox_Settings'>
    <Text>Move in front of mob</Text>
    <OnLeftClick>
       TabConfig.Settings:ChangeSettingDetailsFromUI[${This.Name}]
       if ${This.Checked} && ${UIElement[${OBUI_checkbox_settings_movebehind}].Checked}
       UIElement[${OBUI_checkbox_settings_movebehind}]:LeftClick
    </OnLeftClick>
</checkbox>

Lastly set the value to TRUE(case matters) and of course to commit the changes hit apply

Adding more buttons

On the MCP click the setup button up on the top above the mcp buttons this will bring up the Edit MCP settings UI.

The key numbers to know here are the button height and width and the spacing height and width.

Lets say that we want to add another column to the page frames. We simply add the button width and the button width spacing together (54) and add that to the Width value at a minimum. I would suggest for aesthetic reason adding in between one and a half the button spacing value and twice the value.

adjusting static frame buttons

On the MCP click the setup button up on the top above the mcp buttons this will bring up the Edit MCP settings UI. To add more static frame buttons or less simply adjust the width of Static Frame Width by the value of the button width. Remember to increase the witch of the MCP to compensate for the increase in the static frame width.

Keep in mind that column 1 of the static frame is hard coded to switch pages of the frames.

|- |Parameter1 || -inviter <toonname> **This is the toon who will be DOING the inviting. If not specified, uses the person who pressed the button.** |- |Parameter2 || -r <toonname> **This does a RAID invite to the toonname. |- |Parameter3 || <toonname> **A toon to group invite. |- |Example || I hit the MCP button on a toon called 'Kannkor', and it has the following parameters.

   primalz
   eq2bob
   -r
   saha
   -inviter
   saha
   blowupdoll 

The following happens, in this order:

   Kannkor group invites primalz
   Kannkor group invites eq2bob
   Kannkor raid invites saha
   Saha group invites blowupdoll
   The "-inviter saha" told the script to change the inviting over to saha,
   instead of Kannkor. Which is why it started inviting on saha. 

|-