Bukkit

Default Configuration:

debug: false
servers:
  - address: "irc.carnerum.net"
    port: 6667
    nick: Test
    channels:
    - "#titanirctest"
config:
  format:
    irc-to-game:
      join:    "[IRC] %nick% joined"
      part:    "[IRC] %nick% left"
      quit:    "[IRC] %nick% quit"
      message: "[IRC] <%nick%> %message%"
      action:  "[IRC] * %nick% &f%message%"
    game-to-irc:
      name-format: "%prefix%%nick%%suffix%"
      join:    "(%name% &fentered the game)"
      quit:   "(%name% &fquit)"
      kick:    "(%name% &fwas kicked. %reason%&f)"
      death:   "[%name% &fdied]"
      use-chat-plugin: true
      message: "[%group%] %name%&f: %message%"   #If use-chat-plugin is true, this has no effect
      action:  "[%group%] * %name%&f %message%"
    irc-to-irc:
      join:    "[%chan%] %nick% joined"
      part:    "[%chan%] %nick% left"
      quit:    "[%chan%] %nick% quit"
      message: "[%chan%] <%nick%> %message%"
      action:  "[%chan%] * %nick% %message%"
  colour-map:
  - {game: "0", irc: "01"}
  - {game: "1", irc: "02"}
  - {game: "2", irc: "03"}
  - {game: "3", irc: "10"}
  - {game: "4", irc: "05"}
  - {game: "5", irc: "06"}
  - {game: "6", irc: "07"}
  - {game: "7", irc: "15"}
  - {game: "8", irc: "14"}
  - {game: "9", irc: "12"}
  - {game: "a", irc: "09"}
  - {game: "b", irc: "11"}
  - {game: "c", irc: "04"}
  - {game: "d", irc: "13"}
  - {game: "e", irc: "08"}
  - {game: "f", irc: "01"}

Breakdown:

• debug: false
  • If you're having errors, enabling debug will show the raw traffic between the IRC server and your Minecraft server.
• servers:
  • Set up the connections to the IRC servers.
  • - address: irc.carnerum.net
    • The IP address that is used to connect to the IRC server.
  • port: 6667
    • The port used to connect. SSL is not yet supported
  • nick: Test
    • The name that appears in IRC for the bot.
  • channels:
    - "#titanirctest"
    • A standard YML list of channels to join on connect. What ever you do, if you're going to have more than one bot in one server, do NOT put them in the same channel.
• format:
  • How TitanIRC will relay events (such as join/quit).
  • irc-to-game:
    • How messages sent from IRC will be shown in game. Some variables can only be used in certain events. The accepted variables are:
      • %nick% - which is the name shown in IRC
      • %message% - For action and message only, what the person said (TODO: Part/quit messages)
      • %chan% - The channel that the event happened in (cannot be used in quit)
  • game-to-irc:
    • How messages sent from game will be shown in IRC. Some variables can only be used in certain events. The accepted variables are:
      • %prefix% - The prefix of the user (from permissions plugins)
      • %suffix% - The suffix of the user (from permissions plugins)
      • %nick% - The display name of the user without prefix or suffix
      • %name% - The setting in name-format, just to make it easier. Replace with %nick% to remove prefix/suffix for the one event or remove the variables in name-format to remove it from all.
      • %reason% - Kick only: Reason for the kick
      • %message% - Message and action only, what the player said.
    • use-chat-plugin:
      • Disables the format for message and attempts to use the output of the chat plugin (warning, it's very primative xD It just takes the format from the event)
  • irc-to-irc:
    • How messages sent from IRC will be shown in other IRC channels. Some variables can only be used in certain events. The accepted variables are:
      • %chan% - The channel the event occured in
      • %nick% - The name of the person who did the action
      • %message% - The message (message/action only)
  • colour-map
    • Colours sent between IRC and in game are automatically changed to be the correct colours in the other form. I won't document it quite yet, but follow the example. Assume the game column already has the section symbol (& for most chat plugins) and the IRC column already has the XChat equivelant of Ctrl+K.