Foul Language Filter

Download Code File

*WARNING: This snippet contains a few expletive words to serve as example.

The project I'm working on may need something like this and I was bored so I whipped up a little piece of script that will replace explective words with any word of your choice. Decided to post it in case anyone could find it handy.

I coded it so you can hardcode the list of banned words and corresponding replacement words in the script file or read them in from a text file.

first you need to set up your list of banned words and replacement words

$bannedWords[0] = "damn";      $replacementWord[0] = "darn";
$bannedWords[1] = "crap";      $replacementWord[1] = "crud";
$bannedWords[2] = "asshole";   $replacementWord[2] = "bad man";
$numBannedWords = 3;

Now here's the function to clean a given string

function cleanString(%string)
{
   for(%i=0; %i<$numBannedWords; %i++)
   {	
      %string = Strreplace( %string, $bannedWords[%i], $replacementWord[%i] );
   }
   return %string;
}

Here given the string "damn this is crap" the function will return "darn this is crud"

To filter chat messages simply add the following code in common/server/commands.cs

function serverCmdTeamMessageSent(%client, %text)
{
   if(strlen(%text) >= $Pref::Server::MaxChatLen)
      %text = getSubStr(%text, 0, $Pref::Server::MaxChatLen);
   
   [b]%text = cleanString(%text);[/b]
   
   chatMessageTeam(%client, %client.team, '\c3%1: %2', %client.name, %text);
}

function serverCmdMessageSent(%client, %text)
{
   if(strlen(%text) >= $Pref::Server::MaxChatLen)
      %text = getSubStr(%text, 0, $Pref::Server::MaxChatLen);

   [b]%text = cleanString(%text);[/b]

   chatMessageAll(%client, '\c4%1: %2', %client.name, %text);
}

Now if you want to store the list of banned words and replacement words in a text file the following function will read them in and override the hardcoded values.

//banned word file should have one bannedWord, replacementWord 
//pair per line seperated by a comma
//ex:
//  damn, darn
//  crap, crud

function readBannedWords(%bannedWordFile)
{
   %file = new FileObject();
   if( !%file.openForRead(%bannedWordFile) )
   {
      echo("file:" SPC %bannedWordFile SPC "not valid");
      return;
   }

   %i = 0;
   while( !%file.isEOF() )
   {
      %line = %file.readLine();
		
      %bWord = "";
      %stringLeft = nextToken(%line, bWord, ",");
      %bWord = Trim(%bWord);
      %rWord = Trim(%stringLeft);
		
      $bannedWords[%i] =      %bWord;		
      $replacementWord[%i] =  %rWord;
      %i++;
      }
      $numBannedWords = %i;
}

Dont forget to tell the game to execute your script. I place mine in server/scripts/game.cs onServerCreated(). But if you need it to run earlier then place it elsewhere.

I simply have the code read in the lists from a file right after the exec:

exec("./stringClean.cs");
readBannedWords("starter.fps/server/scripts/bannedWords.txt");

Hope this helps. Note, this is just a very simple solution and not meant to be terribly robust.