BARD

===================
Title                   : BARD
Date                    : 28/03/04
Version   		: 1.3 
Filename/s              : sof2mpbard_13.zip
Author                  : Arkanis
Email                   : [email protected]
Website   		: http://www.planetsoldier.com/arkanis/bard/



Description             : Here is BARD version 1.3! 

     SOF2MP: BARD is short for “Soldier Of Fortune 2 Multiplayer:
     Bots And Realistic Damage. The original aim of SOF2MP: BARD was 
     to add an integrated realistic damage mode to the standard SOF2 
     multiplayer, as well as bots, whilst making minimal changes 
     to the code. Since the 1.1, BARD has expanded beyond just Realistic 
     Damage and bots. While a lot of changes have been made, BARD still
     strives to allow server admins/hosts to turn 95% of the new features
     off - allowing you to change only the things you want.

     BARD strives to pack in as many of your favorite requested features, 
     leave out the crap you don't want, let you enable only the features that 
     you want, and still remain under 5 megabytes. No flashy gimmicks, no 
     stupid catchphrases, no false advertising.

     This may be the last version of BARD, as I am moving on to mod for UT2004.
     Please contact me with any suggestions, bugs or questions you have. 
     I may release one or two more small revisions, mainly to improve the admin system, 
     and squash bugs.

     Note: Do not confuse this with the beta version of 1.3, which is different
     to the official 1.3. This version also comes with the female skin pack 
     included as default. To disable the female team skins run the 
     'FemaleTeamSkins.exe', or rename the '_zfemales.pk3' file to '_zfemales.xxx'.
     You may have to enable/disable the female skins depending on the server you
     are playing on.

===================
* Updates/Changes *

Version v 1.3 Beta / v 1.3
---------------------------------
- Added Molotov Cocktail (model by Inc & Syn)
- Re-Added Last Man Standing and Classic Capture The Flag gametypes
- Added females skins to teams (skins by Fragger)
- Extended team skins from 5 to 6 (5 male, 1 female)
- Added female radio messages
- Added Wave CTF gametype
- Added Health/Armor Regeneration
- Added Reserved names list
- Added Admin list
- Added a basic administration system
- Added in a third person crosshair (g_thirdPerson 2)
- Added extra scoreboard information
- Replaced Mods button with a Demo button
- Falling Damage can be tunred off
- Create Server menu has been improved
- Bot menu has been added
- OICW animations speed up
- Added RMG support for custom game types
- Added Colombian_Chick to bots
- Changed g_removeBotPrefix to g_removeBotSuffix
- Fixed Team Kill damage showing up twice on the scoreboard
- Fixed console message saying streak sounds could not be loaded
- Improved mp_col1 waypoint
- Bot skill is default from 2 (Amature) to 5 (Soldier Of Fortune)
- Maximum multiplayer maps displayed in map list increased from 128 to 256
- Added server download re-direction message
- Changed wording of "you must be connected to the internet" popup
- Minor fixes and improvements


Version v 1.2
---------------------------------
- Added US Socom-SD
- Added M4
- Added M4/203
- Added MP5
- Added MP5SD
- Added OICW
- Added F1
- Spawn With Any Weapon In Deathmatch
- Lean Bug Fix
- Onscreen Clock/Time
- Headshot Obituary Notification
- More Waypoints
- Improved Waypoints For Some Maps
- Unrealistic Damage Mode
- Mod Filtering On Join Game Menu
- Ability To Disable Personal Scores In Team Games
- Start With Or Without Armor In Deathmatch
- Spectator Voting
- Shotgun Crosshair Size Can Be Increased
- Map Name Overlayed On Levelshot In Create Game Menu
- Kill Streak For Deathmatch
- Randomized Obituaries
- Death Match Score Info On HUD
- Can Limit The Number Of Dropped Items On Ground
- Profanity Checker
- Removed Ability To Score Points After Game Ends
- [BOT] Prefix For Bots Can Be Removed
- Random Bot Outfittings In Team Games
- Fixed Issue Where Objective Photos Would Not Displaying
- Assassination Gametype
- Inbuilt Server Messaging
- Extra Gore Mode
- Post Game Stats
- Heaps Of Minor Fixes

Version v 1.1
---------------------------------
- Fixed issue where disabled weapons would be displayed in the outfitting
- Added Last Man Standing game type
- Added Classic Capture The Flag game type
- Added g_realisticDamageSpeed cvar and code, alters speed according to health
- Added “REALISTIC DAMAGE ON” message on loading screen only when enabled
- Added “REALISTIC DAMAGE SPEED ON” message on loading screen when enabled
- Added “THIRD PERSON ON” message on loading screen when enabled
- Added g_botsReady cvar and code, so bots can automatically be ready at end of
level
- Removed crosshair and returned default horizontal pitch to 15 in third person
mode
- Removed kills being added to scoreboard during warm-ups

