plugin_speech by yensid

This plugin contains speech functions and commands.
The idea for the speech commands, and the bulk of the code for speaktimeleft came from [WHO]Them.

For instructions on how to compile and install plugins, please refer to the Admin Mod manual, located online at http://www.adminmod.org - at the time this readme was written, the URL for the manual was located at http://www.adminmod.org/help/online/
The specifics for downloading and installing plugins is in the section titled 'Admin Mod Plugins'

COMMANDS

The commands for this plugin are as follows:
	admin_speak <target> <msg>: Speak words on system of target.
	admin_speakall <msg>: Speak words on system of everyone.
	admin_speakteam <team> <msg>: Speak words on systems of everyone on team.
say timeleft: Speaks the time remaining to all players.  Note, this does not override the default timeleft message that should display on everyone's screens.  Also, this action can only be performed once every 60 seconds, to prevent spamming.

<target> indicates a specific player's Session ID, WONID, name, or partial name.
<msg> is the words or .wav files you want to play.
<team> is the team number of the team you would like to play sounds for.

HOW IT WORKS

This plugin works by executing the 'speak' command on players' systems.  It can be duplicated locally by typing:
	speak "<msg>"
at the console.  Note, if you are running the speak command locally, you will need to enclose multiple words in quotes.  This is done automatically using admin_speak, admin_speakall, or admin_speakteam, so quotes are not necessary for using these Admin Mod commands.

ADDITIONAL INFORMATION

There are three basic methods for finding words to be used with this plugin, each a bit more complicated than the last.

1) The 'default' word list has been compiled by many different people, but at the time I'm writing this, I know M00 maintains a list at http://www.mudex.com/speak.htm - check there for the words you can easily use.  These can all be used simply by typing any combination of these words in the <msg> part of the commands.  For instance:
	admin_speakall hello soldier
would make everyonje's computers say 'Hello soldier.'

2) This is a touch more complicated - you can play other sounds from Half-Life or your mod as well.  Any .wav file in the sound subdirectory of your valve directory, or in the sound subdirectory of your mod's directory can be played.  Also, any .wav file in the sound directory of the .pak files in either the valve directory or your mod's directory can also be played.  To open the .pak files and see what they contain, use a program such as PakScape or PakExplorer, which should be easy enough to find by searching the internet.  When you open the .pak files, you'll see they contain a directory structure similar to the directory you found them in.

To play sounds from any of these subdirectories of sound, whether in the .pak file or not, you simply need to precede the .wav file you want to play with subdirectory name.  For instance, if you want to play ba_buttugly.way from the sound/barney subdirectoy in the pak0.pak file in your valve subdirectory, you would simply type:
	admin_speakall barney/ba_buttugly

A couple of notes here.  Do NOT put the .wav on the end.  Also, Half_life will automatically search the sound directory in the Valve directory, your mod's directory, and the .pak files (not necessarily in that order), so you won't have to specify which one you're trying to play sounds from.

One last thing concerning this method - by default (ie, you don't specify a directory), it will search in the sound/vox subdirectories - that's where all of the 'default' sounds mentioned in method 1 are located.  So, really, method 1 isn't actually a seperate method at all!  Oh, and if you're looking for them, the words for the female voice that announces the time remaining are in the sound/fvox directory of the .pak file in your Valve directory.

3) The last method concerns playing custom sounds and is quite complicated.  I'm not the most experienced at this, so if you are having trouble with this, you'll have better luck asking questions at the forums at http://www.adminmod.org than you will asking me directly.

That said, what you need to do for this method is create .res files in your mod's map subdirectory for the clients to download the sounds you want to play.  A .res file is simply a text file with the extension .res that contains a list of files a client needs before playing a certain map, and if they don't have it, they will download it, as long as the client has cl_allow_download set to 1 and the server has sv_allow_download set to 1.  A good example of a .res file can be found in the plugin_sank_sounds available at http://www.adminmod.org/ascript .  .res files should have the same name as the map you want the sounds to download on, but with the extension .res.  So if you wanted to have players download a sound when the map changes to de_dust, you would name your .res file 'de_dust.res' (without the quotes, of course).  If you wanted them to download a .wav file called yensid.wav, you could write your .res file with only this line:
	sound/vox/yensid.wav
and put yensid.wav in to the sound/vox subdirectory of your mod (you may need to make that directory if it doesn't already exist).  I chose the subdirectory of sound/vox because it is simpler to type the command then, since as I mentioned above it will check there by default, so I won't need to specify a direcotry name.  Then I could use a command such as:
	admin_speakall yensid is authorized to voilate you
and everyone would hear that sentence.

Hopefully this all makes sense to you!  If you have any further questions, please check on the forums at http://www.adminmod.org - we'll be happy to help you!