PurpleIRC

Table of Contents

About PurpleIRC

PurpleIRC is an IRC to Minecraft bridge plugin. This plugin supports running multiple bots on multiple channels. This plugin utilizes the PircBotX Java IRC framework (included in the plugin jar).

Wiki

For additional information see the PurpleIRC Wiki.

Features

Relay chat from game to IRC and vice versa.
Relay game events to IRC.
Relay IRC events to game.
Translate colors from game to IRC and vice versa.
Fully configurable message templates.
Enable or disable any chat feature to and from the game.
Most of the configuration options are per bot and per channel.
Each bot can join multiple channels.
Automatically op IRC users based on user masks.
Control and protect the IRC topic.
Manage IRC channel modes.
Automatically reconnect to the IRC server on disconnect.
Respond to commands in IRC chat.
Send any command to the game via the console.
Supports prefixes and suffixes. (see sample config for details)
Displays IRC users in the tab list. (requires ProtocolLib)
Monitor player command usage.
Great for cross server chatting.
Update checker will make external HTTP connections to check for new versions.
SSL/TLS support.

CraftBukkit Versions

If you are running CraftBukkit version 1.7.2 or older then stick to PurpleIRC version v2.1.14-174 and older.
If you need a version that supports Spigot visit the Spigot Resource Page.

How to install

Drop the PurpleIRC.jar file into your plugins directory.
Restart the server. (Please don't use /reload)
Copy plugins/PurpleIRC/sample bot to plugins/PurpleIRC/bots/NewBotName.yml
Edit the bot yml file as needed. Each option is documented.
Use /irc load bot.yml command to load and start the new bot.
Configure permissions.

Configuration

Configuration - Use /irc reloadconfig to load your changes while the bot is running.
Sample Bot - Use /irc reloadbotconfigs to load your changes while the bot is running.

Frequently Asked Questions

Chat Hooks

Supports mcMMO admin and party chats.
Supports FactionChat chat modes. (public, ally and enemy)
Supports HeroChat Global, all channels or specific channels.
Supports TitanChat chat manager.
Supports TownyChat chat manager. See FAQ.
Supports Dynmap web chat.
Supports AdminPrivateChat

Other Hooks

Supports CleverNotch bot messages.
Supports ReportRTS ticket notifications.
Supports VanishNoPacket. Prevents IRC from announcing vanished players.
Supports Shortify URL shortener. 1.8 and newer only
Supports RedditStream notifications.
Supports SuperVanish

Dependencies

PircBotX: The PircBotX classes are included in the plugin jar file.
Vault. If you need to use the %GROUP% token then install Vault.
ProtocolLib. If you need to use the custom tab list then install ProtocolLib.

Permissions (see plugin.yml)

node	default	description
irc.<COMMAND>	op	Every command requires a permission node.
irc.message.chat	true	Receive IRC chat messages
irc.message.gamechat	true	Send game chat to IRC
irc.message.action	true	Receive IRC chat actions (/me)
irc.message.quit	false	Receive IRC quit messages
irc.message.join	false	Receive IRC join messages
irc.message.disconnect	op	Receive IRC disconnect messages
irc.message.connect	op	Receive IRC connect messages
irc.message.kick	false	Receive IRC kick messages
irc.message.nickchange	false	Receive IRC nick change messages
irc.message.topic	false	Receive IRC topic messages
irc.message.part	false	Receive IRC part messages
irc.tablist	op	Display IRC users in tab list

Commands

command	args	description
/irc load [bot.yml]		Load bot file
/irc unload [bot.yml] (disable)		Unload bot and optionally disable it
/irc reload		Reload entire plugin (Don't use this to load changes to your configs and bots. Use reloadconfig and reloadbotconfigs instead)
/irc reloadconfig		Reload config.yml
/irc save	([bot])	Save bot configuration(s) to disk
/irc reloadbot	[bot]	Reload the bot config and reconnect
/irc reloadbots		Reload all bot configs and reconnect
/irc reloadbotconfig	[bot]	Reload bot config without reconnecting
/irc reloadbotconfigs		Reload all bot configs without reconnecting
/irc connect	([bot])	Connect to configured IRC serve
/irc disconnect	([bot])	Disconnect from configured IRC server
/irc listbots		List loaded bots
/irc list	([bot]) ([channel])	List users in a channel
/irc kick	[bot] [channel] [user(s)]	Kick user(s) from a channel
/irc op	[bot] [channel] [user(s)]	Op user(s) in a channel
/irc listops	[bot] [channel]	List auto ops for a channel
/irc motd	[bot]	Display IRC motd.
/irc deop	[bot] [channel] [user(s)]	DeOp user(s) in a channel
/irc addop	[bot] [channel] [user mask]	Add user mask to op list
/irc removeop	[bot] [channel] [user mask]	Remove user mask from op list
/irc server	[bot] [server] ([true\|false])	Set IRC server for bot. Optionally set autoconnect
/irc mute	([bot]) ([channel]) [user(s)]	Mute user(s) in a channel
/irc unmute	[bot] [channel] [user(s)]	Unmute user(s) in a channel
/irc nick	[bot] [nick]	Change the bot's IRC nickname
/irc login	[bot] [login]	Change the bot's IRC login
/irc join	[bot] [channel]	Join a channel
/irc leave	[bot] [channel] ([reason)]	Leave a channel
/irc whois	([bot]) [nick]	Get IRC user's whois info
/irc say	[bot] [channel] [message]	Make the bot say something
/irc send	([bot]) ([channel]) [message]	Send a message to a channel
/irc debug	([t\|f])	Enable debug mode
/irc messagedelay	[bot] ([milliseconds])	Get or set IRC message delay. (Default: 1000)
/irc msg	([bot]) [user] [message]	Send a private message to IRC user
/irc ctcp	([bot]) [user\|channel] [message]	Send ctcp command to user or channel.
/irc notice	([bot]) [user\|channel] [message]	Send notice command to user or channel.
/irc sendraw	([bot]) [command]	Send raw command to IRC server.
/irc updatecheck	([stable\|dev])	Check for new versions of PurpleIRC.

IRC User Modes

mode	description
i	IrcOp
o	Operator
v	Voice
h	Half Op
q	Channel Owner
s	Super Op

Change Log

Change Log

Known Issues

AuthMe: If you are running the AuthMe plugin you will need to set enableAntiBot to false.

Additional Help

Tickets: Please reports bugs using the ticket tracker.
IRC: I'm usually hanging out in #PurpleIRC on irc.esper.net. If I'm awake you can chat with me there.
PM: Feel free to send me private messages here.

Other

Bitcoin: 1P44sYgXLejo35vANvNfPTY56ANSC5w4dg

Comments

cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#372 cnaude

View User Profile

Send Message

Posted Nov 6, 2014
@ThisUsernameIsMine

Fixed in latest build.

Rollback Post to Revision RollBack
_ForgeUser8075891
- Join Date: 12/14/2011
- Posts: 2,145
- Member Details
#371 _ForgeUser8075891

View User Profile

Send Message

Posted Nov 5, 2014
Hello cnaude :-)

I've noticed something awkward when using your plugin (i've narrowed it down to your plugin as the issue only occurs after installing your plugin).

