Pooper200000 at 19:49, 16 February 2010

2010-02-16T19:49:30Z

← Older revision		Revision as of 15:49, 16 February 2010
Line 1:		Line 1:
			[[Category:Scripting Reference]][[Category:Scripting Tutorials]]
	=Word Filter=		=Word Filter=
	Graal's built-in word filter allows you to effectively and elaborately check many forms of chat to detect words which may be insulting, crude or against the rules.		Graal's built-in word filter allows you to effectively and elaborately check many forms of chat to detect words which may be insulting, crude or against the rules.

Tigairius: /* Completing Your Word Filter */

2008-04-01T19:52:40Z

Completing Your Word Filter

← Older revision		Revision as of 15:52, 1 April 2008
Line 103:		Line 103:
	RULE		RULE
	CHECK pm toall chat nick		CHECK pm toall chat nick
	MATCH ~~b?tch~~		MATCH bitch
	PRECISION 100%		PRECISION 100%
	WORDPOSITION part		WORDPOSITION part
	~~WARNMESSAGE Please do not use that language!~~
	ACTION log replace		ACTION log replace
	RULEEND		RULEEND

Tigairius: New page: =Word Filter= Graal's built-in word filter allows you to effectively and elaborately check many forms of chat to detect words which may be insulting, crude or against the rules. ==Purpose...

2008-04-01T18:53:40Z

New page: =Word Filter= Graal's built-in word filter allows you to effectively and elaborately check many forms of chat to detect words which may be insulting, crude or against the rules. ==Purpose...

New page

=Word Filter=
Graal's built-in word filter allows you to effectively and elaborately check many forms of chat to detect words which may be insulting, crude or against the rules.

==Purpose of the Word Filter==
The word filter is part of the game server and can be used by administrators
to prevent the usage of rude words in messages and names. It will not work for
100% of all cases, but it will help to find people that use those words, and
if users trick the system they know that they do something that is against the
rules and will possibly be jailed or banned.

The word filter allows different types of actions: it can log the usage of
words, tell administrators that someone used a filtered word, replace the word
with stars, block the message and warn the user. It's planned that you can directly send someone to jail or possibly ban someone if the word filter has detected
something, that will mainly be used for preventing trial players to flood the
servers with unwelcome messages.

==Configuration Files==
By default the filter rules are listed in the file 'wordfilter/rules.txt'.
Modify that file to change the word filter rules, it will automatically reload
the rules when you update the file. The filter log is saved to 'wordfiler/log.txt'.

==Global Options==
In the rules file you can add following lines to change parameters that apply
for all rules or are used when you don't specify the parameter in the rule
itself:
<pre>
WARNMESSAGE message
sets the warn message that is displayed when
the player uses a bad word and there is a rule
that matches a word in the text and has 'warn' as
action
SHOWWORDSTORC true/false
enables/disables the display of the words that matched,
this is by default turned off to not annoy the staff
if it's turned off then you will only see the name
of the player in the message that is sent to RCs
</pre>

==Rules==
You can define several rules.
A rule always starts with a
RULE
line and ends with a
RULEEND
line.

Between those two lines you can specify the options for the rule. Following
options can be set:

MATCH word
defines the word to look for, format:
- '?' : all characters match
- upper case : character must match exactly
- lower case character : will be counted when it matches
and at the end checked if the number of characters that
match is higher or equal to the requested precision
You can define more than one match per rule. Spaces
and some other characters are overread to allow easier
matching.
examples: F??K, BitcH
CHECK chat pm toall nick
list of text types to check, separated by spaces
the actions vary a little bit from type to type -
people that send bad PMs are warned by admin message,
otherwise it changes the chat text of the player
WORDPOSITION full/start/part
says where the word must be appear in the text
to be recognized, 'full' means the rule only
matches full words, 'start' means the rule will
check the start of words if they match, 'part'
means it checks everything
PRECISION matchcharacters/precision%
you can either give a number of characters that
must match to fire the action, or give a
percentage, add '%' at the end of that then
ACTION log tellrc replace warn jail ban
list of actions to do when the word matches, separated by spaces
'log' will log to wordfilter/log.txt, 'tellrc' will
send a warning on the RC-chat, 'replace' will replace
the found words with stars, 'warn' will set the chat text
of the player to the warn message or send an admin message
when the message was a PM, the PM will not be sent in
that case; 'jail' and 'ban' are planned for the future
WARNMESSAGE message
sets the warning message

==Completing Your Word Filter==
After you have grasped the concept of how the word filter works, you can begin carefully crafting a word filter for ''your'' server.
A very basic word filter might look like this:
<pre>
WARNMESSAGE Your crude language has been logged!
SHOWWORDSTORC true

RULE
CHECK pm toall chat nick
MATCH f??k
PRECISION 100%
WORDPOSITION part
WARNMESSAGE Please do not use that language!
ACTION log tellrc warn
RULEEND

RULE
CHECK pm toall chat nick
MATCH b?tch
PRECISION 100%
WORDPOSITION part
WARNMESSAGE Please do not use that language!
ACTION log replace
RULEEND

RULE
CHECK pm toall chat nick
MATCH graalhack
PRECISION 100%
WORDPOSITION start
WARNMESSAGE Please don't discuss hacking here.
ACTION log warn
RULEEND

RULE
CHECK chat pm nick toall
MATCH homo
PRECISION 100%
WORDPOSITION full
ACTION log replace
RULEEND
</pre>
You should generally use the word position "full" for smaller words in case half of the word is part of another word and the other half is part of a new word, for example "of kingdom" has "fking" in it, so if we were testing for "fking" we would want to do "full." The word filter is based on commands, so remember that logging the action should always come before replacing or warning the person. If you replace the word before you log it ("ACTION replace log") your log file will show the replaced word, rather than the original word.

Creation/Dev/Word Filter - Revision history

Pooper200000 at 19:49, 16 February 2010

Tigairius: /* Completing Your Word Filter */

Tigairius: New page: =Word Filter= Graal's built-in word filter allows you to effectively and elaborately check many forms of chat to detect words which may be insulting, crude or against the rules. ==Purpose...