JacobIRC

Version 2.0

This version of the plugin is no longer supoported nor maintained! For the new version go to JacobIRC 2.0

What is it? Basically, it is an IRC plugin, that allows you to link your server's chat and some channel on some IRC server. And use server commands from IRC!

Usage od JacobIRC

It is very simple, just download the latest build and put it into your plugins folder, then reload server and edit config.yml file.

Configuration

#Nick of bot
BotName: JacoBot
#Channel name WITHOUT #
ChannelName: example
#IRC server (without port)
IrcServer: irc.example.org
#IRC server port (6667 is default value)
IrcPort: 6667
#Password registered in NICKSERVICE
RegisteredPassword: mypassword
#Channel password
ChannelPassword: channelpassword
#Server encoding (experimental)
Encoding: utf-8
#Specifies whether all messages from IRC are sended to the game.
SendAllMessages: false
#People that can send commands from IRC by !cmd (we recommend only registered nicks)
IrcAdmins:
 - Nick1
 - Nick2

AdminErrorMsg: Only admins can use commands
UserConnectMsg: Player %p connected to server
UserDisconnectMsg: Player %p disconnected from server

#With this, ALL output from console will be sent to IRC - you can do something like remote console. Be careful!
FullConsoleSync: false

#Format of message from IRC to game
MessageFormat: IRC - %s - %m
#Format of message from game to IRC
ChatFormat: Server - %s - %m

Explanation:

  • BotName is nick of your JacobIRC bot (we recommend to register it using Nickserv)
  • ChannelName is name of channel that will your bot join (without #!)
  • IrcServer is server where it will connect without port (irc.freenode.net etc....)
  • IrcPort is port of that server, default 6667
  • RegisteredPassword is password you use to identify with NICKSERVICE (/msg NickServ identify password) : you must register your bot on IRC server by /msg nickserv register <email> <password> (may vary on various servers, but it's usually like this) - add # before this line if you are not using NICKSERV
  • ChannelPassword is password of channel - add # before this line if the channel is not protected (we recommend to do so)
  • Encoding is encoding of your server, you should keep utf-8
  • IrcAdmins is field of user names, that can use !cmd anycommand from IRC (this allows you to control your server from IRC) there must be IRC nicks!
  • AdminErrorMsg is message, that will be sent to users, who use !cmd and who don't have perm. for it
  • UserConnectMsg is message, that will appear on IRC when player connects to the game, you can use %p for player name.
  • UserDisconnectMsg is message for disconnecting, you can use %p as well
  • SendAllMessages is option for disable sending all messages from IRC to game. If this is false, you must write "BOTNAME:" to start of any message to be sent to game.
  • FullConsoleSync is option for full console synchronization with IRC - all output from console is sended to IRC.
  • MessageFormat is a placeholder for messages going from IRC to game - use %s for sender nick and %m for message itself
  • ChatFormat is a placeholder for messages going from game to IRC - symbols are same as in MessageFormat

Permissions

There are two commands:

  1. ircmd - permission JIRC.Ircmd
  2. ircusers - permission JIRC.Irclist
    IRCMD allows using /ircmd COMMAND PARAMETERS to control IRC connection from game. Command must be in RAW IRC format, for example /ircmd KICK #channelname Nick Reason
    IRCUSERS will give you list of users on IRC

Commands

  • ingame: /ircmd RAW IRC COMMAND
  • ingame: /irclist
  • from irc: !cmd command
  • from irc: !players

Commands after connect

Plugin will create commands.txt file on first run. You can add raw IRC commands, that will be sended after connecting and joining channel

This plugin uses irc-api library

Comments

  • To post a comment, please or register a new account.
Posts Quoted:
Reply
Clear All Quotes

About This Project

Categories

Members

Recent Files

Bukkit