[CHAT] iChatMessages 1.0.1 - Custom Messages Formatting

[Drakia]

iChatMessages - Custom Messages Formatting
Version: 1.0.1
CraftBukkit: 1.1-R4 and later

Plugin Support:
iChat 2.x (REQUIRED)

If you are requesting help, post your server log, your entire Permission config file (As well as what it's named), your iChat config/variables files, and your iChatMessages config file. This information is REQUIRED for me to help you.
http://pastebin.com/ <-- Post configs there when asking for help

=============
Description
=============
iChatMessages is an iChat addon that allows you to format join/leave/kick messages
This plugin REQUIRES iChat-2.x (viewtopic.php?f=2&t=4)

Download (Direct JAR): http://thedgtl.net/bukkit/iChatMessages.jar
Source: https://github.com/TheDgtl/iChatMessages

=============
Features
=============
Through the iChat API layer this plugin has access to all of a users variables defined for iChat.
Colors are supported in all parts of the formatting.
You can pick and choose which messages to customize, you don't need to customize what you don't want to.

=============
Formatting
=============
Message formatting is defined in the file plugins/iChatMessages/config.yml
The message formats can contain colors and variables as explained below.
To use colors use the standard Minecraft color codes found here: http://www.minecraftwiki.net/wiki/Class ... olor_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
+reason - The reason for a kick (Only available in kickFormat)

Example (Default):
joinFormat: +iname has joined the game
quitFormat: +iname has left the game
kickFormat: +iname has been kicked for +reason

As with iChat you can define any number of custom variables in your iChat variables.yml file and use them in iChatMessages formats!

=============
Permissions
=============
ichatm.reload - Allow reloading the iChatMessages config

=============
Commands
=============
/ichatm reload - Reload the iChatMessages config file.

=============
F.A.Q.
=============
Q) Why don't you have any FAQs?
A) I do now

=============
Changes
=============
[Version 1.0.0]
- Initial release of iChatMessages. Basic feature set.

[Drakia]

If requesting help please create a new topic, thank you.
As this is a brand new plugin there may be issues, if you encounter any bugs or wish to say thanks, feel free to post in this topic

[Inscrutable]

Zap, Flash, like a genie you deliver the goods! Thank you, I'll try it out with 1.23 and see if I can break it

[Drakia]

Considering it took a whole of an hour or so to code and test, there's a good chance you will

[Drakia]

Awe I already found a bug, old version of CraftBukkit cry if you're missing onDisable()

[Version 1.0.1]
- Old versions of CB don't like missing onDisable()

[Drakia]

And now a post on how to make per-user (Group/World as well!) messages! Yayyyy~

So, as iChatMessages hooks into iChatAPI for variable handling, it means we can use any of the fancy stuff we can do in iChat!
Here is an example of giving two users different join messages:
plugins/iChat/variables.yml

Code: Select all

# The following lines define our users, and their custom 'join' variable
users:
  Drakia:
    prefix: '&a'
    join: 'has joined the game, get him!'
  ZeroPoke:
    join: 'has appeared, everybody run!'
# This section defines a 'join' variable for the world 'world'. This is needed for users who don't have a 'join' variable defined
world:
  join: 'has joined the game'


plugins/iChatMessages/config.yml:

Code: Select all

joinFormat: '+time +{prefix}+displayname&f +{join}'


And the end result:


Using the variables.yml file you can provide a custom message for any player, group, or even whole world, your imagination is the limit!

[ZeroPoke]

And now a post on how to make per-user (Group/World as well!) messages! Yayyyy~

So, as iChatMessages hooks into iChatAPI for variable handling, it means we can use any of the fancy stuff we can do in iChat!
Here is an example of giving two users different join messages:
plugins/iChat/variables.yml

Code: Select all

# The following lines define our users, and their custom 'join' variable
users:
  Drakia:
    prefix: '&a'
    join: 'has joined the game, get him!'
  ZeroPoke:
    join: 'has appeared, everybody run!'
# This section defines a 'join' variable for the world 'world'. This is needed for users who don't have a 'join' variable defined
world:
  join: 'has joined the game'


wouldnt you also want default for quit too and kick as well

[Drakia]

The example was for join messages, I'm fairly sure people can extrapolate that to other messages too

[ZeroPoke]

The example was for join messages, I'm fairly sure people can extrapolate that to other messages too

BAWAHAHAHAHAHAHAHAHAHAAHHAHAA Your the one ALWAY and I mean ALWAYS complaining about dumb users. And you just said they can figure it out?

[Drakia]

The example was for join messages, I'm fairly sure people can extrapolate that to other messages too

BAWAHAHAHAHAHAHAHAHAHAAHHAHAA Your the one ALWAY and I mean ALWAYS complaining about dumb users. And you just said they can figure it out?

I state quite clearly in that post that it is

an example of giving two users different join messages

You are currently throwing yourself into the group of "dumb users".

[ZeroPoke]

Im talking about the third example showing the default join.

Too prove a point Im more then willing to join their group. Especially because I tend not to read either... Well till there a problem I cant figure out.

Edit: I actually enjoy that group now that I thing about it. Watching you flip out is fun.

[Drakia]

Im talking about the third example showing the default join.

What third example? There's only one example that shows giving two users a unique join message, and everyone else a default join message...

[ZeroPoke]

thats three. On your counting groups I was counting actual examples xD

[Inscrutable]

Code: Select all

# iChat Variable Config
users:
  MsInscrutable:
    prefix: '&aTree '
    join: 'is here instead of making Inscrutable Dinner'
  Inscrutable:
    prefix: '&4Mad '
    join: 'never wipes his feet, get your own supper :P'

A slice of Domestic Bliss. Great Plugin, lots of fun

[ZeroPoke]

hahahaha Nice

[sentriz]

Hi, wonderful plugin when used with TagAPI. One thing I would love to see in it though, would be death messages support.

config would be like:

enableJoin: true
enableQuit: true
enableDeath: true
joinFormat: +{suffix}** +{colour}+name +{suffix}has joined the game.
quitFormat: +{suffix}** +{colour}+name +{suffix}has left the game.+{leave}
zombieDeath: +{suffix}** +{colour}+name +{suffix}was slain by zombie.
creeperDeath: +{suffix}** +{colour}+name +{suffix}was slain by creeper.
playerDeath: +{suffix}** +{colour}+name +{suffix}was slain by %player%.
playerformat: +{colour}+name //%player% format; their {colour}, and their +name, not the killer's, hope this is possible.

I really hope you could do this, Drakia. It would be amazing.

Thanks in advance,
sentriz.

[Unknown_Mage]

When I format messages for quit, it doesn't seem to do it properly sometimes.
Sometimes it does the default quit message, and the rest of the time it does a different format.

I have format setup like this.
quit: +{wName} +displayname +{quit}

Sometimes, the displayname doesn't show up and instead replaces it with the realname.
Join format is the same also, but it doesn't have this problem.

No errors when I do this, so I don't have a point in showing console.