~~~ Thank you for downloading SwearSlapper by PWicks23 and killjoy64! ~~~

	~	http://dev.bukkit.org/server-mods/swearslapper/ 	~


==================================================================================================
~Installation~


To install just the plugin:

	> Open or extract the ZIP folder (Use WinRAR, 7ZIP or similar program)
	> Put the SwearSlapper.jar into your plugins folder.
	> Start your server.
	> A new folder named "SwearSlapper" will appear in your plugins folder.
	> You can either leave it, or open the folder and edit the config.yml and add your own words to BlackListedWords.txt
	
To install the plugin with the preset swear words:

	> Open or extract the ZIP folder (Use WinRAR, 7ZIP or similar program)
	> Put the SwearSlapper.jar and the SwearSlapper folder into your plugins folder.
	> Start your server.
	> Go back to SwearSlapper folder and edit the config.yml to your personal preferences.
	
	
==================================================================================================
~Configuration~


	> Go to SwearSlapper folder in your plugin folder.
	> Open config.yml in a text editor.
	>You will see all of the nodes. This is what each of them do:
	
	OffenderMessage:
		> Type the message the players attempting to swear will recieve next to this.

	NotifyMessage:
		> Type the message for players with notify permission here. Layout: [SwearSlapper]: <playername> <NotifyMessageHere>

	ShowSwear:
		> "true" if you want players with notify permission to see the swear attempt in the Notify message. "false" if you don't. Simple. (Recommended that this is true)

	LightningStrike:
		> If a slap just doesn't feel like it's enough for bad-mouthed players, you can configure a lightning strike to him them too!
		> "true" if you want players who swear to be struck by lightning. "false" if you don't. As always, simple.


==================================================================================================
~Commands and Permissions~

	
You can edit and overview your blacklisted words by looking the the BlackListedWords.txt file or
by using the ingame commands, which are also executable through the server console. When adding and
removing words through the BlackListedWords.txt make sure it is one word per line!

					Commands:														Permissions:
	
	/ss add <word> - Add a word to the blacklist.				|	SwearSlapper.admin
	/ss remove <word> - Remove a word from the blacklist.		|	SwearSlapper.admin
	/ss check <word> - Check if a word is blacklisted.			|	SwearSlapper.admin
	/ss list - Shows a list of all the blacklisted words.
	/ss reload - Reload the plugin's blacklist and config.		|	SwearSlapper.admin
	/ss help - Shows the SwearSlapper help menu.				|	SwearSlapper.admin
																|
	/caps - Manually slap a player for excessive caps.			|	SwearSlapper.caps
	/language - Manually slap s player for bad language.		|	SwearSlapper.language
	
	
	Additional permissions:
		
		SwearSlapper.* - All SwearSlapper permissions.
		SwearSlapper.canswear - Players with this permission bypass the SwearSlapper filter.
		SwearSlapper.notify - Players with this permission get notified when someone swears.
		
	Recommended setup:

		Mods + Admins - SwearSlapper.* | This means they can all add and remove words as well as manually slap. (They have all SwearSlapper permission nodes)
		SubMods/Trial Mods - SwearSlapper.caps and SwearSlapper.language | This means they can manually slap but can not add or remove additional words.
		
		
==================================================================================================
~Additional Help~

	IRC Channel:
	
		If you need help with anything to do with my plugins feel free to come visit me on EsperNet network on
		channel #wofcoding - I idle in this channel whenever I'm online, which is anytime around daytime 1:00 - 
		11:00 GMT (EST+5). The channel is not dedicated just for this plugin, it is the Fantasia server's dev 
		channel where we talk about any programming, so do not expect any of the voiced users or the other 
		ops to know how to fix any problems you may have, although some might! Ask for killjoy64 or PWicks23 for
		best results!
	
	Email:
	
		Feel free to send an email to dev@worldoffantasia.com outlining any problems you have or if you need any help. If all else fails comments on my BukkitDev
		page which is at the top of the file!



