Distribution

The EventScripts package includes a number of files. Below is a description of them.

Core plugin files

The following files are essential for EventScripts to function properly. These must go into the addons directory for your Source game:

• addons/mattie_eventscripts.dll - Windows core binary (x86)
• addons/mattie_eventscripts_i486.so - Linux core binary (x86)
• addons/mattie_eventscripts.res - EventScripts extended event definition file
• addons/mattie_eventscripts.vdf - Valve Source Plugin registration file

Included Addons (Utilities)

The following addons are utilities or libraries used for diagnostics and sharing between addons.

corelib

Filename

• addons/eventscripts/corelib/es_corelib.txt

Description

It is highly recommended that you install the corelib addon. This is a library that will grow over time to help make addons more powerful. If this is not available when other script addons need it, your server will misbehave.

Usage and Notes

• Add

  es_load corelib

  into your autoexec.cfg or into your own script addon before referencing a corelib function.
• For more informaton about corelib, visit the corelib topic.

diag

Filename

• addons/eventscripts/diag/es_diag.txt

Description

It is highly recommended that you install the diag addon. This is simply a script that you can load in order to run simple diagnostics tests to help troubleshoot your EventScripts installation.

Usage and Notes

• Provide this command

  es_load diag

  via rcon or, if you want the output always available, you could use some cfg file(e.g. in autoexec.cfg).
• When you call

  es_load diag

  you can see the diagnostic output in the following places:
  • Your newest set of logfiles in the logs directory of your server
  • addons/eventscripts/diag/es_diagnostics_db.txt
  • cfg/events/es_diagnostics_db.txt
• Usually you will be asked to run this by someone helping you troubleshoot your ES installation.

unittest

Filename

• addons/eventscripts/unittest/es_unittest.txt

Description

The unittest addon is totally optional. Typically you might use it to test new versions of EventScripts on your platform to be sure everything is working properly.

Usage and Notes

• Provide this command

  es_load unittest

  via rcon or autoexec.cfg.
• When you call

  es_load unittest

  it will run through a series of functionality tests to help show that ES is working properly.
• Usually you will be asked to run this by someone helping you troubleshoot your ES installation.

Included Addons (Examples)

The following addons are fully functional game "mods" that are provided as examples. Feel free to open them up, tweak them, and learn from them. They are entirely optional, but it is assumed they are present on your server and you might be asked to load them as part of troubleshooting.

EventScripts will completely ignore any addons you have on disk if you do not call es_load on them so it is recommended you install all of these examples just for completeness.

MugMod

Filename

• addons/eventscripts/mugmod/es_mugmod.txt

Description

MugMod allows you to steal your victim's cash when you kill them with a knife.

Usage and Notes

• Add

  es_load mugmod

  to your autoexec.cfg
• MugMod is the official update to Mattie's original MugMod plugin.
• Provides an example for how to set player's money
• Provides an example for how to read player's money
• Provides examples for round announcement, commenting, etc.
• Lots more information here: http://www.mattie.info/cs/forums/viewtopic.php?t=5046*

KnifeSyphon

Filename

• addons/eventscripts/syphon/es_syphon.txt

Description

KnifeSyphon gives you a health boost when you kill someone with a knife.

Usage and Notes

• Add

  es_load syphon

  to your autoexec.cfg
• KnifeSyphon is the official update to Mattie's original KnifeSyphon plugin.
• Provides an example for how to set player's health
• More information: http://www.mattie.info/cs/forums/viewtopic.php?t=5022

SlingShot

Filename

• addons/eventscripts/slingshot/es_slingshot.txt

Description

Adds (default) 200 rounds in your clip and when you shoot at a spot you are thrown at it.

Usage and Notes

• Add

  es_load slingshot

  to your autoexec.cfg
• Slingshot allows you to fling yourself around the map using shots fired from your default pistol.
• This is great fun.
• Provides examples for using vectors
• Provides example for unlimited ammo
• Provides example for applying a force 'push' to players
• More information: http://www.mattie.info/cs/forums/viewtopic.php?t=5279

Attract

Filename

• addons/eventscripts/attract/es_attract.txt

Description

Whenever a player shoots someone, they are pulled towards their victim forcefully.

Usage and Notes

• Add

  es_load attract

  to your autoexec.cfg
• Provides examples for using vectors
• Provides an example for how to apply a "push" to a player using es_setplayerprop