Bukkit

Xchat

What Is It?

Xchat is a new chat plugin intended to be an easy to use, extensively configurable chat plugin for the Bukkit server mod. This plugin provides server owners and operators the tools to take complete control over their server's chat system.

Features

Please note that not all feaures are fully operational! Only rely on that which is listed under the "working" category.

Xchat comes with a variety of great features. To list a few:

Working

This is the working feature set for the current version (1.0)

• Channels
  • 2 pre-defined channels (common channel and admin channel)
  • Add unlimited custom channels
  • Can set admin channel to see messages from all channels
• Colour Chat
  • Use colour chat from almost any configurable message
  • Define the character to use for color codes
• Chat Formatting
  • Format chat messages however you desire
  • Use representitive strings to format the chat easily:
    • [DISPLAYNAME] - represents the message sender's display name
    • [NAME] -------- represents the message sender's name
    • [MESSAGE] ----- represents the message message sent
    • [WORLD] ------- represents the message sender's world
    • [CHANNEL] ----- represents the message sender's chat channel
• Message Of The Day (MOTD)
  • Automatically send a message to a player when they join the server
  • Supports color codes
• Chat Logger
  • logs the chat in a humanly readable manner

Not Working

These are features that are in the plugin but I have not been able to get to work yet:

• Broadcaster
  • Cycles through messages in Broadcasts.txt and sends them to the chat at the interval defined in the configuration
    • Unlimited number of messages allowed
    • Allows colour in all messages
• Link Filter
  • Can be turned on/off in configuration
  • Inteligently filter links from the chat
  • Allows whitelisted urls through filter
  • Filters IP adresses and URLs
• Shortcuts
  • Define and use your own chat shortcuts

Untested

These are features I have not had the ability to test (this is where I need feedback most!)

• Ranged Chat
  • Configurable range
  • Can be limited to the world the message was sent from
  • Shouting via configurable "shout character"
  • Global message via configurable "global shout character"
    • Sent to everyone regardless of range and channel settings
• Word Blacklist
  • BlackList certain words from the server chat in a case-insensitive manner
• Duplicate Message Protection
  • Stop players sending duplicate messages in the chat
    • Only stops exact duplicates
• Custom Regex List
  • Add your own Regular expressions to filter the chat with
  • Note: This feature is suggested for advanced users only

Set-Up

Xchat comes ready to work the moment you add it to your server, however almost any aspect of the plugin can be altered using the extensive configuration file (Xchat's config.yml).

All options in the configuration file have been commented to make it easier to understand how each option will affect the behaviour of the plugin.

Due to the length of the configuration I will not be describing it in detail here.

Commands

Xchat's commands (including descriptions):

• /xchat reload
  • description: reload Xchat
• /xchat reload config|broadcast|channels
  • description: reload config or broadcast or channels

• /xchat check

  • description: check for an update to Xchat

• /channel <Channel_Name>

  • description: switch chat channels

• /channel list

  • description: list all chat channels

• /broadcast on|off

  • description: temporarily toggle the status of the broadcaster
• /broadcast add <message>
  • description: add a message to the broadcaster

Permissions

Permission nodes for Xchat can be found here

Support

Have a bug or error? submit a ticket Need help with something? hit up the forums I will NOT reply to requests for help in the comments, thats not what the comments section is for.

Source

Source code will be made available via github as soon as the first file is uploaded

Like My Work?

Like my work and want to support me? Tossing a couple bucks my way would be greatly appreciated <-- (Temporarily Broken Link)