Inactive [CHAT] iChat 2.4.4 - Custom Chat Formatting [1337]

Discussion in 'Inactive/Unsupported Plugins' started by Drakia, Feb 24, 2011.

Thread Status:
Not open for further replies.
  1. Offline


    iChat 2.x - Custom Chat Formatting
    Version: 2.4.4
    CraftBukkit: 1337

    Plugin Support:
    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. <-- Post configs there when asking for help

    Custom chat formatting.
    Based on the idea of iChat v1.5 by Nijikokun.
    Includes code and concepts from mChat by MiracleM4n <>

    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):

    Supports Permissions (Both 2.0 and 2.1), and SuperPerms handlers (PermissionsBukkit, bPermissions, 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

    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:

    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 -

    Example (Default):
    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.

    As of iChat 2.4.3 native groups are supported in Permissions 2.x/3.x, PermissionsBukkit, bPermissions, and PermissionsEx.

    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.

    Default variables.yml:
    # iChat Variable Config
    # This is now the only method for defining variables
            prefix: '&e'
            prefix: '&c'
            suffix: ''
            prefix: ''
            suffix: ''
          prefix: '&a'
    Default config.yml:
    handle-me: true
    date-format: HH:mm:ss
    message-format: '+iname: +message'
    me-format: '* +name +message'
    iname-format: '[+prefix+group+suffix&f] +displayname'
    To make a group colored:
            prefix: '&4'
            suffix: ''
    message-format: '[+prefix+group&f] +name: +message'
    To make a single username colored:
            prefix: ''
            suffix: '&1'
    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.

    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)

    ichat.color - Allow this group/user to use color in their chat messages.
    ichat.reload - Allow this group/user to use "/ichat reload"

    /ichat reload - Reload the iChat config file

    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.

    [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.[/b]
    FFS2309, Lolmewn, wassilij and 12 others like this.
  2. Offline



    censor-list: []
    censor-color: '&b'
    message-format: '[+prefix+group+suffix] +name: +message'
    censor-char: '*'
    censor-string-color: '&b'
    censor-colored: true
  3. Offline


    Further up, when it first loads iChat, it's going to say what Permissions plugin and version it's using, tell me what it says.
  4. Offline


    Using Permissions 2.0 for permissions
  5. Offline


    Renaming the config.yml for Permissions is only required for Permissions 2.1, rename the .yml file back to config.yml
  6. Offline


    Wow, that simple huh? Thank you so much for your help.
  7. Offline


    works fine! thanks

    is it possible to make longer chats
    so that i can read what i am typing at the end of the screen and maybe to make that a bit longer so that it's possible to write 1-2 sentence ^^
  8. Offline


    good work, but could u remove the long constructor?

    EDIT: im an idiot i forget to download the new iChat:D
  9. Offline


    +name +group +healthbar +health +message can you add this to the prefix and suffix that my ingame name is notch and if someone in the group banned writes somthing: "[Banned]I´m a Noob" could you add this please?
  10. Offline


    i really dont know what u want, maybe the threadstarter knows...
    do u need help with constructing the message text or do u request a feature?
  11. Offline


    ok i want the following:
    message-format: '+prefix:+suffix'
    in the config
    and at the names or groups:
           prefix: '[User]Notch'
           suffix: '+message'
        default: false
            prefix: '[Banned]+name'
            suffix: 'I´m a Noob'
        build: false
    I think its a featrue request
  12. Offline


    ah ok:D this would be funny
  13. Offline


    yeah and if someone creates a plugin that allows you to control other players then....
  14. Offline


    @BeerBaron That's not something that can be done with a server plugin
    @Alf999111 Added in 2.04

    Version 2.04 uploaded with the ability to use variables in the suffix and prefix.
  15. @Drakia Thank you very much for taking over and updating the plugin :)
  16. Offline


    I want to change the persons name which is deteramined by what group they're in. What's the code for the players name?

        default: false
            prefix: '&e[&eOP&e] &cname:&c &f'
            build: true
                - '*'
  17. Offline


    To show a persons name you use +name, you can't "set" a persons name though
  18. Offline


    I just want it to look like this and change the name color for each group.

    [OP] Stavos: Hello
    [VIP] john: hi
  19. Offline


    To change the name color just set the prefix to (Where &c is the color you want the name):
    '&e[OP] &c'
    then the suffix to
    And the message format to
    message-format: '+prefix+name+suffix: +message'
  20. Offline


    Thank you very much the Prefix and suffix confused me a bit now I understand!
  21. Offline


    With the latest version of iChat you can change the name of a player.

    Only change the message-format to '+prefix&f: +message' and add for example the following code to a player in your permissins-config:

     prefix: '&3[Mojang] Notch'
  22. Offline


    Can you please add this note about Permissions 2.1+:

    Go to plugins/Permissions/ and rename the config.yml file to whatever your default worlds name is.

    To the OP? I didn't realize this change and wasted a bunch of time figuring it out.
  23. Offline


    The way prefixes and suffixes are added is currently somewhat unintuitive.
    For example, I gave my group the prefix 'GrouPre.' and the suffix 'GrouSuf.'
    And I gave my user the prefix 'UserPre.' and the suffix 'UserSuf.'

    This is what I got with the the following message format:
    message-format: '[+prefix, +suffix] +name : +message'

    It looks like the +name tag includes the group prefix and suffix and just tacks them on the front ant the end of the user name.

    I liked the behavior that the original iChat had, where if a user prefix/suffix was defined it would use that instead of the group prefix/suffix. With the above example that would look like this:
    Alternatively it would make more sense to add the user prefix/suffix to the +name tag instead of the group prefix/suffix like it is doing now. With the above example that would look like this:
    I'm using GroupManager, incase that might make a difference.
  24. Offline


    It's already in the FAQ section, has been since the first person ran into that issue
  25. Offline


    @Drakia You seem to be correct, thanks XD

    Oh, also can you please make it so the color codes aren't written to the server console?
  26. Offline


    Are you running any other chat plugins? This plugin does not touch the users name. It will only put a prefix where you out +prefix and it behaves the same as the old iChat in the fact it uses user prefix first, and group if user doesn't exist.

    I can't stop color codes from being written to console, bukkit outputs what the client receives

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: May 10, 2016
  27. Offline


    Hi I like iChat but now I cant have any color why ?
    message-format: '[+prefix+group]&f +suffix+name&f: +message'
    by prefix I have '&4' and suffix: '&c'
  28. Offline


    Ah yes, essentials was messing with it, disabling its chat component got it to behave, my bad [​IMG]
  29. Offline


    Works like a charm, thanks a lot!
  30. Offline


    Can you disable the version check ? because when i reload the server, i have to wait ~1 minute untill the reload is done. (sorry for my bad english)
  31. Offline


    I don't get what you mean by version check? This plugin doesn't check any version, it just outputs what permissions version you run.
Thread Status:
Not open for further replies.

Share This Page