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

    anon

    Yay nice to see someone taking a dead plugin.
     
  3. Offline

    ZeroPoke

    OMG worst plugin ever man you suck! :p
     
  4. Offline

    Drakia

    I'm not planning on implementing anything along those lines anon.

    Poke, you're a dick (I am the dev on the server he runs, so everybody knows, he's just kidding ;) )
     
  5. Offline

    outbreak

  6. Offline

    Drakia

    You'll need to give me more to go on that "can't seem to get it to work." In what way doesn't it work? Is it shooting lasers out of its eyes? Is it burning the moon?

    Looking over your configs there isn't anything that looks wrong off the top of my head.
     
  7. Offline

    outbreak

    Well I get this when I type something into chat on my server, And my name is plain old white no fancy name or nothing.

    Code:
    2011-02-24 22:20:48 [SEVERE] Could not pass event PLAYER_CHAT to iChat
    java.lang.NullPointerException
            at com.nijiko.permissions.Control.getPermissionString(Control.java:961)
            at com.nijiko.permissions.Control.getPermissionString(Control.java:1116)
    
            at net.TheDgtl.iChat.iChat.getPrefix(iChat.java:213)
            at net.TheDgtl.iChat.playerListener.onPlayerChat(playerListener.java:21)
    
            at org.bukkit.plugin.java.JavaPluginLoader$7.execute(JavaPluginLoader.ja
    va:160)
            at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.jav
    a:59)
            at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.j
    ava:225)
            at net.minecraft.server.NetServerHandler.chat(NetServerHandler.java:602)
    
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:590)
            at net.minecraft.server.Packet3Chat.a(SourceFile:24)
            at net.minecraft.server.NetworkManager.a(SourceFile:230)
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:70)
            at net.minecraft.server.NetworkListenThread.a(SourceFile:100)
            at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:338)
            at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:253)
            at net.minecraft.server.ThreadServerApplication.run(SourceFile:366)
    2011-02-24 22:20:48 [INFO] <0utbr3ak> test
     
  8. Offline

    Drakia

    Ah, there's a bug in Permissions 2.1, there is a || where there should be a &&
    Umm.... Give me a minute to work on a fix.
    --- merged: Feb 25, 2011 5:42 AM ---
    2.01 pushed and uploaded, that should hopefully fix that little issue :) It's odd it never showed up on my local test server o.o
     
  9. Offline

    outbreak

    Hmm Still not working for me, Here is a copy of my CMD line info from server start to current:

    http://pastebin.com/raw.php?i=B1DPqeQR

    Also a Screenshot =]
    http://img694.imageshack.us/img694/185/20110224224629.png
     
  10. Offline

    earthiverse

    ... ichat 1.5 works for me with permissions 2.1 on 432.
     
  11. Offline

    DirktheJerk

  12. Offline

    Drakia

    Weird, that should really not be causing an NPE :/ Threw in some checks to make it bypass that if there is a null value, just incase.
    Version 2.02 uploaded, fix for possible NPE
     
  13. Offline

    outbreak

    Dirk I am using the most up to date versions of well each plugin i have, I check daily for updates so its nothing on my side.
    --- merged: Feb 25, 2011 7:25 AM ---
    ok We are getting closer lmao, Not sure what is causing this one:

    http://img827.imageshack.us/img827/9826/20110225002235.png
     
  14. Offline

    Drakia

    I threw up v2.03, it'll get rid of the +suffix +prefix, etc, but it's not going to fix the underlying issue. I honestly have no clue what that issue is :/ Will look into it some more.
     
  15. Offline

    outbreak

    Not quite sure, Gonna guess it is something with permissions conflicting because I took all other plugins off my server besides Permissions 2.1 and iChat 1.3, Below is the CMD dump, No errors from iChat but still have no change in the text in game, tis just plain white.

    http://pastebin.com/raw.php?i=r6eyZvKc
     
  16. Offline

    Drakia

    I just ran it on the exact same build, exact same iChat config, exact Permissions config, and I'm getting no problems. It may be one of your other plugins interfering?
    --- merged: Feb 25, 2011 7:36 AM ---
    And your Permissions config file is named "WyHigh4.yml" correct?
     
  17. Offline

    outbreak

    Ok I did not see anywhere when i upgraded that that was supposed to be changed =], That fixed the problem sir ;).

    +10 for the quick support!
     
  18. Offline

    DirktheJerk

    obviously not, as it says you have essentialshome 211, and the essentials dev build 170. Might wanna recheck. The newest builds are 231+
     
  19. Offline

    outbreak

    Seems the thread where i first got my Essentials file from stopped at 225. Downloaded straight from the ESS website and got rid of some errors.
     
  20. Offline

    Dreadreaver

    so Im running iChat 1.5 or 1.6 just fine(the latest, cant remeber which is it) from Nijijokun, so why should I upgrade to your iChat 2.03? Did you just start a parallel project thatll get updated in case iChat from Niji wont work at some point anymore?
     
  21. Offline

    DJ_Idol

    Working great, only question is. What are the prefixes and suffixes for and how do we use them? What I'm looking to do is color-code the usernames based on group, is this where prefixes/suffixes come in?
     
  22. Offline

    Jess

    I'm not getting any errors but, whenever I type into chat it looks like this: [] username: message instead of [Admin] username: message. I read all of the instructions, and changed the permissions file name to my world name.

    Any help would be greatly appreciated.
     
  23. Offline

    Direct1221


    Please post your permissions config file please.
     
  24. Offline

    Drakia

    @Dreadreaver I started this because Niji stopped supporting iChat 1.5. There were also some bugs in it which could cause crashes (Color code at the end of a string, % bug, etc), and it had the old constructor.
    @DJ_Idol You would most definitely use this for what you want. If you just want to color-code the username, and not add their group to the message, then you'd set your message-format to something as such:
    message-format: '+prefix+name&f: +message'
    +prefix, +name, and +message are self-explanatory, the "&f" after the +name is to change the text back to white after your prefix sets the color of the name.
    And then set the prefix in the permissions config file for your world to (This goes under "info" for the specific user or group):
    prefix: '&4'
    to make their name a certain color (&4 is dark-red, the color codes are linked in the first post).
     
  25. Offline

    Jess

    Here you go ^^
    Code:
    # System is no longer used, but may become used in the future
    # Copies is for multiple-world support
    #   Put the name of the world you wish for it to be a clone of, otherwise leave it empty.
    #   Does not work for the default world.
    plugin:
        permissions:
            system: default
            copies:
    
    ##
    # Groups can contain inheritance.
    #   To make a group inherit the permissions from another
    #   group simply place the groups name in the "inheritance:" like so:
    #
    #   Example:
    #       inheritance:
    #           - Default
    ##
    #   All permissions including the asterisks must be placed in single quotes.
    #   like so:
    #
    #       - 'general.spawn'
    #
    #   Otherwise errors will happen!
    ##
    #   Globalized Permission settings:
    #
    #       If a permission contains periods (.) you can denote a globalized parameter:
    #
    #           - 'general.*'
    #
    #       This will allow you to use all general commands.
    #
    ##
    #   Single Asterisk denotes all commands:
    #
    #       - '*'
    ##
    #   To exempt a node use the - prefix like so:
    #       - '-general.time'
    ##
    groups:
        Default:
            default: true
            info:
                prefix:
                suffix:
                build: false
            inheritance:
            permissions:
                - 'general.spawn'
                - 'general.items'
                - 'general.spawn.set'
                - 'iConomy.payment'
                - 'iConomy.list'
                - 'iConomy.rank'
                - 'hg.help'
        Moderator:
            default: false
            info:
                prefix: '&4'
                suffix: '&4'
                build: true
            inheritance:
                - Default
            permissions:
                - 'general.time'
                - 'general.teleport'
                - 'general.teleport.here'
                - 'general.player-info'
                - 'hg.inv'
                - 'hg.list'
                - 'hg.inv.other'
                - 'hg.inv.other'
                - 'hg.mobs'
                - 'hg.loc'
                - 'hg.time.set'
                - 'hg.inv'
        Admin:
            default: false
            info:
                prefix: '&a'
                suffix: '&a'
                build: true
            inheritance:
                - Moderator
            permissions:
                - '*'
    
    ##
    # DarkGrave has control over all commands.
    ##
    users:
        Jhoff:
            group: Admin
            permissions:
                - '*'
        Cmatt:
            group: Moderator
            permissions:
                - 'general.time'
                - 'general.teleport'
                - 'general.teleport.here'
                - 'general.player-info'
                - 'hg.inv'
                - 'hg.list'
                - 'hg.inv.other'
                - 'hg.inv.other'
                - 'hg.mobs'
                - 'hg.loc'
                - 'hg.time.set'
                - 'hg.inv'
    
        DarkGrave:
            group: Admin
            permissions:
     
  26. Offline

    Drakia

    Post a screenshot of the terminal when you say something, and your config.yml for iChat
     
  27. Offline

    Direct1221


    Code:
    groups:
        Default:
            default: true
            info:
                prefix:
                suffix:
                build: false
    See where it says Prefix? after it add 'Default'
    like so:

    Code:
                prefix: 'Default'
    and do so for the other usergroups as well.
     
  28. Offline

    Drakia

    @Direct1221 The default message format adds the group name by default, so unless he's changed something he shouldn't need to do that. That's why I want him to add the output in the terminal and a copy of his config.yml
    Also make sure your Permissions filename is the EXACT same as your world name, it's case sensitive.
     
  29. Offline

    Direct1221

    Oh, okay >.> Didnt know that, as I always change everything myself, Please ignore me.
     
  30. Offline

    Drakia

    My best guess is his permissions file isn't named right.
     
Thread Status:
Not open for further replies.

Share This Page