Weeds Gun Game v1.2 for Counter-Strike 2D
===========================================
Copyright 2013, Rich Weeds Nagel - Some Rights Reserved

Description
-----------
This Lua script adds a "Gun Game" deathmatch gameplay mode to Counter-Strike 2D
for a "listen" server (when starting a new game), as well as for a dedicated
server.

Note that this script is based on the original CS2D Gun Game script
("GunGame.lua"), but with several additional enhancements and features. These
additions can easily be enabled, disabled, or changed by simply editing the
fully-commented script file using Windows Notepad.

Lastly, note that it was NOT my goal when creating Weeds Gun Game to attempt
to recreate the other fully-featured Gun Game scripts that may already be
available, or create a COMPLETELY game-changing and life-changing experience!

But rather, my primary goal was simply to modify the original CS2D Gun Game
script so that it would be a little bit more fun and usable (and easier to
configure), all without changing too much of it's overall look and gameplay :)

Enhancements and Features
-------------------------
* Easy configuration of weapon levels (plus last knife level).

* Fully-commented "Weapon IDs List" section (to make it easier to configure the
  gun game weapon levels).

* Adjustable number of required kills for the player to advance to the next gun
  game level.

* Handicap for players joining an existing gun game (joining players start at a
  level that is calculated from the mean-average of the current players'
  levels).

* Displayed welcome message for joining players, with general information about
  the current gun game (required kills, total levels, current handicap level).

* Optional Kevlar and Helmet when a player spawns.

* Optional Kevlar and Helmet kill reward when players make a kill.

* Optional Kevlar and Helmet level reward when players advance to the next gun
  game level.

* Optional knife-only melee killing spree, including a server map change (using
  the standard server "MapCycle.cfg" file) after a player wins the gun game.

* Adjustable server map change delay (in seconds) to allow time for the
  optional melee killing spree.

* Displayed message announcing the melee killing spree and it's duration, as
  well as the name of the next server map.

* Notification messages to all players when they advance to the next gun game
  level (with optional audible sound effects).

* Notification messages to a single player when he advances to the next gun
  game level (with optional audible sound effects).

* Notification message to all players when a player advances to the final gun
  game level (with optional audible sound effect).

* Notification sound effect to all players when a player wins the gun game.

* Notification messages to a single player displaying his current gun game
  level and level kills (as well as the number of kills that are required for
  the player to advance to the next level).

* Optional printed messages in the server's console stating the gun game's
  current handicap level.

* Fully-commented general "Gun Game Settings" section (to make it easier to
  configure the gun game, as well as explaining all of the default options and
  settings).

* Whatever the heck else that I modified and/or added to the original CS2D Gun
  Game script (and forgot about)!

Installation
------------
Unzip the files contained in the "Weeds_Gun_Game_v1.2.zip" archive to the
"Counter-Strike 2D\Sys\Lua" folder on your hard drive, and then add the
following line to the "Server.lua" (located in the same folder) file using
Windows Notepad:

dofile("Sys/Lua/WeedsGunGame.lua")

Alternatively, simply unzip the files to the
"Counter-Strike 2D\Sys\Lua\Autorun" folder on your hard drive. Note that this
method does NOT require editing of the "Server.lua" file (as the game will
automatically run any Lua script files that are located in the "Autorun"
folder).

Gun Game Defaults
-----------------
The following is a quick overview of the default settings for Weeds Gun Game
for the options and settings listed in the "Gun Game Configuration" section
below:

Game mode = Deathmatch
Random spawning = Enabled
Infinite ammo = Enabled

Required kills = 3 Kills

Map change and melee killing spree = Enabled
Map change delay = 30 Seconds

Weapon levels = 1,2,3,4,5,6,10,11,20,21,22,23,24,30,31,32,33,34,35,36,37,38,39,
40,45,46,47,48,49,90,91,50

Kevlar and helmet when spawning = Enabled
Kevlar and helmet kill reward = Disabled
Kevlar and helmet level reward = Enabled

Player current level notification messages = Enabled
Player current level notification sound effects = Enabled

Next level notification messages = Enabled
Next level notification sound effects = Disabled

Final level notification message = Enabled
Final level notification sound effect = Enabled

Winner notification sound effect = Enabled

Print handicap level in the server's console = Enabled

Gun Game Configuration
----------------------
Simply edit the included "WeedsGunGame.lua" Lua script file using Windows
Notepad. Note that when searching for specific comments as detailed below
within the Lua script file, "CTRL+F" is your friend!

The script file is fully-commented to allow easy enabling, disabling, changing,
or configuring any of the Weeds Gun Game enhancements and features.

Note that you should NOT change any of the options located in the "INITIAL
SETUP" section.

Options that you should PROBABLY NOT change (located in the "GUN GAME SETTINGS"
section), but can be interesting to experiment with nonetheless:

- Deathmatch Game Mode Enabled
- "sv_gamemode 0" = Standard Game Mode Enabled
- "sv_gamemode 1" = Deathmatch Game Mode Enabled (Default)
- "sv_gamemode 2" = Team Deathmatch Game Mode Enabled
- "sv_gamemode 3" = Construction Game Mode Enabled
- "sv_gamemode 4" = Zombies! Game Mode Enabled

