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
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
| farion.remoteusernames | Allows the use of /farion remote |
| farion.reconnect | Allows the use of /farion reconnect |
| farion.clear | Allows the user of /farion clear |
Configuration
# Farion config fileBot:DCCPassword:"changeme"Nick:"Chatbot"NickServ:"woowoo"RetryConnect:trueServer:Hostname:irc.esper.netPort: 6667 SSL:falseChannel:Name:"#channel"ModChannel:Name:"#channel"RemoteConsoleUsers:-"Username"
| 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 |
| 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 |
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.