Version v 1.0
---------------------------------
- Added g_realisticDamage cvars and code
- Addition of code to load sof2.wpn and sof2real.wpn depending on mode
- Added menu option to turn Realistic Damage on or off from menu
- Added “REALISTIC DAMAGE ON/OFF” message on loading screen
- Added enhanced bot code from Man Down
- Added Add Bot option to in-game player menu
- Added the deathmatchStartWithUzi cvar and code
- Re-enabled third person mode that is set only by host


==============================
* New Features Explained *

Re-Added Last Man Standing and Classic Capture The Flag
==============================
It seems that I accidently left these two game types
out of version 1.2, after they appeared in 1.1 D'oh!


Added females skins to teams 
============================
One female skin has been added to each of the
stock teams. This feature is being trailed in
version 1.3 and may be removed, or made so it
can be enabled/disabled.


Extended team skins from 5 to 6
===============================
The number of team skins available in games
has gone from 5 to 6.


Added female radio messages
===========================
Female characters now have their own female voices
for radio commands.


Added Wave CTF gametype
=======================
A leftover from Team Soldier, this gametype sees
teams spawning in waves. 'g_respawnWaveDelay x'
where 'x' is the amount of seconds between waves.
The Team Soldier version of the Wave CTF was more
advanced, but this is still an interesting variation on
CTF.


Added Health/Armor Regeneration
===============================
Health/Armor regeneration can be enabled on the server,
where players will regenerate a certain amount of health
or armor per second up to a designated limit.

g_regenHealth 0/1 - Turns health regen off/on
g_regenHealthMax x - x is the max amount of health regenerated, i.e. 50 (half)
g_regenHealthValue x - x is the amount of health regenerated per second, i.e. 5


g_regenArmor 0/1 - Turns armor regen off/on
g_regenArmorMax - x is the max amount of armor regenerated, i.e. 50 (half)
g_regenArmorValue - x is the amount of armor regenerated per second, i.e. 5


Added Reserved names list
=========================
Player/clan names can be reserved on your server, good for making sure
someone doesn't come onto your server impersonating someone else, or
using your clan tag without permission. 

Names/passwords/IP's are put into the 'namelist.cfg', to use one of these
games requires a person to enter their password, or it will check against
the IP provided in the 'namelist' file. 


Added Admin list
================
If 'g_adminMode' is set to 2, admins can only come from a list supplied
by the host.

Names/passwords/IP's are put into the 'adminlist.cfg', to use one of these
games requires a person to enter their password, or it will check against
the IP provided in the 'adminlist' file. 

If no IP address is given in the file, players must use 'namepass' to be
considered
admins for the server, i.e. 'namepass xxx', 'xxx' must match the password in
the adminlist.
Players then have to log in with the admin password.



Added a basic administration system
===================================
A basic administration system has been added to allow admins to be
appointed, so they can perform various tasks on the server, such
as restarting maps, cancelling votes, kicking players, striking
players who are doing inappropriate things.

Set and admin password using 'g_adminPassword ""xxx""', where ""xxx""
is the password. The password cannot be more than 16 characters.

Set 'g_adminMode' to 1, and then to let people become Admins they
need to enter the admin password (asset by the host) using,
'/setadmin xxx', where ""xxx"" is the admin password. Once they get this
right they will be told if they have become an admin.

Make sure you have the ""/"" infront of the ""/setadmin"" command as
if this is not included this command will be broadcast to all players
on the server. This system will be improved in future releases.

To get a list of admin commands, type '/admin help' in the console.


Added extra scoreboard information
==================================
The scoreboard now also contains information such as time left, if friendly
fire is on or off etc.


Replaced Mods button with a Demo button
=======================================
The Mods button has been replaced with a Demo button to
allow players to browse through recorded BARD demos in their demo folder.
This idea has been modified from RCFmember's DemoMenu. 

Falling Damage can be tunred off
================================
Falling damage can be turned be turned off using:

g_noFallingDamage [0/1], 0 = Off, 1 = On


Added Molotov Cocktail as weapon
================================
Added in an improved version of the Molotov Cocktail which
was made by Inc & Syn. The skin has been replaced, and the weapon
action and characteristics match the Moltov, i.e. on impact explosion,
no pin pull sound effects.

It can be disabled from the outfitting by using 
""disable_pickup_weapon_molotov 2"".

Molotovs have also been added to the g_dmWeapononspawn list, the new
list is:

