Difference between revisions of "OgreIRC:OgreIRC"

Revision as of 19:59, 24 June 2014

OgreIRC

Summary

OgreIRC - hooks into your uplink and allows commands to pass through it.

This is a very advanced feature. It is generally used for two purposes. As a method of "connecting" players together to control each others bots. Generally in a raid situation. Secondly, for extremely advanced control of some of OgreBot features. Because OgreIRC has pure CLI (Command Line Interface) with many of OgreBots functions, you can set up some additional functionality over standard MCP commands. Because it is built around it coming from an outside source, it always takes parameters of who it's for, rather than blanket relay alls (although many MCP commands have the standard who it's for).

OgreIRC is 100% unsupported. You are more than welcome to try it, provide feedback on bugs/features, but there will be no timelines. Unless you have a use for it, and are a seasoned user/scripter, I wouldn't recommend taking on this task.

Requirements / Setup

• ISXIM - This is a free download from isxgames.com. Link
  • It must be updated (load the extension once).
  • It is only required on the 1 computer that will be acting as the bridge between IRC and your local network.
  • Do NOT add it to your startup. There is no need to load it anywhere, or do anything with it (other than ext isxim once so it updates).
• Data.xml
  • Rename the file: scripts/OgreIRC/bak.data.xml to data.xml (remove the bak.)
  • Edit this file.
    • UplinkName - This is the name of the uplink that the IRC bridge will be running on.
    • IRCServer - IRCServer you will be connecting too.
    • DefaultUser - IRC Name
    • DefaultChannel - IRC channel. At this time, only 1 channel is supported.
    • ChannelPassword - Password for IRC Channel...
    • The last 3 have to do with logging characters in automatically. This is NOT coded at the time of writing this, with minimal plans to implement it.

Usage

• There are 2 "scripts" running. One in the uplink (OgreIRC), and one in each game session (OgreIRCSession). How OgreIRC works, is the OgreIRCSessions send information to OgreIRC in the uplink, and it is passed to the IRC channel. Likewise, when information is received from the IRC channel, it is read by OgreIRC, and passed to OgreIRCSessions.
• Load your sessions, and in the console on the computer where you want the IRC bridge, type: ogre irc
• This will relay all other sessions to load OgreIRCSession, as well as load OgreIRC into the uplink. These are bruteforce checks, so if one of them is already running, you'll get "script is already running". That is fine.
• To use the in-game interface, you need to open it by hitting Control+~ IE: The same way you open the console, but hold control down. (For those technical reading this, I realize ~ isn't really the key you are pressing, but it's much easier than trying to get people to see the difference between ' and `, and most people think the tilde key is default.)
• Any tells recieved will go to the OgreIRCConsole window ingame.
• Any message sent to IRC that contains NULL, will be cut off at the NULL. For example: If you had a message that read: "Hello there NULL NULL NULL", it would only output "Hello there". Likewise, if you have a message that read "Hello NULL NULL there NULL", it would only output "Hello".

[08:29:22] [08:29:22] <~Kannkor> Simply put...
[08:29:50] [08:29:50] <~Kannkor> Each IRC line has to start with !c <ForWhichIRCBot>, so usually it's for everyone: !c all
[08:29:53] [08:29:53] <~Kannkor> Then you can stack commands
[08:29:55] [08:29:55] <~Kannkor> For example:
[08:30:54] [08:30:54] <~Kannkor> !c all -cs all -jst-off casters -jst-off troubador -jstout all -assist someone all -assist someoneelse anotherperson -holdup all
[08:30:56] [08:30:56] <~Kannkor> etc etc
[08:31:03] [08:31:03] <~Kannkor> That one is obviously full of random commands
[08:31:05] [08:31:05] <~Kannkor> But you get the idea

Colours

• Yes, colours. OgreIRC is Canadian, deal with it!
• Green = Chat intended for a human.
• Red = A chat command intended for the bot.
• Yellow = An in-game tell.

Commands

• All commands to be sent interpreted by the bot, must start with "!command [For who]" (a space after the d), or for the lazy, "!c [For who]" works fine too. Following this, any -command <parameter> will work. IE: !c All -available kannkor
  • For who possibilities
    • All - All bots will listen.
    • Bot_Name - Only the specific bot will listen. Note: This is NOT the name of a toon, it is the name of the IRC bot.
    • Me - This will only work for the person giving the command. Do not confuse this with in-game aliases. You CAN NOT USE 'me' AS A PARAMETER FOR COMMANDS. Use ${Me.Name} for that. The 'me' alias ONLY works immediately after "!c"
• Commands. Note, majority of these are identical to how their MCP counterpart works.

   -Invite Kannkor primalz -invite Kannkor eq2bob -raidinvite Kannkor saha 

Not implemented

MCP Buttons not implemented at this time. Most of these require special coding, or require infinite Parameters, which isn't possible (yet).

• Trak-HUD
• Turt-HUD
• RelayRunScript
• RawCommand
• OgreBotAtom
• OgreBotAtomRelay
• ExecuteAtom
• OgreCommand