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

    tony687

    is this compatible with jobs?
     
  3. Offline

    Rsccman

    yes it is! i always use ichat expecialy with jobs!
     
  4. Offline

    DJ411

    Is there any possibility that i can have different colored world tags? Like i have a Creative Survival and Nether. Creative and Survival can have two different colors and Nether can be red but this in the ichat.
     
  5. Offline

    Drakia

    Just set up per-world variables that all groups have.
     
  6. Offline

    Sleaker

    I think he was wondering about having the world name colored differently for people chatting on different worlds
     
  7. Offline

    Drakia

    Yes, set a variable called "worldColor" to "&e" in the nether, "&f" in whatever other world (Have a base group (Probably "default") that every group inherits from, this is how all of my groups are setup), set the format to have "[+{worldColor}{world}]" in it, and done.
     
  8. Offline

    DJ411


    And i do this where? i have ichat config open

    Code:
    message-format: '+prefix+suffix&f+name: +message'
    That is how my format is. World shows up at the beginning like "[Survival][Admin]Name: text here" idk how but it does. in the format would i do this?

    Code:
    "[+{&2}{Survival}]""[+{&3}{Creative}]""[+{&4}{Nether}]"+prefix+suffix&f+name: +message 
    or am i not understanding this part?
     
  9. Offline

    tony687

    then how do u get the job title beside the rank?
    i want: [Hunter][Admin]tony687:test
     
  10. Offline

    Sleaker

    In your Permissions plugin.. setting alternate colors per-world requires altering World-based permissions on base-groups. giving each of them a custom variable, then referencing that custom variable in iChat.

    so you'd give the base group a prefix of 'Survival' on the survival world with a variable name of 'worldname'
    and you'd re-use the 'worldname' variable on nether, and have it be 'Nether'
     
  11. Offline

    Rsccman

    well thats the give and take...the best you could do would be ;admin; hunter tony using 'suffix' 'displayname' method
     
  12. Offline

    Drakia

    Your world name is being added by something other than iChat.
    Variables are defined in your Permissions 2 config file.
     
  13. Offline

    kroltan

    Hey, i got a suggestion, or two:
    1. censored character list
    Would take random characters from the list
    example:
    Code:
    censor-list: ['justin','foo']
    censor-char: ['#','@','$','%']
    User Says: justin
    Output: %#$@%$

    2. censored character word
    Would replace the censored word with part of the censor-word
    example:
    Code:
    censor-list: ['justin','foo','holyshi']
    
    censor-char: 'badwordsaid'
    User Says: foo
    Output: bad

    User Says: justin
    Output: badwor

    User Says: holyshi
    Output: badword
     
  14. Offline

    Drakia

    I plan on removing the censoring when I update to SuperPerms, I never should have added it and only did because the existing iChat had it. There are many far better plugins for censoring.
     
  15. Offline

    Rsccman

    ia ctualy like the cencor.... i have people under the age of 17 on my server and i dont condone underage cussing
     
  16. Offline

    Drakia

    To me it's not really something that belongs in a formatting plugin. It's also a terrible censor lacking features, and I don't want to add new features because again it doesn't belong in iChat.
     
  17. Offline

    SeeD419

    I've been using this plugin for quite some time. Never had any issues. Everything works as described, usually with dev builds too.
     
  18. Offline

    1994mat

    Does Factions work with this?
     
  19. Offline

    defthefirst

    Hi, i've a problem with permissions 3.0 and Ichat.
    In permissions SQL the default world group doesn't work, so all my new players are in the group named "default", i dont want to touch Permissions, but i want to edit the Ichat version for Permissions 3.0....
    Juste add something like
    if (group.contains("Default")) group = "Guest";
    any way to get the sources ? seems the sources on github are for the 2.7, if i edit that's works but the suffix/prefix are broken...
    Thanks :D
     
  20. Offline

    Drakia

    https://github.com/TheDgtl/iChat/tree/perm3
     
  21. Offline

    RugRats

  22. Offline

    Drakia

    Depends what plugin you're using for mute and whether it allows blocking of /me or not?
     
  23. Offline

    RugRats

    I use essentials to mute and essentials has /me and if you mute someone they can't use /me but if you add ichat and mute someone with essentials they can use ichat's /me to talk :p
     
  24. Offline

    Taxick

  25. Offline

    Drakia

    @Taxick "(From the time it opens, until somebody talks)" I need more log. Also you didn't post your full Permissions config, I need to see users too.
    @RugRats There is no way I can tell if sombody is muted, Essentials implements their me/mute command in a stupid way. I will add a /me permission in a future version.
     
  26. Offline

    RugRats

  27. Offline

    Taxick

    Here is the full log, so you can see a little chat at the end: http://pastebin.com/BGmAJGaD

    And here is my users.yml: http://pastebin.com/3V3sJjUt

    Btw.. I have added the whole permissions folder to the post, so you can see the file structure
     

    Attached Files:

  28. Offline

    Jayjay36

    [​IMG] Well this is what my permissions say? i cant find a permissions.yml because i have my world folder and 3 other note documents like this... [​IMG] How do i fix this? The group doesnt show up in game and i think this is why.
     
  29. Offline

    Jndarazi

    Hi, Jobs installed successfully and no severe errors or anything. I have iChat installed. When I type "Hi" in chat during minecraft, all that shows up is my name and the message i typed. I have joined a job but i want to say Journeyman Builder {name}: message.
    i have latest craftbukkit for 1.7.3 and i also have the latest version of jobs
    thank you!
     
  30. Offline

    Jayjay36

    drakia what do i do if my console says my permissions.yml folder is empty? when it isnt
     
  31. Offline

    defthefirst

Thread Status:
Not open for further replies.

Share This Page