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

    Drakia

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

    Plugin Support:
    PermissionsBukkit
    bPermissions
    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, 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

    =============
    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:
    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.

    ==========
    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.

    Default variables.yml:
    ---------------------
    Code:
    # 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'
    Default config.yml:
    ---------------------
    Code:
    handle-me: true
    date-format: HH:mm:ss
    message-format: '+iname: +message'
    me-format: '* +name +message'
    iname-format: '[+prefix+group+suffix&f] +displayname'
    =============
    Examples
    =============
    To make a group colored:
    variables.yml:
    Code:
    groups:
        Default:
            prefix: '&4'
            suffix: ''
    config.yml:
    Code:
    message-format: '[+prefix+group&f] +name: +message'
    To make a single username colored:
    variables.yml:
    Code:
    users:
        Drakia:
            prefix: ''
            suffix: '&1'
    Config:
    Code:
    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
    =============
    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)

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

    =============
    Commands
    =============
    /ichat reload - Reload the iChat config file

    =============
    F.A.Q.
    =============
    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.

    =============
    Changes
    =============
    [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

    Jandalf

    &3A&4D&5M&6I&7N for example
     
  3. Do i have to put it in the person prefix or would i be able to put it in a groups prefix
     
  4. Offline

    Jeyge

    @Magister
    You forgot to say what doesn't work. Are you getting an error?

    Also, you have 2 groups: in your permissions file. You should only have 1.

    @apocalypticllama
    Either place should work.
     
  5. Offline

    Magister

    @Jeyge No errors, it just doesn't function.
    And that is an older version of permissions, the one that works with iChat.
     
  6. Offline

    Jeyge

    @Magister
    I don't believe there was an older or newer version of Permissions that allowed you to have 2 groups: in your file.
     
  7. Offline

    Magister

    @Jeyge
    Oh, I see what you mean now. But even so, the rest of the ranks don't work either.
     
  8. Offline

    Drakia

    Your permissions config is screwed up, of course it won't work.
     
  9. Offline

    PatrickFreed

    something someone posted in the Factions thread. In the first post, he links to a page describing all the configurations available, including for chests. I just thought it was lulzy and fit this situation. :p
     
  10. Offline

    iFreZzAx

    Is there anyway to make a certain group have a differnt coloured writing txt than another ?
     
  11. Offline

    Jandalf

    put a color code in the suffix of a group
     
  12. Offline

    Magister

    @Drakia Fixed it. Still not working -_-
     
  13. Offline

    Mhalkyer

    @Drakia Any chance of this being Permissions 3.x compatible? It looks like this is becoming the standard.
     
    Ratchet likes this.
  14. Offline

    Numenorean95

    Give
    Give them a special variable 'color' in permissions and use +{color}+group in the IChat conf
     
  15. Offline

    KillerBunnys122

    Make this support Permissions 3.x already... -.-

    Please?
     
  16. Offline

    Jeyge

    @Mhalkyer & @KillerBunnys122
    It will help if you let him know what is broken so he will be able to fix it when the time comes because it works just fine for many people who are using 3.x. Also, the error that preventing it from working before was fixed in Permissions 3.x quite some time ago.
     
  17. Offline

    Drakia

    Yeah, so many people say it works, then a bunch complain it doesn't. I don't run 3.x, and won't be for a while yet, so I have NO clue what you guys are saying doesn't work.
     
  18. Offline

    TerrorBite

    Drakia,

    Thanks for this plugin, it works great. (Though I have yet to get chat the way I like it due to issues with other plugins coughfactionscough.)

    Just thought I'd let you know I have no complaints!

    P.S. Running Permissions 3.1.5 and it works perfectly with iChat 2.3.1.
     
  19. Offline

    Justinwiz

    I'm running Permissions 3.x, but iChat only reads from the world based users.yml files... I run 7 worlds with MultiVerse, it would be so much easier if it could read the users and their rank from the globalUsers.yml and the globalGroups.yml. :)
     
  20. Offline

    Jeyge

    iChat doesn't pick which file it reads from, it calls an API in your permissions system called getGroup(). It is then up to the permissions system to pick what file it reads from.
     
  21. Offline

    Mhalkyer

    I was just inquiring if it was infact compatible with Permissions 3.x since the 1st post says it isn't. I'm glad to hear it works tho =)
     
  22. Offline

    KillerBunnys122

    Oh what? it does work with permisions 3.x?

    THEN I THINK IT WOULD BE A GOOD IDEA TO REMOVE THE BOLD CAPITAL TEXT SAYING ITS NOT SUPPORTED

    Don't you think so? :) Its very misleading.

    I'll go ahead and update my permissions now, thanks.
     
  23. Offline

    Jeyge

    Why? He just says he doesn't support it not that it doesn't work. If it doesn't work, then I'm sure he would be happy to have the bugs for when he does. So far, no bugs have been reported but a lot of people wanting him to fix something that isn't broken.
     
  24. Offline

    KillerBunnys122

    Because people are stupid, they think 'Unsupported' means IT DUN WORK.

    I'm assuming all the people that "say something is wrong with it" are just seeing the work unsupported and assuming, you know, IT DUN WORK. so they ask for him to fix it.

    Example: Mhalkyer & Myself. Scroll up a bit and see...
     
  25. Offline

    Drakia

    It is UNSUPPORTED as in I do not offer support if you are using it and shit breaks. I don't code for 3.x, I don't run 3.x, so if you are using 3.x and things don't work, then you're on your own.
     
  26. Offline

    Schlumpfpirat

    Wow.. I'm going to HeroChat.
     
  27. Offline

    Drakia

    Good for you?
     
  28. Offline

    Liger_XT5

    I'm using Permissions 3.X.X and works just fine.
    As soon as my ftp finishs the backup download of my server, I'll post links to my permission config and iChat config.

    Groups
    Users
    iChat
     
  29. Offline

    samw8888

    This didn't work for either version of Permissions for me - I'll post my plugins, maybe one of them is causing a conflict?
    Thanks,
    Sam
    Screen shot 2011-06-24 at 9.47.39 PM.png
     
  30. Offline

    Jeyge

    @samw8888
    Try removing Essentials.jar to see if it fixes things.
     
  31. Offline

    Liger_XT5

    what is the Nether.jar plugin? also, textwrap MIGHT be messing it up.
     
Thread Status:
Not open for further replies.

Share This Page