Bukkit

SimpleChatChannels

The chat channels system for Simply Modular is a fairly robust set of tools to assist you with creating your own chat channels for your server. Features include the following:

- Set up multiple different chat channels, with various customizable options, including channel color, channel name, permission to join, etc.

- Commands to join, leave, and cross-post into other channels

- Global and personal mute/ignore systems

- tell/r systems

- pm spy system

- customize personal chat channel colors (allows a player to set the color they personally see a channel formatted to,if they don't like the color that its set to system-side)

Chat Channels Configuration

The plugin uses a file called 'chatchannels.yml' to store all of its data. There are four entries at the root of the yml config, shortenLinks*, greentext, userChannels*, and serverChannels.

(*not implemented yet)

shortenLinks, if set to true, will automatically shorten links using a link shortening service.

greentext, if set to true, will color chat messages green if the message starts with '>'

userChannels contains any user-generated chat channels.

serverChannels contains any hard-set channels in the server.

User and Server Channels

The difference between user and server channels is that server channels are supposed to be the 'official' channels of the server, while user servers can be set up by any user with the permissions to do so, creating a private channel for whatever reason they like ( a channel for towns, parties, or just friends)

To create a server channel, you will need to specify specific details about the channel. Namely, the following: name, default color, icon, quick, and mature.

name: The name of the channel. Cannot be the name of an existing servercommand

color: the default color of the channel. Can be overridden by personal color.

icon: the icon of the server. When players chat in the channel, will appear before all chat messages

quick: the quick command for the server. Can be used to target the channel with channel commands. Cannot be the same name as an existing servercommand

Optional Parameters

There are optional settings for each channel, that have defaults, if not set. They are the following: permission, default, and mature.

permission: the permission required to join the channel. if no permission is defined, the channel does not require a permission to join (anyone can join)

default: defines the channel as the servers default channel. ONLY ONE channel may be default, and the default channel may NOT have a permission to join. The default channel will be the channel that a new player joins when they first log into the server.

mature: defaults to false. Declares a channel as a mature channel, which will require people consent to the fact that the channel is mature before joining it. Additionally, players may be flagged against joining mature channels by the server staff, if they wish to keep target players out of mature channels. (not quite yet implemented)

Writing a new Channel

Once you've decided all of the details of the channel, you'll need to add it to the configuration file. You can do so by adding a new entry in the serverChannels node, like so

serverChannels:
  channelName:
    color: WHITE
    icon: '[icon]'
    quick: c
    permission: permission.to.join
    default: false
    mature: false

Once done, save the yml config file, and boot up the server. You should be able to join the channel by typing /join <channelname>, if there were no issues.