OgreMCP
Contents
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 -
- 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)
File:Ogremcp combat static.jpg
- 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
File:Ogremcp combat buttons.jpg
- 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). Set it to around 15 to prevent the toons from hopping on top of each other.
- 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.
( )
- 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 eqchars.inc).
- Note: You need Move To Area selected for these to work, and a target (can be yourself).
- "come to me" - Everyone.
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
- OgreMCP.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
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.