Farion
Farion
Farion is yet another game chat to IRC bridge, with some extra features I find useful.
Features
- IRC to game chat bridge
- Uses new Async event, will keep transporting messages even with lag
- IRC Flood prevention, won't get your IP banned from the network
- Kicking and Banning from IRC
- Player list from IRC
- Clearing built-up chat-queue from IRC and in-game
- Console access from IRC via private messages with the bot
- New: Customize messages sent to and from IRC and in-game
- New: Permission node to disable a player or group from having messages or actions relayed
Commands
IRC Commands | ||
---|---|---|
.players | Returns a list of users on the server | Anyone may use this command |
.kick <username> (reason ...) | Kicks a player from the server with the provided reason, if one is given. | Requires voice or op to use this command |
.ban <username> (reason ...) | Bans a player from the server with the provided reason, if one is given. | Requires voice or op to use this command |
.clear | Clears all messages from the IRC message queue | Requires voice or op to use this command |
Game Commands | ||
/farion | Prints the Farion help message | Anyone may use this command |
/farion remote | Prints a list of all IRC nicks that are allowed to use the IRC-Console feature | Requires the permission: farion.remoteusernames |
/farion reconnect | Forces the bot to disconnect and rejoin the IRC server | Requires the permission: farion.reconnect |
/farion clear | Clears all messages from the IRC message queue | Requires the permission: farion.clear |
Permissions
Node | Allows | Default |
---|---|---|
farion.relay | Allows player chat and actions to be relayed to IRC | true |
farion.remoteusernames | Allows the use of /farion remote | op |
farion.reconnect | Allows the use of /farion reconnect | op |
farion.clear | Allows the user of /farion clear | op |
Configuration
# Farion config file Bot: DCCPassword: "changeme" Nick: "Chatbot" NickServ: "woowoo" RetryConnect: true Server: Hostname: irc.esper.net Port: 6667 SSL: false Password: "" Channel: Name: "#channel" ModChannel: Name: "#channel" RemoteConsoleUsers: - "Username" Message: # Game -> IRC Irc: Message: "<{username}> {message}" MeMessage: "* {username} {message}" JoinMessage: "{username} logged in." PartMessage: "{username} has left the server." # IRC -> Game Game: Message: "&r[IRC] <{nickname}> {message}" MeMessage: "&r[IRC] * {nickname} {message}" JoinMessage: "&r[IRC] {nickname} has joined." PartMessage: "&r[IRC] {nickname} has left." NickMessage: "&r[IRC] {oldnick} is now {newnick}"
Option | Type | Description |
---|---|---|
Bot.DCCPassword | String | Unused |
Bot.Nick | String | The bot will use this nick in IRC |
Bot.NickServ | String | The bot will use this password to identify with NickServ |
Bot.RetryConnect | Boolean | If set to true, the bot will try to reconnect when disconnected |
Server.Hostname | String | The bot will attempt to connect to this server |
Server.Port | Integer | The bot will attempt to connect on this port |
Server.Password | String | The bot will attempt to use this password to connect to the server. This is not the NickServ password! |
Channel.Name | String | The bot will attempt to connect to this channel to bridge chat |
ModChannel.Name | String | Unused |
RemoteConsoleUsers | List of Strings | Nicks in this list are able to use IRC Console |
Message.Irc.Message | String | Used for messages from the game to IRC |
Message.Irc.MeMessage | String | Used for /me messages from the game to IRC |
Message.Irc.JoinMessage | String | Used for player login messages in IRC |
Message.Irc.PartMessage | String | Used for player logout messages in IRC |
Message.Game.Message | String | Used for messages from IRC to the game. Supports & color codes |
Message.Game.MeMessage | String | Used for /me messages from IRC to the game. Supports & color codes |
Message.Game.JoinMessage | String | Used for IRC user join messages in game. Supports & color codes |
Message.Game.PartMessage | String | Used for IRC user part messages in game. Supports & color codes |
Message.Game.NickMessage | String | Used for IRC user nick change messages in game. Supports & color codes |
To disable any Message: Simply set it to "" and it will not be processed or sent.
Using IRC Console
IRC Console is a powerful feature provided by Farion, as it allows you to execute commands as if you were in the server console, without having to open it.
To use it, you must first add the the Nick of the IRC user you would like to be able to use this feature to the list RemoteConsoleUsers in the config.yml. Be sure you have registered this Nick with NickServ! If someone else steals your Nick on IRC they will be able to use console on your server
To enable the console, open up a private message conversation with the bot and say ".on"
- You can use "/msg <BotNick> .on" to begin this conversation in any IRC client
After doing this the bot will now send you private messages of the console output, and all messages sent to the bot will be executed as if they were console commands.
To disable the console, in a private message with the bot say ".off"
- You can use "/msg <BotNick> .off" in any IRC client
And that's all there is to using it, it's that simple.
Will this be updated to 1.6.4 anytime soon? I haven't had a response in IRC yet.
@ShootToMaim
If you have a local chat, you need to use the global chat for it to work. I am trying to see if this can be fixed too.
does this support teamspeak server chat? EDIT: nevermind, noobie question, is it possible to add teamspeak chat support?
Also, a bug with Essentials Chat set to ranged mode. It will not display the local messages.
Suggestions:
Very awesome plugin :3
@idrum69
That was because Farion hadn't yet updated to 1.4.7, once 0.6-1.4.7 is approved grab that, and it should work.
NuclearW, I'm not able to see any chat from MC to IRC (gamesurge.net), although I can see IRC chat fine from MC.
Major chat editing plugins are EssentialsChat and Factions, as well as PermissionsEx for prefixes.
This was also the case with SimpleIRC. Please advise, thank you.
It cannot find a class file when i start it... It DOES connect to the IRC, but immediately disconnects because of the error. I tried it in a blank server also. Here is a paste of the error http://pastebin.com/VmHrWy4d
@seriosbrad
Alright, well I'll see how I'll go about doing some colors.
You should hang out in #nuclearw on esper if you want to talk to me and/or see progress on my plugins
@NuclearW
Oh, my mistake. It's still extremely more convenient then having to load up my slow web-based console from my hosting provider :)
@seriosbrad
Note the console isn't through DCC, at least not yet.
I'll see what I can do about the formatting, though.
Been using CraftIRC lately, I reaallllllly like the DCC console in Farion. I would switch to Farion in a heartbeat if you allow customizing the output of the in-game messages from IRC with &ecolor &0support ;)
Good luck with an official bukkitdev release. This is a great plugin :)