When joining the Mincraft server and trying to send some text messages in Minecraft, they don't come through.
This lasts for ~ 5-ish seconds, after which i can send (and see) my text.

The same counts for commands: no commands are executed within this timespan.

But there's a catch: When joining the server by its LOCAL IP address, there's no such problem!

So this only seems to occur when connecting to the server's external (public) IP address.

I've tested both build #166 and #171 under SpigotMC 1.7.10-R0.1-SNAPSHOT #1649 + patched with Spigot Update 20141001a, running under Windows 7 Ultimate x64 @ Java 8 Update 25 (x64)

Last edited by _ForgeUser8075891: Nov 5, 2014

Rollback Post to Revision RollBack
cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#370 cnaude

View User Profile

Send Message

Posted Oct 2, 2014
@Done84

Did you mean No Cheat Plus? At the moment PurpleIRC has no hooks into NCP. I have to look at the NCP code to see if there are any events I can hook into.

Rollback Post to Revision RollBack
_ForgeUser10278744
- Join Date: 12/27/2012
- Posts: 98
- Member Details
#369 _ForgeUser10278744

View User Profile

Send Message

Posted Oct 2, 2014
Im looking for an IRC bot that can send all No Chat Plus notifications to an irc channel, so that my staff can check it without being overwhelmed with spam since NCP displays a lot of messages all the time. Is this possible with this plugin?

Rollback Post to Revision RollBack
cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#368 cnaude

View User Profile

Send Message

Posted Sep 6, 2014
@mobilephone2003

Please try latest dev build: http://h.cnaude.org:8081/job/PurpleIRC/137/ You can use %POWERLEVEL% in your message templates.

Rollback Post to Revision RollBack
_ForgeUser7458638
- Join Date: 8/28/2011
- Posts: 456
- Member Details
#367 _ForgeUser7458638

View User Profile

Send Message

Posted Sep 5, 2014
@cnaude

Hey buddy,

Still using PurpleIRC, working great! Is there any chance that we can have mcMMO Power Level of a player included in the chat sent to IRC? We have this in-game now on a player's prefix and it's good to track the progress of players.

Rollback Post to Revision RollBack
cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#366 cnaude

View User Profile

Send Message

Posted Aug 31, 2014
@JRPenza620

For each command just set "ctcp: true"

Rollback Post to Revision RollBack
_ForgeUser7561415
- Join Date: 9/17/2011
- Posts: 21
- Member Details
#365 _ForgeUser7561415

View User Profile

Send Message

Posted Aug 31, 2014
@cnaude