'g_dmWeaponOnSpawn 0' - Default Socom
'g_dmWeaponOnSpawn 1' - Knives
'g_dmWeaponOnSpawn 2' - US Socom-SD
'g_dmWeaponOnSpawn 3' - 1911
'g_dmWeaponOnSpawn 4' - Silver Talon
'g_dmWeaponOnSpawn 5' - Micro Uzi
'g_dmWeaponOnSpawn 6' - M3A1
'g_dmWeaponOnSpawn 7' - M590
'g_dmWeaponOnSpawn 8' - USAS-12
'g_dmWeaponOnSpawn 9' - MP5SD
'g_dmWeaponOnSpawn 10' - MP5
'g_dmWeaponOnSpawn 11' - AK-74
'g_dmWeaponOnSpawn 12' - M4
'g_dmWeaponOnSpawn 13' - M4/M203
'g_dmWeaponOnSpawn 14' - SIG-551
'g_dmWeaponOnSpawn 15' - MSG90A1
'g_dmWeaponOnSpawn 16' - OICW
'g_dmWeaponOnSpawn 17' - M60
'g_dmWeaponOnSpawn 18' - RPG7
'g_dmWeaponOnSpawn 19' - MM1
'g_dmWeaponOnSpawn 20' - SMOHG (Frag)
'g_dmWeaponOnSpawn 21' - ANM-14 (Fire)
'g_dmWeaponOnSpawn 22' - F1 (Frag)
'g_dmWeaponOnSpawn 23' - Molotov Cocktail
'g_dmWeaponOnSpawn 24' - All Weapons
'g_dmWeaponOnSpawn 25' - A Random Weapon Each Spawn

Example, 'g_dmWeaponOnSpawn 10' with let everyone spawn with MP5's
instead of US Socom's. Great to spice up DM games.


Create Server menu has been improved
====================================
The create server option menu has been improved, seperating the standard
SOF2 options and the new BARD options using two buttons. The regular
SOF2 options will be shown as default, by pressing the BARD button you
will be shown the extra BARD options. Much cleaner then dumping them all on
the one option screen.


Bot menu has been added
=======================
You will now find a button with a toy robot on it up in the 
create server options. Clicking on this will bring up a new bot
menu where you can find various bot related options. Also the
minimum number of bots can be set through this menu, which is 
handy for a quick game. 


OICW animations speed up
========================
The lifting, aiming and zooming animation speeds have been increased
by approximately 50%. The weapon is still a fraction slow to lift,
this is to compensate for its power, and the fact it is a large
weapon. Firing speed will reamin the same for now.


Added RMG support for custom game types
=======================================
You can now play all the custom game types in BARD in RMG games. This 
should have been done a lot earlier, but it is better late then never. 
RMG Assassination games can be pretty challenging!


Added Colombian_Chick to bots
=============================
A new bot, Colombian_Chick has been added to the bot list. She is a 
Colombian Rebel, 23 years old, likes long walks on the beach, and men
with moustaches and US Socoms. :)


Changed g_removeBotPrefix to g_removeBotSuffix
==============================================
Simple cvar name change to reflect that is really is a suffix,
not a prefix.


Fixed Team Kill damage showing up twice on the scoreboard
========================
Removed some leftover code which was displaying the TK%
on the scoreboard twice.


Fixed console message saying streak sounds could not be loaded
=======================
A message about missing streak sounds kept appearing in the console,
due to a feature I removed. This has be fixed and should not be seen 
again.


Improved mp_col1 waypoint
=========================
Fixed the waypoint where bots would constantly get snagged on the
corner of a watchtower in the rebel base.


Bot skill is default from 2 (Amature) to 5 (Soldier Of Fortune)
=======================
Default bot skill has been increased from 2 to 5. Bots added to
servers without a specified skill level will be level 5. To be honest, 
who plays against bots in any other skill then Soldier Of Fortune?


Maximum multiplayer maps displayed in map list increased from 128 to 256
====================
The map list is limited to displaying 128 multiplayer maps, this has been
increased to 256. This is untested, but should work. Apparently there are 
people out there that actually have more than 128 maps! 


Added server download re-direction message
==========================================
Added a message ""Download BARD 1.3 from SOF2Files.com, or bard.moddb.com 
at a faster rate."" that is displayed on the screen when downloading files. 
This is to encourage people who are downloading the mod via the server to 
consider going to a proper download site like SOF2Files or the BARD website 
to get the mod/files instead.


Changed wording of ""you must be connected to the internet"" popup
=====================
Some people were misinterpreting the message and thinking that
you had to be connected to the internet to play BARD, this is
not the case. The wording on the message was changed slightly
to reflect that this message is related to getting an internet server 
listing, not playing locally. This isn't Steam. :)


========================
* Known Issues *

