CurseBan
Current Version: 1.3.2.1
Recommended Build: 1.3.2-R1 (Craftbukkit build - 2377)
IMPORTANT: With 2.3.1b, matching has been changed. Please see the release notes for additional information
About
What is this?
Ever had a player flaming constantly? Or maybe you want to have a family-friendly server? Or you want to stop people from asking for diamonds? Now you don't have to worry about that anymore: CurseBan allows you to add "stalk words" - Whenever a player mentions one of them, he gets kicked. At the same time, the plugin keeps track of a "curse value" for every stalked words. This curse value is added to the players point count every time he uses such a word. You can define commands that should be executed once a user reaches a certain threshold, and a cooldown to remove points.
How does it work?
Every curse/banned word is assigned a certain point value. Every time a player uses one of these words, the word's point value is added to that players total count. Then, the command associated with that total value is executed. If none is associated, the next lowest is executed.
Commands, Permissions and Examples
Commands
- /cb - Displays help
- /cb list - Lists the current stalk words
- /cb add [word] <threshold> - Adds the word with that ban threshold to the list. If no threshold is given, 5 is used
- /cb remove [word] - Removes that word from the list
- /cb pardon [player] - Sets that player's kick count to 0 (Note: Will not unban if he has been banned)
- /cb pardon-all - Sets the kick count of all players to 0( Note: Will not unban if they have been banned)
- /cb save - Save all files to the disk. Handle with care, this will overwrite and changes made to the files that have not yet been reloaded.
- /cb set value [curse] [value] - Sets the curse point value of the curse
- /cb set matching [curse] [matchtype] - Sets the matching for this curse (Allowed: default, default-ignorecase, literal, literal-ignorecase, regex, regex-all-lower)
- /cb set kick [message] - Sets the default kick message
- /cb set command [value] [command] - Sets the command to be executed whenever a player reaches or passes value
- /cb listpoints [player] - displays points for a specific player (case sensitive)
Permission nodes
(Note that any node can be represented by its parent node - You can use cb.admin.* instead of typing in every node one by one)
- cb.admin.ignore - You won't get kicked for cursing
- cb.admin.pardon.all - Will set the kick count of all players back to zero. Will not unban them
- cb.admin.pardon.single - Will pardon single player. Also no unban
- cb.admin.add - Add curses to the list
- cb.admin.remove - D'uh
- cb.admin.save - Allows to save files
- cb.admin.set.value - Allows to set the curse points value of a banned word
- cb.admin.set.matching - Allows to set matching for a word
- cb.admin.set.kick - Allows to set the default kick message
- cb.admin.set.command - Allows to set a new or existing command to be executed when a point value is reached
- cb.list - Allows to see a list of all stalked curses
Example Usages
- Stop cursing: /cb add shit
- Stop people from typing in ALL CAPS: /cb add r:[A-Z]{3} will kick for 3 or more consecutive uppercase letters
- Give people diamonds if they say "supercalifragilistic": /cb add i:supercalifragilistic 9000, in the config file, put 9000: give %name% diamond 64;cb pardon %name%
Examples
/cb add shit - The list now contains the word shit, with default value 5
/cb list -> "[shit]"
/cb add fuck 10 - The list now contains the word fuck, with a value of 10
/cb list -> "[shit, fuck]"
/cb set command 0 kick %name% - Kicks a player whenever he swears and has more than 0 points (Basically, always) (Note that %name% is a variable used to represent the player's name)
/cb set command 10 jail %name% - Jails a player whenever he swears and has more than 10 points
Player A joins...
A: "This server is shit!" -> "shit" has a value of 5 -> A now has 5 points -> 0 < 5 < 10, so the "kick" command is executed
A rejoins...
A: "What the fuck, man?" -> "fuck" has a value of 10 -> A now has 15 points -> 10 < 15, so the "jail" command is executed
All this can also be done by editing the yaml files created in /plugin/CurseBan - see this page for more information: http://dev.bukkit.org/server-mods/curseban/pages/how-to-use-the-yml-files/
Misc
ToDo
- Add the ability to tell the player their bad word they said using %word% (You'd be able to add this to the jail sign (IE - Swearing: 'shit' ))
- Stop the server from overwriting files saved to the server by the server owner after a restart.
Changelog
v1.3.2.1:
- Changed version number to reflect current MC version it is configured for. (1.3.2) with additional build number for this (.1)
- Fixed issue 18 and 20 for issues with PlayerChatEvent (essentially replaced this even with AsycPlayerChatEvent) This seems to have resolved this issue, but I'm not entirely sure to be honest. Please report any issues you find to the ticket system. Do not post here.
Note this version will NOT work with tekkit servers. Use version 2.5.0 for Tekkit version 3.1.2.
v 2.5.0: -First release by new project owner GokouZWAR
- Fixed points being added to players instead of taking them away over time.
- Added console tracking for player's points so you can see when the system takes away player points, and how much was removed and when.
- Updated for Craftbukkit 1.2.5 - R4
- Added a few things on this page (commands that were missing, comments, and old missing revision information)
v 2.4.0: - (don't know if all these were added but I found these on the update page, possibly things he wanted added or had fixed in this version, not entirely sure. They were marked 2.4 so I'm going with this as the last updates. -GokouZWAR)
- (Hopefully) Fixed config not being saved on shutdown
- Fixed /cb set matching setting the wrong option
- Added: Logging to save methods
- Added: Reload command (/cb reload <all/config/curse/count>). Permission node: cb.admin.reload (alternatively, permission for one file only can be given by cb.admin.reload.<file>)
- Added: List command (/cb listpoints [player] - Player is optionally, omitting it will display all). Permission node: cb.admin.listpoints
- Added: Config option "save": Determines how files should be saved, in addition to the shutdown save:
- always: Save every file whenever it is modified
- config: Save the config file when modified
- curse: Save the curse file when modified
- count: Save the count file when modified
- Multiple options are possible: "save: config,curse"
v 2.3.3:
- Update to CraftBukkit 1.2.5-R1.0 (Phew, finally)
- Extended logging to include the message in which the word was found.
v 2.3.2:
- Updated to R6/1.2.3-R01
- Removed any deprecated API
- Included new matching, see release notes for more information
v 2.3.0:
- Added variable for the config file: %points% is replaced by the number of points the player has
- Implemented http://dev.bukkit.org/server-mods/curseban/tickets/8-log-chat-entry/ : Added "log-actions" option to the config file (default: true). This logs: The name of the player, the word that triggered the filter, the commands issued in return and the points of the player.
v 2.2.10:
- Moved the always-kick check behind any executed commands - This should fix bug #6 (http://dev.bukkit.org/server-mods/curseban/tickets/6-still-wont-ban-no-obvious-errors-tho/) which caused the plugin to not perma-ban people
v 2.2.9:
- Updated to 1.1-R3
v 2.2.8:
- Security patches
v 2.2.7:
- Command lists are now separated by both ";" and " ;"
- Version number displayed on startup and shutdown
v 2.2.6:
- Fixed Bug #2 (#3, #4): NullPointerException in onClientChat
v 2.2.5:
- Changed indenting of the .yml files
v 2.2.4:
- Fixed null-pointer-exception after using /cb pardon-all
- Added support for multiple commands
- Added /cb save
v 2.2.3:
- Updated to MC 1.0.* / CB 1.0.1-R1
v 1.2.3:
- Added cooldown (See: "How to use the .yml files")
- Added command: /cb set literal [curse] [true/false]
- Added permission node: cb.admin.set.literal
v 1.2.2 (Final and beta release notes merged):
- Updated to RB 1337
- Rework of the curse punishment system
- Switched everything to Yaml
- Added literal matching: A * in front of the word if using ingame commands, or the "literal-match" option in the Curses.yml
- Fixed Curses not being loaded properly (If you already added curses, but they arent showing up ingame, rename "Curse Point Value.yml" to "Curses.yml"
- Custom commands possible
v1.1.2:
- Updated to RB 1317
- Hopefully fixed PEX issue
- Skipped v1.1.1, derp
v1.1.0:
- Updated to RB 1240
v1.0.0:
- First release
Contact
Ticket here or contact me on www.mcnations.net. Email: administrator at mcnations Dot Net. Latest version in use will be on server.mcnations.net:25599 - running Tekkit.
Great Plugin. Even though I have some ways you could make this perfect for me. I use this plugin to Insta Perm Ban people for saying certain words. And then I use another plugin to censor normal swear words like this: "" Maybe inplement the option to pick between a kick or simply censor the word and give the player a "Warning Message" in the chat. Like "Swearing on this server is not.. And so on", and make that message customizable in terms of color and the message desplayed. Also, I've noticed the ban feauture of this plugin is it's own. The ban message is "The Ban Hammer has Spoken" I think, or something similar like that. I use the Ban Feauture in Essentials, wicth I think is one of the most common ban systems to use. So would you be able to add the ban feature of Essentials into CurseBan or is this simply not possible. If not, would you be able to make the ban message for this plugin customizable, so you can redirect people to your forum so they can appeal their ban? Oh, and here's another idea, to make temp bans an option too. There's some ideas for you, to improve this plugin haha. Enjoy. ;)
Does this plugin support jailing for specific amounts of time? On my server the penalty for swearing is 15 mins in jail so this would be extremely useful.
@Mario00037
In the ticket I submitted versions 2.2.4 and 2.2.5 both failed without spout being loaded.
@paulj1x
I think because Spout had an update, Curseban has to update to work with it.
In the release notes for 2.2.4 you mention: "Also, this will overwrite any changes made without a /reload" Is there a /cb reload command? This didn't seem to work.
Also, I've seen references to 5: kick ... and '5':kick ... (with and without quotes) Can you verify which is correct?
Similarly with the command part, you show 5: kick but when you use a set command you get '5': 'kick'
I updated to 2.2.5 and curseban stopped banning people. Otherwise it seems to add words and so forth. Maybe the same issue as the posted ticket, I'll try without spout. Or should I try with an updated spout?
@Boreeas
I added a Ticket. Can you please take a look at it?
@fogest
Done, I think. Check 2.2.5
@Boreeas
Thanks, I would love it if you did that!
@fogest
I'll see if I can change the format.
@paulj1x
It sadly still needs approval from the staff.
@Boreeas
Thanks Boreeas. But how do we get 2.2.4? It doesn't look like you've posted it yet.
@Boreeas
Yeah but last time I went to try and edit it I found it confusing because it was all bunched together.
@fogest
I think you can edit it right now, too - open the yaml file that has been created with a text editor of your choice, and edit away. The commands are not supposed to be prefixed by a forward slash, so it would be like: 5: kick %name%;broadcast %name% has been kicked for cursing
@paulj1x /save-all won't be possible, sorry - Save-all is intended to only save worlds, not plugins I've added /cb save, though, to save all files
@Boreeas
Great! I would love for it to say that as well so that I can have a message displayed to everyone saying the user has been warned. Or jailed, etc.
As a new feature is it possible to have a config file where we can manually edit the different levels rather then doing it in game? And I always have wondered are we suppose to when using commands use them with a / in front or not. For example would it be /jail or just jail?
Hmm, I thought I had tickets enabled. Anyways, the bug is fixed, an updated version of the plugin will be uploaded soon, with other feature requests.
@fogest
I don't see a ticket tab for this plugin.
@paulj1x
Report it in a ticket form. I'm sure dev's are always looking to fix bugs and add new features!
Boreeas, are you interested in more error info like post #11? I'm getting a lot.
I notice that when somebody curses, the chat line with the curse word is not displayed. A nice added feature, but it would be nice to see what the person said. For example, if you had the word "ass" and the person said "associate" then you could see this and change the literal matching. A nice feature would be to keep the sentence out of MC but display it in the log.
By the way, I've started to use tempban as the penalty, you can use different lengths of time and the person sees the time when they try to rejoin. Works nicely.
@fogest
Delete the line saying 5: kick %name%
How do I make it not kick someone?