- Random Spawning Mode Enabled
- "mp_randomspawn 0" = Random Spawning Mode Disabled
- "mp_randomspawn 1" = Random Spawning Mode Enabled (Default)

- Infinite Ammo Mode Enabled
- "mp_infammo 0" = Infinite Ammo Mode Disabled
- "mp_infammo 1" = Infinite Ammo Mode Enabled (Default)

Options that you may wish to change (located in the "GUN GAME SETTINGS"
section):

- Required Kills to Increase Level (Kills)

- Enable Map Change and Melee Killing Spree (0 = Disabled, 1 = Enabled)
- Map Change Delay for Melee Killing Spree (Seconds)

- Weapon IDs for Different Levels ({WeaponID,WeaponID,WeaponID,etc...,50})
- Note that the knife (Weapon ID "50") must be used for the last level.

Weapon ID Reference (for convenience, also located in the "GUN GAME SETTINGS"
section):

1  = USP (KM .45 Tactical)
2  = Glock (9x19mm Sidearm)
3  = Deagle (Night Hawk .50C)
4  = P228 (228 Compact)
5  = Elites (.40 Dual Elites)
6  = FiveSeven (ES Five-Seven)
10 = M3 (Leone 12 Gauge Super Shotgun)
11 = XM1014 (Leone YG1265 Auto Shotgun)
20 = MP5 (KM Sub-Machine Gun)
21 = TMP (Schmidt Machine Pistol)
22 = P90 (ES C90)
23 = MAC10 (Ingram MAC-10)
24 = UMP45 (KM UMP45)
30 = AK47 (CV-47)
31 = SG552 (Krieg 552)
32 = M4A1 (Maverick M4A1 Carbine)
33 = AUG (Bullpup)
34 = Scout (Schmidt Scout)
35 = AWP (Magnum Sniper Rifle)
36 = G3SG1 (D3/AU1)
37 = SG550 (Krieg 550 Commando)
38 = Gali (IDF Defender)
39 = Famas (Clarion 5.56)
40 = M249 (M249 Machine Gun)
45 = Laser (Laser Gun)
46 = Flamethrower (Flamethrower)
47 = RPGLauncher (RPG Launcher)
48 = RocketLauncher (Rocket Launcher)
49 = GrenadeLauncher (Grenade Launcher)
90 = M134 (M134 MiniGun)
91 = FNF2000 (FN F2000 NATO Bullpup)
50 = Knife (Melee Knife)
58 = Kevlar and Helmet (Do NOT use for a weapon level, it is only listed here
     for reference.)

Options that you may wish to change (located in the "SPAWN" section):

- Give Kevlar and Helmet when spawning (Comment out to disable giving Kevlar
  and Helmet when spawning)

Other options that you may wish to change (located in the "KILL" section):

- Give Kevlar and Helmet kill reward (Uncomment to enable giving Kevlar and
  Helmet kill reward)

- Player current level notification messages (Comment out to disable
  notification messages)

- Player current level notification sound effects (Comment out to disable
  notification sound effects)

- Winner notification sound effect (Comment out to disable notification sound
  effect)

- Final level notification message (Comment out to disable notification
  message)

- Final level notification sound effect (Comment out to disable notification
  sound effect)

- Next level notification messages (Comment out to disable notification
  messages)

- Next level notification sound effects (Uncomment to enable notification sound
  effects)

- Give Kevlar and Helmet level reward (Comment out to disable giving Kevlar and
  Helmet level reward)

- Print current Join Server Handicap Level in the server's console (Comment out
  to disable printing the Handicap Level in the server's console)

Note that if the optional "knife-only melee killing spree and server map
change" is disabled (refer to the "Enable Map Change and Melee Killing Spree"
option mentioned in the "GUN GAME SETTINGS" section above), the server will
RESTART the Gun Game on the SAME map after a player wins (just like original
CS2D Gun Game script does).

There will be NO melee killing spree, and the server will NOT change to the
next map in the server's "MapCycle.cfg" file.

Version History
---------------
v1.0                  - First Release.
(January 2, 2013)

v1.1                  - Added optional Kevlar and Helmet when players spawn.
(January 3, 2013)     - Added optional Kevlar and Helmet kill reward when
                        players make a kill.
                      - Added optional Kevlar and Helmet level reward when
                        players advance to the next gun game level.
                      - Clarified the configuration of the weapon levels (e.g.
                        the note about the last knife level).
                      - Changed a few minor things here and there.

v1.2                  - Added notification sound effects to a single player
(January 5, 2013)       when he advances to the next gun game level.
                      - Added a notification sound effect to all players when a
                        player wins the gun game.
                      - Changed the default for the printed server console
                        handicap level messages to enabled.
                      - Added the "Gun Game Defaults" section to this readme.
                      - Changed a few minor things here and there.


ENJOY!
------
Rich Weeds Nagel
January 5, 2013

richnagel@centurylink.net
http://www.richnagel.net
http://www.unrealsoftware.de/profile.php?userid=110755
http://steamcommunity.com/id/RichNagel
