-----------------------------------------------------------------------------
                                    BullShit
                                  Version 108
                        by Michiel 'El Muerte' Hendriks
                           elmuerte@drunksnipers.com
-----------------------------------------------------------------------------
BullShit is a server actor that will add some more life to the bots in a bot 
game. BullShit will let the bots speak on certain game events, and respond on
chat messages. Bot will no longer stay silent when you frag their ass.

New in version 101
- it works now :)

New in version 102
- fixed a few accessed none's
- added delayed messages

New in version 103
- fixed the stray messages when a bot left
- added score events for CTF and Bombing Run (take/capture flag/bomb)

New in version 104
- fixed the massive accessed none warning 

New in version 105
- added 3 extra chat triggers: msgXtra1 msgXtra1Trigger, msgXtra2 
    msgXtra2Trigger, msgXtra3 msgXtra3Trigger
- added a couple of new replacements:
  %kweapon%	 the weapon of the killer
  %kdeaths%	 number of times the killer died
  %kscore%	 the score of the killer
  %vweapon%	 the weapon of the victim
  %vdeaths%	 number of times the victim died
  %vscore%	 the score of the victim

New in version 106
- fixed the end game messages, they should work now
- fixed the wildcards in the triggers

New in version 107
- realy fixed the wildcards now

New in version 108
- Added carriage returns to README.TXT
- Fixed Accessed None's in ReceiveLocalizedMessage
- Fixed incorrect winner when player lost
- Fixed victim's weapon

-------------------------------- INSTALLATION -------------------------------
Copy the BullShit.u and BullShit.ini file to the UT2003 System directory.
Open up your server configuration (UT2003.ini) and add the following line:

  [Engine.GameEngine]
  ServerActors=BullShit.BullShit

Now when you start your server you should see the following lines in the log:

  [~] Starting BullShit version: 107
  [~] Michiel 'El Muerte' Hendriks - elmuerte@drunksnipers.com
  [~] The Drunk Snipers - http://www.drunksnipers.com

You might want to edit the configuration

------------------------------- CONFIGURATION -------------------------------
The configuration of the behavior of BullShit resides in the server 
configuration file (UT2003.ini). Add the following lines to the file:

  [BullShit.BullShit]
  ; Enable/disable speak types
  bKillMessages=True
  bChatMessages=True
  bEndMessages=True
  bScoreMessages=True

  ; This will decide the chance a bot will speak
  ; 1 = always, 0 = never
  fKillFrequency=0.330000
  fChatFrequency=0.500000
  fEndFrequency=0.750000
  fScoreFrequency=0.500000

  ; Delayed message settings
  bUseDelay=true
  fMinDelay=0.5
  fMaxDelay=2.5

When bKillMessages is true a bot might speak when it kills or get's killed, 
bChatMessages controls the bot to respond on certain chat messages, like 
welcome messages or goodbye messages from other players. With bEndMessages you
can enabled/disable the bot to say something at the end of a game.
The bScoreMessages messages are played when a team mate take the flag/bom or
captures the flag (bombing scores can't be captures)

The fequency settings control the chance a bot will speak. When the value is 
1 the bot will always speak, when it's 0 the bot will hardly speak at all, 
usualy never.

bUseDelay controls if the wait a little while before it will speak. fMinDelay
and fMaxDelay control the minimum and maximum delay (in seconds).

To change the lines the bot will say, open up the BullShit.ini file. You can
add a vertualy unlimited number of lines.
Messages are split up in the following groups:

Kill Messages:
- msgGotKilled    : when a bot gets killed
- msgKilled       : when a bot kills
- msgSuicide      : when a bot commits suicide
- msgTeamKill     : when a bot get's killed by a team member
- msgMadeTeamKill : when a bot kills a team member

End Messages:
- msgEndGameWon   : when the bot won the game (or his team)
- msgEndGameLost  : when the bot lost the game (or his team)

Chat messages:
- msgHello        : when responding on a hello message
- msgBye          : when responding on a goodbye message
- msgXtra1        : respond to trigger 1
- msgXtra2        : respond to trigger 2
- msgXtra3        : respond to trigger 3

Score Messages
- msgScoreWe      : our team scores
- msgScoreThey    : other team scored

Chat messages need extra configuration, you need to define the triggers on 
which the bot will respon:
- msgHelloTrigger : this will trigger a hello message
- msgByeTrigger   : this will trigger a goodbye message
- msgXtra1Trigger : this will trigger a message from msgXtra1
- msgXtra2Trigger : this will trigger a message from msgXtra2
- msgXtra3Trigger : this will trigger a message from msgXtra3
You can use wildcards in the triggers, use a * to match zero or more 
character and use a ? to match a single character.
For example, a trigger "hi*" will match the following lines:
  Hi
  Hi everybody
  hide for the rocket
So take care on how you use the wildcards

In all messages you can use replaceements to make them more lifelike
You can use the following replacements:
%killer%  the player that killed
%victim%  the player that got killed
%winner%  the winner of the game
%speaker% the bot that speaks
%player%  the player who said something
%scorer%  the player that took the flag/bomb
%kweapon%	the weapon of the killer
%kdeaths%	number of times the killer died
%kscore%	the score of the killer
%vweapon%	the weapon of the victim
%vdeaths%	number of times the victim died
%vscore%	the score of the victim

--------------------------------- SOURCE CODE -------------------------------
BullShit is provided under the GPL. The complete source code is available
from the website. Please respect the GPL:
                      http://www.gnu.org/licenses/gpl.txt

----------------------------- CONTACT INFORMATION ---------------------------
BullShit has been written by Michiel 'El Muerte' Hendriks 
<elmuerte@drunksnipers.com> member of The Drunk Snipers (TDS for short)
If you have any questions you can contact me, but I will not reply to 
questions who's answers can be found in this document.

The latest version of this server add-on can be downloaded from: 
http://www.drunksnipers.com/services/ut/ut2003/bullshit

-----------------------------------------------------------------------------
Michiel 'El Muerte' Hendriks                        elmuerte@drunksnipers.com
The Drunk Snipsers - ICT Solutions                http://www.drunksnipers.com
-----------------------------------------------------------------------------