GabenMod v1.3

a) Introduction
b) Installation
c) Commands
d) CVARs
e) RollTheGabe Plugin
f) Making Spawns
g) Notes to Devs
h) Donations


a) Introduction
 GabenMod is a Counter-Strike Mod written with TFC in mind. You can select a class when you enter
 the game and use its abilites using the /menu and /buy commands. You can collect points by killing
 members of the opponent team, which you can later use to extend your class's skills. If you ever
 get stuck, you can simply say /help to display GabenMod's complete help.

b) Installation
 If you want to install GabenMod on your server, you will need to install AMX Mod X (latest version)
 and its Counter-Strike Addon on your CS/CS:CZ Server first. Then you can copy everything from this 
 directory into your cstrike (Counter-Strike) directory, enable the Fakemeta and CStrike modules 
 (remove the semicolons in front of the filenames in your modules.ini) and append the filename of 
 every GabenMod plugin you want to use to your plugins.ini (both files can be found in AMX Mod X's 
 configs directory [addons/amxmodx/configs]). 
 Important: You will ALWAYS need gm_engine.amxx to get GabenMod running! If you don't know what 
 every plugin does, just take a look at the sample plugins.ini. That's it, now you can start your 
 server and enjoy GabenMod.

c) Commands
 GabenMod has commands for both users and admins.

 You can find a list of all admin commands here:
  - gm_setpoints <user> <newpoints>			- Sets a user's points
  - gm_getpoints <user>					- Prints a user's points in your console
  - gm_addpoints <user> <points>			- Adds points to a user's point account
  - gm_rempoints <user> <points>			- Removes points from a user's point account
  - gm_menu (Spawn plugin only)				- Displays GabenMod's Spawn menu (for walls, items etc.)
  - gm_killergabe <user> (RollTheGabe plugin only)	- spawns a "killergabe", follows a user and kills him
  - gm_on						- Turns GabenMod on
  - gm_off						- Turns GabenMod off

 And here all the user commands:
  - say /playerpoints				 	- Displays the points of all the players
  - say /points						- Tells you how many points you have
  - say /select						- Shows you a menu to change your class
  - say /classes					- Displays information about every class
  - say /menu						- Displays your Class Menu (if supported by class)
  - say /buy						- Displays the Buy Menu of your class (if supported)
  - say /help						- Shows you a short introduction into GabenMod
  - say /respawn					- Respawns you if you're dead
  - +skill1, +skill2, +skill3, +skill4, +skill5		- Shortcut for a class action (start)
  - -skill1, -skill2, -skill3, -skill4, -skill5		- Shortcut for a class action (stop)
  - say rollthegabe (RollTheGabe plugin only)		- Random action, either good or bad for you

