cCensor 0.0.7

Contributors:

s3Duratech

Easy server chat filtering.

cCensor removes swear words and bad language from chat. Its fully configurable so you can add and delete words as you wish.

If someone could produce the appropriate censored list this would also work for non English servers.

Replaces words on censored list (censored.yml) with configurable replacement.

For Example :

"badword" becomes "!%#*@?X"

and

"Hello badWorD" becomes "Hello !%#*@?X"

Screen Shots






Inception Story

I couldn't find a Chat filter that a) worked and b) was lightweight and not full of bloated features I personally didn't need.

No offence meant to the heavy weight filters out there I just didn't need the extras and I have very modest server HW.

So as a long time coder (this no high school experiment / project) I decided to create one.

This has been running brilliantly on my own Spigot server (mysticcraft.duckdns.org) for nearly 3 months now.

Anyway here it is I hope you find it useful.. if you do please post a review if you have issues, feature requests, ideas or bug reports then also please feel free to leave a comment.

If possible though please let me respond to comments prior giving a bad review..

Installation

Place the cCensor.jar into your plugins folder and reload. Simple that's it. Configuration can be tweaked once cCensor is operational no need for server restarts.

Commands / Permissions

Permissions are ccensor.command

ccensor.* for Admins

Special permission

ccensorx.dontcensor (this group / user won't be censored)

/cCensor on

Turns on cCensor.

/cCensor off

Turns off cCensor.

/cCensor reload

Reloads cCensor config files.

/cCensor mute

Toggles mute for all chat.

/cCensor message

Toggles display of the Player warning message when censoring applied.

/cCensor muteresponse

Toggles mute of entire chat message when censoring applied.

/cCensor censoredonly

Toggles replacement of entire chat message with [CENSORED] when censoring applied.

/cCensor censored

Toggles prefixing of chat message with [CENSORED] when censoring applied.

/cCensor add <word>

Adds <word> to list of censored words.

This change is written to the censored.yml configuration file immediately.

/cCensor remove <word>

Removes <word> from the list of censored words.

This change is written to the censored.yml configuration file immediately.

/cCensor list

Displays the list of currently censored words.

/cCensor info

Displays cCensor configuration and censoring stats.

/cCensor setColour <&code>

Sets the default chat colour prefix in & format.

Players will need permission to use coloured chat for this to work.

/cCensor setColour

Will remove the colour prefix.

/cCensor setMessage

Sets the warning message displayed when censoring applied.

Default is 'This is a PG server, please don't use profanity'

/cCensor set Censored

Sets the Censored prefix / message.

Default is '[CENSORED]'

If coloured chat is enabled you can use & colour codes here.

/cCensor setStars

Sets the character string used to mask the profanity.

Must be 10 chars min, don't use REGEX special sequences.

Use bukkit colour codes with care..!!

Default is '‘!%#*@?X!%#*@?X!%#*@?X!%#*@?X!%#*@?X"

Configuration Notes

config.yml

Main config file is read at start up and written at shutdown.. so only edit the config.yml on a shut down server.. or your changes will be overwritten on shutdown.

A default config.yml will be created when the plugin first loads.

config.yml is saved prior to the cCensor shutting down or restarting.

censored.yml

A default censored.yml will be created when the plugin first loads.

You can edit this with game running. To reload the modified file use:

/cCensor reload

Anyone want to make a video guide..?

All feedback appreciated. Thanks s3duratech..