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.
Anyone having problems with the curse points not going down over time but progressively going up to the point where the more points they have the faster it goes up?? I had one player in the billions of points...and I only have it set to give 10 points per swear and to go down 1 point every 10 minutes...least that's what I had hoped for...
I think there is a bug with the config saving. My config file is always empty, I tried to delete the whole folder and restart, did not help. I even copied the default config in manually but it got deleted upon restarting. Ideas?
request:
repeating the same line within like 5-10 seconds counts as a curse time configurable?
use '[A-Z]{3}'
Has anyone else been having trouble with getting it to kick people who type in caps? I have: r:[A-Z]{3} added into my config however it does not seem to work. Amazing plugin though. Very useful.
@Boreeas: Yes it has mostly fixed our issues! Thank you for your help--
I do have a request. users with /me can bypass any censors. It doesnt kick or punish those that curse using /me.
I disabled the /me command for the time being, but wouldnt mind giving it back to the users.
is there a way to put how many times they've cursed in the kick command? /kick %name% You have cursed (% amount%/15).
@CosmicVoyager
Are you using the latest version of CurseBan? (2.4.0). Also, if you edit the file on disk, please make sure to reload it into memory by issuing /cb reload <config/curse/count>
Greetings,
Changes I make to the config file keep reverting. I edit the config file and save, but later is back to the way it was.
Is there a way to reload the configuration? Should I use /cb save? How do I make changes such as setting cool-down to false stay?
Thanks
@Mokeomehit
EDIT: We found a solution: The dev version of townychat fixes it, and is stable enough to use. Or you just wait until TownyChat updates.
@Mokeomehit
Great. I'll see if I can talk with TownyChat's dev and see if there's a workaround. I sadly can't promise anything though.
Its probably townychat.
You are picking up the input from the client fine.
Its just not cancelling the event before it gets sent.
Works fine without TownyChat
@Mokeomehit
I am having trouble reproducing the problem, so I expect it to be an incompatibility problem with the Chat Plugin you mentioned you are using. If you temporary remove it, will chat be blocked then? If so, I might be able to find a work around with the other plugin dev's help.
Any idea when you might get the chat not being blocked fixed?
This is a huge plugin for my kid friendly server.
Many thanks!!!
@CosmicVoyager
default - Matches the text anywhere in chat, case-sensitive default-ignorecase - Matches the text anywhere in chat, case-insensitive literal - Matches the text word by word, e.g. "ass" will match "ass" but not "grass" literal-ignorecase - As literal, but case-insensitive regex - Tries to match the regular expression to the text. More information can be found here. regex-all-lower - Converts the text to lowercase letters, then tries to match the regex against it (Simplifies the expression, e.g. [a-z] instead of [a-zA-Z])
Matching can be changed by:
There is also /cb set matching, but it is broken right now and will be fixed in the next version
Please define what these are: "default, default-ignorecase, literal, literal-ignorecase, regex, regex-all-lower"
What is the default matching and how do I change it?
Thanks
Thanks for the input. I just want to make sure that you know that it was adding the literal-match: literal-ignorecase . I have changed it to the correct format and it works correctly.
Thanks to both of you! btw, This is a great plugin!
Right, there was a bug in the set command which updated the wrong setting. It has been fixed and will be uploaded as soon as the other fixes have been made. Bugfix-TODO:
EDIT: In case it wasn't clear, the correct format is the one described by @paulj1x: <word>: {matching: <matchtype>, value: <point-value>} literal-match is deprecated.
@csminecraft
Yeah, I'm not sure that modifications work properly and I'm also not sure if all the docs have been updated with the new format.
@paulj1x
Thats what I thought it should look like but using the commands like I mentioned before gave me that result. The documentation isn't very clear and I figured it wasn't updated with the new setting. I will try it and see if it works for me. I am thinking it is a bug and will report when I find out.