Version: 2.6.3
CraftBukkit: 1.4.5+
Plugin Support:
PermissionsBukkit
bPermissions (2.8.0 or later)
Permissions 2.x
Permissions 3.x
If you are requesting help, post your entire server log (From the time it opens, until somebody talks), your entire Permission config file (As well as what it's named), and iChat config files. This information is REQUIRED for me to help you.
http://pastebin.com/ <-- Post configs there when asking for help
=============
Description
=============
Custom chat formatting.
Based on the idea of iChat v1.5 by Nijikokun.
Includes code and concepts from mChat by MiracleM4n <https://github.com/MiracleM4n/mChat/>
Before downloading: iChat 2.4.x has quite a few changes over the 2.3.x branches. All permissions plugins are handled in one plugin, and they all operate in relatively the same way now. This means you WILL need to redo your configs.
Download (Direct JAR): http://thedgtl.net/bukkit/iChat.jar
Source: https://github.com/TheDgtl/iChat
=============
Features
=============
Supports Permissions (Both 2.0 and 2.1), and SuperPerms handlers (PermissionsBukkit, bPermissions, GroupManager, and PermissionsEx).
Allows you to specify a prefix/suffix/variable for users and groups on a per-world or global basis.
A user-specific prefix/suffix/variable will take priority over a group prefix/suffix/variable, a world-based prefix/suffix/variable will take priority over a global prefix/suffix/variable.
Unlimited amount of custom variables for use in chat format.
Colors are supported in all parts of the formatting and chat text.
Usable health bar and health amount in the formatting.
Support for formatting of /me
World-wide variable support
Support for offsetting timestamps
=============
Formatting
=============
Message formatting is defined in the file plugins/iChat/config.yml
The message formats can contain characters, color codes, and variables.
To use colors use the standard Minecraft color codes found here: http://www.minecraftwiki.net/wiki/Classic_Server_Protocol#Color_Codes
Available variables:
+prefix - The prefix for this user, or this users group if they don't have one defined.
+suffix - The suffix for this user, or this users group if they don't have one defined.
+name - The users name
+displayname - The users display name (Set by plugins such as Towny)
+iname - The iChat formatted player name (Defined by iname-format)
+group - The users group
+healthbar - A visual health bar for this user
+health - The users current health value (Between 0 and 20)
+message - The message the player typed
+world - What world the player is currently in
+time - Timestamp, configurable in config.yml. Uses the format for SimpleDateFormat - http://bit.ly/dscw40
Example (Default):
- Code: Select all
iname-format: '[+prefix+group+suffix&f] +displayname'
message-format: '+iname: +message'
me-format: '* +name +message'
date-format: 'HH:mm:ss'
handle-me: true
Example date-format (Default):
date-format: 'HH:mm:ss'
As of iChat 2.4.0 there have been a few changes in the way variables and groups are handled.
==========
Groups
==========
As of iChat 2.4.3 native groups are supported in Permissions 2.x/3.x, PermissionsBukkit, bPermissions, and PermissionsEx.
As of iChat 2.6.2 native groups are supported in Privileges
==========
Variables
==========
Variables are now defined in variables.yml in the iChat directory. This includes prefixes, suffixes, and custom variables.
You can define an unlimited number of custom variables for groups and users, if these variables contain the static variables such as +prefix,
+suffix, +health, etc then those variables will be replaced with their respective values.
If a variable does not exist then it will be replaced with a blank string.
As of iChat 2.4.4 you can now specify world-specific variables. To specify a per-world group or user variable (Prefix, suffix, or variable) you just specify it under the world as shown in the 'world' example in the default variables.yml below. Anything specified in the parent 'users' or 'groups' nodes will be considered global for all worlds.
As of iChat 2.5.0 there are now world-wide variables, these are loaded first, and overwritten by group/user specific variables. To specify a world-wide variable just specify it under the world as shown in the 'world' example below.
Default variables.yml:
---------------------
- Code: Select all
# iChat Variable Config
# This is now the only method for defining variables
users:
Drakia:
prefix: '&e'
groups:
Admin:
prefix: '&c'
suffix: ''
Default:
prefix: ''
suffix: ''
world:
users:
Drakia:
prefix: '&a'
wName: '[World] '
Default config.yml:
---------------------
- Code: Select all
handle-me: true
date-format: HH:mm:ss
message-format: '+iname: +message'
me-format: '* +name +message'
iname-format: '+{wName}[+prefix+group+suffix&f] +displayname'
me-permissions
=============
Examples
=============
To make a group colored:
variables.yml:
- Code: Select all
groups:
Default:
prefix: '&4'
suffix: ''
config.yml:
- Code: Select all
message-format: '[+prefix+group&f] +name: +message'
To make a single username colored:
variables.yml:
- Code: Select all
users:
Drakia:
prefix: ''
suffix: '&1'
Config:
- Code: Select all
message-format: '[+prefix+group&f] +suffix+name&f: +message'
As you can see, suffixes and prefixes can be used anywhere, in any combination. In this example we use prefix as a method for coloring group names, while suffix is used to color individual users. On our server we have prefixes such as "&f[&2Mod&f] " so that we can have custom tags per group instead of just the groups name. There is no end to the combination of things you can do, please TRY things before you come asking for someone else to do it for you. There are too many combinations of things for me to answer every question about how to color specific things.
I will not be offering answers to questions such as "How do I color names?" or really anything else to do with specifics of formatting. It's pretty straightforward what you can do, and if you can't take the time to experiment then I'm not going to take the time to answer your questions.
=============
Configuration
=============
- Code: Select all
iname-format - The format used for +iname (Default: '[+prefix+group+suffix&f] +displayname')
message-format - The format used for basic chat (Default: '+iname: +message')
date-format - The format used for +date (Default: 'HH:mm:ss')
me-format - The format used for /me commands (Default: '* +name +message')
handle-me - Whether to handle /me commands (Default: true)
time-offset - If defined, will offset the time by that many hours from GMT. This is not an offset from your current timezone.
For example, having the value as -1 will set the timestamps to use GMT-1. Not having this line will set the timestamps
to be your servers current timezone. (Default: Not set)
=============
Permissions
=============
ichat.format.color - Allow this group/user to use color in their chat messages.
ichat.format.formatting - Allow this group/user to use formatting in their chat messages.
ichat.color - Allow this group/user to use both color and chat formatting in their chat messages (Legacy)
ichat.reload - Allow reloading the iChat config
=============
Commands
=============
/ichat reload - Reload the iChat config file
=============
F.A.Q.
=============
Q) Why is the timestamp wrong when people chat?
A) Please make sure you have no defined the "time-offset' line in your config file if you want to use your servers time. If you are using an offset, be aware that the offset is from GMT, and not from your servers current time.
Q) Why is my custom message format not working? I just get the default output. Or output with no variables filled in.
A) If you're using Permissions 2.1, make sure your Permissions config file is named "{worldname}.yml" where {worldname} is the name of your world. If you're using Permissions 2.0, make sure your Permissions config is named config.yml
Q) How do I set the brackets color to the same as the group?
A) Normally you have the brackets in the message-format variable, but you can just as easily move them into prefix/suffix and that way they can be per-group colored!
Q) Why is my entire string colored? I just put a color code beside +name!
A) A color code will persists until another color code is encountered, or the end of the line is reached. To change the line back to white use &f after the variable/string you want colored.
Q) Why are my OPs names red?
A) Essentials has this functionality built in. Change "ops-name-color" to 'none' in your Essentials config file.
Q) Why does {PluginX} not work with iChat?
A) There's a good chance it does, but you need to use +displayname instead of +name.
Q) Why does Towny not work with iChat?
A) iChat no longer uses %1$s for the player name, it uses player.getName() and player.getDisplayName(), until such a time that Towny is updated to use the proper method of setting a players name (Set their displayName) it will not work with iChat.
Q) iChat is not reading my prefix/suffix from my Permissions handler, why not?
A) iChat uses its own Variable Handler to deal with prefixes/suffixes/variables, this allows it far more flexibility than could be offered from any Permission handler, and allows you to completely change Permission handlers without needing to redo your entire variable setup.
=============
Changes
=============
[Version 2.6.3]
- Update bPermissions hooks
- Update MCStats to v6
[Version 2.6.2]
- Added support for Privileges
- Added support for a timezone offset
- Added MCStats metrics tracking
[Version 2.6.1]
- Resolve issue where I accidentally cancel all plugin tasks. Oops.
[Version 2.6.0]
- Implemented the AsyncPlayerChatEvent.
- Resolved issues with interaction between iChat and plugins such as Factions.
- More strict caching of data
- Implemented a time-based cache refresh. This is due to not being able to make the calls I require in an ASync event.
- The refresh rate of the cache is configurable in the config.yml. It is not recommended to set this any lower than 100 ticks (5 seconds).
[Version 2.5.9]
- Revert changes to VariableHandler
- Revert to using PlayerChatEvent as Bukkit itself is not thread safe
- Add /me permission/config
- Hopefully resolve NPE in loadConfig of VH
- Add support for GroupManager
[Version 2.5.8]
- Add ichat.format.color/formatting permissions for more customization
- Switch to the new "AsyncPlayerChatEvent"
- Thread-safe VariableHandler
- Build against 1.3.1
[Version 2.5.7]
- Fixed issue with players saying +m in chat duplicating chat message
[Version 2.5.6]
- Implemented my own dYamlConfiguration class for loading variables.yml, this is required as Bukkit's config class lacks Unicode support
- Use Bukkit's implementation of addColor, as it's faster than the RegEx I was using
[Version 2.5.5]
- Color the rest of the "should not exist" color spectrum
[Version 2.5.4]
- Added new &k color code
- Color codes now case insensitive
[Version 2.5.3]
- Updated iChatMeEvent for new event system
[Version 2.5.2]
- Updated for bPermissions 2.9.0 (Requires 2.8.0 or later)
[Version 2.5.1]
- Quick update to event handling for 1.1-R5 spec
[Version 2.5.0]
- Added world variables for further customization
- Updated event handling to 1.1-R3 spec
[Version 2.4.5]
- Fixed reload command not reloading config properly
[Version 2.4.4]
- Updated to new FileConfiguration class
- Fixed bypass exploit for colors in messages
- Multi-world support for variables.yml
- Resolved an issue with /me not reloading player variables
[Version 2.4.3]
- Permissions overhaul. No longer require group.{name} node unless not using a permissions handler
[Version 2.4.2]
- Fixed issue with inheritance in Permissions
- Implemented start of online time variable. Need output format.
[Version 2.4.1]
- Remove plugin-specific group referencing. All groups are now managed via group.* nodes,
the exception being pure Permissions 2.x/3.x
- Fixed /ichat reload not reloading variables.yml
- Updated /me to use BroadcastMessage
[Version 2.4.0-final]
- Took out variable caching, there's no hook for PermissionChange.
- Updated README to include info on group.* nodes
[Version 2.4.0-beta]
- Merged all branches into one
- Supports Perms 2.x/3.x, SuperPerms, GroupManager
- Added a more advanded API based on the mChat API
- Massive thanks to MiracleM4n for code and concepts
- All variables are now retrieved from variables.yml instead of Permissions
- Removed censor code
[Version 2.3.2-p3]
- Set Permissions as a dependency in plugin.yml
- Added Permissions 3 support to the -p3 jar
[Version 2.3.1]
- Added iChat.ichat.parseChat(Player, String, Format) API
- Added hook for /me chat formatting using the "me-format" config option
[Version 2.3.0]
- Added external iChat.ichat.parseChat(Player, String) API
[Version 2.2.3]
- Added +displayname/+d for player.getDisplayName()
[Version 2.2.2]
- Updated to latest RB
[Version 2.2.1]
- Updated how Permissions is loaded
[Version 2.2.0]
- Added the ability to have an unlimited amount of variables in message-format
- Changed versioning scheme
[Version 2.11]
- Now uses per-world permissions information
[Version 2.10]
- Allow admins to enable color on a permissions basis
[Version 2.09]
- Another small update to Permissions (Returned false when I should have returned true)
[Version 2.08]
- Pushes PacketCollisions PermVersion change. Fixes issues with 2.5.2
[Version 2.07]
- Added +time tag
[Version 2.06]
- Added +world tag
[Version 2.05]
- Ignore whether the plugin is GM, just treat everything as Permissions! Means you need FakePermissions.
[Version 2.04]
- Added the ability to use variables in the suffix and prefix (More customizeable messages)
[Version 2.03]
- Verify that all available variables aren't null before calling parse
- Fixed crash caused by color code at end of message (Basic fix, added a space)
[Version 2.02]
- Fix for possible NPE
[Version 2.01]
- There's a bug in Permissions 2.1 in getPermissionString, switched to getUserPermissionString
[Version 2.00]
- Initial re-write of Niji's plugin.
- Added Permissions 2.0/2.1, and GroupManager support.
)
