ChatSuite
Notice! I am currently very busy with both work and school. Please refrain from feature requests and only post bug reports, as I am unable to do extra work at this time.
ChatSuite provides an advanced Chat Management interface for servers, with channel and multi-world support. IRC support is planned for the future. A comprehensive command structure is provided, which you can access by typing /chatsuite ? or /cs help.
Table of Contents
- Github Wiki
- Default config.yml - Examination - Layout
- Examples
- Source
- Jenkins 5.1. Use of the plugin builds from Jenkins is unofficial, unsupported and unapproved by BukkitDev Staff!
Features
- Channels, and permissions support for the creation thereof. (Node: chatsuite.create)
- A powerful localization file, to control the messages that users receive when requesting help. (chatsuite.help)
- Whispering and AFK systems (chatsuite.whisper and chatsuite.afk)
- ... and more!
Information
I am currently working on documentation, which can be found at my github wiki.
Commands
The following is a very brief overview of the commands available via this plugin, many of which can be changed.
note: CommandBook's CraftScripts registers the command /cs, which will supercede this plugin's /cs (which is only an alias).
note 2: ChatSuite v2.0 (currently in progress) will have a completely redesigned command system. /cs will be used minimally, in favor of more relevant command names (/join, /part, etc) for the plugin.
- /chat ? (chatsuite.help)
- /chat [page] - Show paged help. The command pages have additional information.
- /chat afk ? - Will show command usage and syntax for the afk command. (chatsuite.afk)
- * /chat afk "[message here]"
- /chat whisper ? - Will show command usage and syntax for whispers. (chatsuite.whisper)
- * /w [player] "[message here]"
- /chat nick [nick] / /chat nick [player] [nick] (chatsuite.nick)
- * /nick - Reset your nickname.
- * /nick [new nick] - Change your nickname.
- * /nick [player] [new nick] - Change another player's nickname. (requires chatsuite.nick.other)
- * /nick [player] --reset - Resets the specified player's nickname. (requires chatsuite.nick.other)
- /chat target [target] (chatsuite.target)
- * /target c:[channel] - Sets your target to the specified channel. Can also be used without the c: prefix.
- * /target p:[player] - Sets your target to the specified player. Similar to whispering. Can be used without the p: prefix.
- /chat 4 / /chat 5 - Will show command usage and syntax for channel-based commands. (various)
- * /create [channel] (chatsuite.channel.create) (/ch create [channel] [type])
- * /join [channel] (chatsuite.channel.join) (/ch join [channel])
- * /part [channel] (chatsuite.channel.leave) (/ch part [channel])
- * /invite [player] [channel] (chatsuite.channel.invite) (/ch invite [player] [channel])
- * /msg [channel] "[message here]" (chatsuite.channel.message) (/ch msg [channel] "[message here]")
- * /ch list [-all] (chatsuite.channel.list / chatsuite.channel.list.all)
- * /ch set ? / /ch set [channel] option [value] (chatsuite.channel.set)
- * * basic options
- * * /ch set [channel] color [color]
- * * /ch set [channel] permanent [boolean]
- * * /ch set [channel] owner [player]
- * * /ch set [channel] public [boolean]
- * * irc options
- * * /ch set [channel] network [irc network]
- * * /ch set [channel] channel [irc channel]
- * * /ch set [channel] enabled [boolean]
- * * /ch set [channel] key [irc channel password]
- /cs reload - Will reload ChatSuite. (chatsuite.reload)
- /cs debug - Will toggle debug mode in the server log (chatsuite.debug)
- /cs version - Will print ChatSuite's current version and build number. (chatsuite.version)
FawltyTowers
The configuration file is a bit of a monster. I'm working on ways to improve it (without complicating it), and add features (again, without adding to its complexity), so any suggestions you have are more than welcome - they're encouraged!
This may be a silly question but I'm having a hard time configuring the settings:
- So the nodes that are created 'chatsuite.groups.group' should mimic the groups we have on our server correct?
- If that is the the case then is it possible to configure the channels themselves that are created? For instance, only staff can join a staff channel, and only they can see it. Or the help channel is a different color so it is more easily seen?
- Also if a channel is created in-game then is the only way someone else can access it is by being invited by the creator?
Sorry, I think I'm having a bit of trouble wrapping my brain around the config. Any help is appreciated. =]
@krinsdeath
Commandbook doesn't allow for customizing that, in fact I don't even think it has the option to disable it. (I'm running a dev build, I see nothing)
If it's not a part of the plugin, why not make a new simple plugin which makes use of chatsuites api, then use it for an example of use of the api?
B3NW - I guess I could, it's just a bit of a hassle because other plugins (like CommandBook, for example) already mess with it. Is this something you really need in ChatSuite, or could you get it in a plugin that is better suited for it?
@krinsdeath
I see, I couldn't find the senders prefix and suffix variables, apologies. Do you think you could add customization of the login and logout mesages?
B3NW - You can include any of the numerous variables in the whisper fields. The whisper-receive field will (or should) parse the variables from the sender. The whisper-send field should parse your own variables.
FawltyTowers - If you encounter any issues, be sure to post them in my tracker.
I'm excited to try this plugin out for the server. It will be a much needed change from HeroChat if everything works out! Thanks krins!
Hey, love the plugin, jumped over from SimplePrefix and herochat.
Could you add customization for the log in and out messages which bukkit has for default? It would be a really nice addition! :)
Also, could you add a variable for the PM senders prefix and suffix? So whoever has sent you the PM you can have their information too (I like colours :P)
Thanks. Please refrain from putting stack traces in the comments; the ticket tracker is there for a reason.
Anyway, I've fixed that issue and it will be in my next build.
EDIT: @krinsdeath I do apologize, haven't familiarized myself with DEV yet :/
Is there no option for defining chat range? I get 50+ users online on my RP server, local chat is kind of a must for me ! I love the way this plugin works though, a lot!
<reply 454822="">
Tested and it appears to work perfectly fine in my latest build. I'm putting it up now.
Katorone - That should be how it works. You should only have to use /cscs [channel] "message" to say messages in other channels. If that's not how it's working, I have a bug.
I'll test this functionality now.
I really want to love this plugin... I love what it does, allow ppl to create channels and invite ppl to them etc... But I'm thinking the requirement of "" around all chats is overly complicated. Isn't it possible to let people /cscj a channel and make all text they type automatically go to that channel? It would make this plugin a lot more user friendly immho.
tmad40blue - That build shows me that you're using Multiverse 2.2 (good), but you didn't tell me what build of ChatSuite you're using. /cs version
oeniehead - Can you post a ticket in my tracker, please? I need the entire stack trace to tell what the issue is.
For me it crashes with the following error:
I'm running CB 1565
@krinsdeath
CB 1550.
Multiverse gives me this: "Multiverse-Core Version 2.2-UNKNOWN".
I would gladly update to a dev build of ChatSuite or Multiverse but I'm not sure how to compile the code on a Mac...
Add support for towny prefixes please!
tmad40blue - Can you be more specific? Which build are you using? The later dev builds will track world name changes in real time; unfortunately, this behavior was (inconvenient) not easy prior to Multiverse's 2.2 API.
If you update to the dev builds it should be easy enough. :)
World name only changes on config reload. Is this a bug, or am I doing something wrong?