d) CVARs
 GabenMod has different CVARs that allow you to customize GabenMod as you want. You can find a list of all
 CVars here:
  - gm_startpoints (default 85)				   - Points you are given 
  - gm_dynamicpoints (default 1)			   - Give players an average value of the points people have
  - gm_setsettings (default 1)				   - Set the server's settings to GabenMod settings
  - gm_buyzone_req (default 0)				   - Prevent people from buying things outside spawns?
  - gm_killpoints (default 7)				   - Gained points per kill
  - gm_startwpn (default 1)				   - Give the users an upgraded M3 on respawn
  - gm_playerhints (default 1)				   - Show hint when looking at another player
  - gm_grenadetracers (default 1)			   - Colored grenade tracers
  - gm_respawn (default 1, non-CSDM only)		   - Enable respawn, yes/no
  - gm_removeweapons (default 1, non-CSDM only)		   - Remove weapons from ground
  - gm_respawndelay (default 1.5, non-CSDM only)	   - Respawn delay, how long GabenMod waits until it respawns
  - gm_version (1.3, public server cvar)		   - Shows what GabenMod version this server is using
  - gm_enabled (default 1, public server cvar)		   - Shows if GabenMod is enabled or not
  - gm_movestep (default 10, Spawn plugin only)		   - How many units do we move a wall if using move cmds
  - gm_roll_price (default 15, RollTheGabe plugin only)	   - Price for the "rollthegabe" command (points)
  - gm_roll_alwayspay (default 0, RollTheGabe plugin)	   - Bad actions cost points, yes/no
  - gm_wall_kickplayers (default 1, Spawn plugin only)	   - Accelerate players when touching a wall
  - gm_wall_kickspeed (default 750, Spawn plugin only)	   - Speed for this acceleration
  - gm_ent_check (default 1, Spawn plugin only)		   - Check free entities, should be enabled to prevent/debug ED_Alloc errors
  - gm_leastfreeents (default 60, Spawn plugin only)	   - Least free entities for the entity check
  - gm_reward_xp (default 5, Objectives plugin only	   - XP you get when finishing an objective
  - gm_reward_points (default 25, Objectives plugin only)  - Points you get when finishing an objective

e) RollTheGabe Plugin
 This is a fun plugin. It randomly gives you items or kills you. Everything you have to say to use it is
 "rollthegabe". It can either
  - Create a "killergaben" that follows you until it gets and kills you,
  - Hyperslap you (your screen goes crazy and slaps you downto 1 hp),
  - Bury or teleport you into a wall,
  - Remove all your weapons (except for knife),
  - Give you an MP5 or Glock18,
  - Respawn you,
  - Give you noclip or godmode for 20 seconds,
  - or put you into a rage (red screenfades, speed, explosions and/or ultimate knife damage).

f) Making Spawns
 Of course GabenMod comes with a few map settings but why wouldn't you want to play on another map? Everything
 you might need there is a Spawn protection (walls), respawning items (ammo, grenades) and maybe a few pictures
 of Gaben to entertain you. But how would you make all these things? It's not that hard, at first you have to
 open the GabenMod Menu. Use the "gm_menu" command to do that, everything should be self-explanatory in there.
 However, there are some useful tricks you might need to know to make "good" spawns.
 If you want to stack 3 walls, just create 3 walls at the same position (ie. create 3 walls without moving)
 and move wall by wall upwards (aim at the walls, press "Move wall up", aim at the top corner of the moved
 wall and move it again). You can also try to place accurate walls by moving slowly, it is just some 
 try'n'error work. If you want to place items with an accurate distance, just aim at the ground, make an item
 and crouch forward as long as you can see it.
 


g) Notes to Devs
 You can write extensions for this mod, most of the information you need can be found in GabenMod's include,
 "gabenmod.inc". It contains useful comments and shows you how to use different functions. Of course you can
 still take a look at simple classes like Scout or HWGuy to learn how GabenMod's Plugin Interface works. It
 would be good if you used the Fakemeta and CStrike modules only because we tried to make GabenMod as fast as
 possible. Therefore we used Fakemeta and optimized our code as well as possible and I hope we succeded. 
 Fun to make a new class, Fakemeta, CStrike and GabenMod's default functions should be enough. We tried to
 However, you can use the Engine+Fun modules if you want, it'd just be a loss of performance. If you are new
 to Fakemeta but want to use it, you can still use VEN's Fakemeta Stocks (a useful .inc file). It's up to you.

h) Donations
 Most of you probably think "ah, it's not that much work to make a mod" or "the devs get paid for this mod"
 but this isn't the case. We spent most of our spare time in this project to make it as fast and as nice as
 possible, so it would be nice to see that all this work wasn't done for nothing. Please show us that you 
 appreciate our work by donating to AMX Mod X (visit http://amxmodx.org/).



GabenMod  2005-2006 by Christian "Basic-Master" Hammacher (AMX Mod X Dev Team)
  Share the source - it sets you free







GabenMod is published under the terms of the GNU General Public License and comes with ABSOLUTELY NO WARRANTY!
See http://www.gnu.org/licenses/gpl.html for further information.