What if I wanted all of them? Like the ctcp for every command someone puts in.

Rollback Post to Revision RollBack

cnaude

Location: Phoenix
Join Date: 8/30/2011
Posts: 1,408
Member Details

#364 Posted Aug 30, 2014

@JRPenza620

You can send the commands to the bot via private message. Example command:

      list:
        modes: 'o'
        private: true
        ctcp: false
        game_command: '@list'        
        private_listen: true
        channel_listen: false

_ForgeUser7561415
- Join Date: 9/17/2011
- Posts: 21
- Member Details
#363 _ForgeUser7561415

View User Profile

Send Message

Posted Aug 30, 2014
@cnaude

But will everyone be able to see the commands if they are in the room? or only me.

Rollback Post to Revision RollBack
cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#362 cnaude

View User Profile

Send Message

Posted Aug 29, 2014
@JRPenza620

You can setup all of the commands to only work when you have ops in the channel.

Rollback Post to Revision RollBack
_ForgeUser7561415
- Join Date: 9/17/2011
- Posts: 21
- Member Details
#361 _ForgeUser7561415

View User Profile

Send Message

Posted Aug 29, 2014
@cnaude

One more question:

I want to use my IRC publicly, however I still want to display the command stuff to me only. Is there a way to do this?

Rollback Post to Revision RollBack
cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#360 cnaude

View User Profile

Send Message

Posted Aug 29, 2014
@JRPenza620

Use %DISPLAYNAME% in your message templates.

Rollback Post to Revision RollBack
_ForgeUser7561415
- Join Date: 9/17/2011
- Posts: 21
- Member Details
#359 _ForgeUser7561415

View User Profile

Send Message

Posted Aug 29, 2014
How do I show the color of the players name on the chat? It shows up when I do .list

Rollback Post to Revision RollBack
cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#358 cnaude

View User Profile

Send Message

Posted Aug 23, 2014
@Hobby_boy

PurpleIRC uses the nickserv methods from the pircbotx API. You're welcome to look at the pircbotx source to see how it's done. https://code.google.com/p/pircbotx/

Alternatively you can use raw commands to authenticate.

Rollback Post to Revision RollBack
Hobby_boy
- Join Date: 8/7/2012
- Posts: 10
- Member Details
#357 Hobby_boy

View User Profile

Send Message

Posted Aug 23, 2014
Which authentication method does the bot use to authenticate with NickServ?

Rollback Post to Revision RollBack
_ForgeUser9307873
- Join Date: 7/29/2012
- Posts: 22
- Member Details
#356 _ForgeUser9307873

View User Profile

Send Message

Posted Jul 31, 2014
quick question: when a player toggles mcmmo party chat their chat then shows up as global AND party chat. If they just do /p message here then it only shows up as Party chat (which I have hidden on my irc channel).
My question is, how would I hide the party chat that is showing up as global chat in my irc channel?
On my bot I have only -towny-chat enabled. I am using PermissionsEx, Towny, PurpleIRC and spigot.

Rollback Post to Revision RollBack
cnaude
- Location: Phoenix
- Join Date: 8/30/2011
- Posts: 1,408
- Member Details
#355 cnaude

View User Profile

Send Message

Posted Jul 28, 2014
@LaserCucumber

It creates a single IRC bot.

Rollback Post to Revision RollBack
_ForgeUser8668117
- Join Date: 3/31/2012
- Posts: 108
- Member Details
#354 _ForgeUser8668117

View User Profile

Send Message

Posted Jul 27, 2014
So does this plugin create a single bot that relays messages between the IRC server and the Minecraft server, or does it create an individual client for each user connected to the Minecraft server so they can act like normal IRC users?

Rollback Post to Revision RollBack
_ForgeUser8421057
- Join Date: 2/14/2012
- Posts: 36
- Member Details
#353 _ForgeUser8421057

View User Profile

Send Message

Posted Jul 11, 2014
I'm having a sudden issue with the plugin and not sure what it is. When I used to do .lag it would give me an entire readout of the server ticks and such. But, now it only says Ticks per second and shows it 20.0 [100.0%] and nothing else. Any clue as to why this is? Not sure if it's the plugin or something else. I didn't add anything or change anything so not sure why this suddenly happened...

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

56773
Created

May 2, 2013
Last Released File

Sep 23, 2017
Total Downloads

24,458
License

GNU General Public License ver...

PurpleIRC-2.1.14-433
Sep 23, 2017
v0.0.18
May 13, 2013

Bukkit

PurpleIRC

Bukkit Plugins

PurpleIRC

Table of Contents

About PurpleIRC

Wiki

Features

CraftBukkit Versions

How to install

Configuration

Frequently Asked Questions

Links

Chat Hooks

Other Hooks

Dependencies

Permissions (see plugin.yml)

Commands

IRC User Modes

Change Log

Known Issues

Additional Help

Other

Comments

About This Project

Categories

Members

Recent Files

Bukkit