When jumping between gametypes with bots in the server, i.e. from DM to INF,
the bots will appear on the scoreboard in INF but will not be physically
in the game. The bots must be kicked and readded. Bot should work fine if you
stick with the one game mode, or similar modes like DM and TDM.

Some people don't seem to know this, but you need waypoints for each map you
wish to run bots on. Otherwise they will stand around and do nothing, please
do not ask me why they are no moving. Also it should be mentioned that the
waypoints are designed for DM/TDM mainly, but bots should work in a fashion
on most maps. I may allow for the ability to load seperate waypoints for
each gametype a map has, maybe, depending if anyone even plays this mod.

=====================
* Play Information *

Game                    : Soldier of Fortune 2
Type                    : Multiplayer
Supported Modes  : ALL
   : 
Requires                : SoF2 Full Version 1.03


======================
* Construction *

Compiler                : Visual C++ 5.0
Buildtime               : 1 Month
Known Bugs              : Read the 'SOF2MP-BARD Manual.rtf'

Features                : Read the 'SOF2MP-BARD Manual.rtf'

Compile Machine         : XP2800+ AMD Athlon, 512 MB RAM
Compile Time            : < 1 minute

=====================
* Installation *                

Check that you do not have a previous copy of SOF2MP-BARD installed. If you 
already have a folder called &quot;&quot;SOF2MPBARD&quot;&quot; in your Soldier Of Fortune
directory then it is best you delete it before installing the newer version.

Unzip (extract) the file &quot;&quot;sof2mpbard_13b.zip&quot;&quot; to your Soldier Of Fortune 2
directory, with directory 
structure intact. It is important that you keep the directory structure intact;
otherwise the mod will not work. In WinZip, make sure the box &quot;Use folder names&quot;
is ticked. Similar programs should also have this feature.

On most machines your Soldier Of Fortune 2 directory should be located at:
'C:\Program Files\Soldier of Fortune II - Double Helix'. 

This assumes that the game is install on C drive, if your game is installed on
another drive, such as D drive, then it would most likely be 'D:\Program Files\Soldier
of Fortune II - Double Helix'.

Load SOF2MP-BARD through the Mods menu in SOF2, or run the start.bat file to
start the game. It is best to do it with the start.bat as some things may not load with
the ingame mod button.

Read the 'SOF2MP-BARD Manual.rtf'in the 'docs' folder for more info.
==========================
* Credits *

Kris Rigby ([email protected])
Kris is the author of Man Down (http://www.mandown.net/). Thanks to the release
of the Man Down source code, Kris has given the SOF2 modding community (the few of us 
left), a real leg-up on understanding the code and giving us access to many new
and improved features not available in the original game.
SOF2MP-BARD makes use of some of the bot code from Man Down.

Fragger for allowing me to use and abuse some of his female player skins.

XYZ from the MDX mod for his server messaging code and health renegeration
code.

GODh for various help on the Raven MP Mod Forums.

Inc & Syn for their Molotov Cocktail model which I reskinned and improved.
 
PlanetSoldierofFortune.com - Your source for SoF\SoF2 news, information, and
content.

SOF2Files.com for being the main host of SOF2 files and content.

Thanks to the people who submitted waypoints.

Aaron for helping with the testing and putting up with me saying,
&quot;&quot;copy that... delete that... test that... is that working&quot;&quot; all day long.

Thanks to various testers and users who provided constructive feedback and
ideas, you all know who you are.


=====================
* Special Credits *

Special thanks to the gang on the Raven Soldier Of Fortune 2 Forum for helping
me out in supplying some new one-liners for the bots to use. 

Bot sayings contributors, in no particular order:
T¥RANITH 
[email protected] 
The Guvner
striffy the snowman
Spoonraker

Frankly I was getting sick of the stuff I wrote 12 months or so ago. :)


=============================
* Permissions*

All original and composed textures, assets and intellectual property in this
modification remain property of the sources respective owners.

You MAY distribute this modification in any not-for-profit electronic format
(BBS, Internet, CD, etc) as long as you contact the author first, and include all files,
including this ReadMe, 
intact in the original archive.

You MAY NOT include or distribute this mod in any sort of commercial product
without permission from the author.  If given permission in writing, you must include
all files, including this ReadMe, intact in the original archive.

You MAY NOT mass distribute this mod via any non-internet means, including but
not limited to, compact disks, and floppy disks without permission from the author. 
If given permission in writing, you must include all files, including this ReadMe, 
intact in the original archive.

===========================
* Warning - Must Read and Understand Before Use*

The author of this modification accepts no responsibility for damage to data,
or physical damage to hardware, caused by the appropriate or inappropriate use of this
modification. It is deemed that users who run this modification, are automatically 
considered as having read and understood this liability clause before using the said 
modification.

========================