AlliedModders Wiki - User contributions [en]

Sample Plugins (Metamod:Source)

2012-07-07T00:31:33Z

LumiStance: /* Linux */

Metamod:Source comes with two sample plugins: <tt>stub</tt> and <tt>sample</tt>. This article is a brief overview of how to read and compile them. They are intended as a baseline for developing your own plugins, though they are certainly not required for your own development.

Metamod:Source is a C++ environment, but this is not a C++ tutorial. You should have sufficient knowledge of computer organization (memory, pointers, addressing) and intermediate experience with C++. Most importantly, you should be willing to dive into header files to research API definitions (which is necessary for the HL2SDK regardless).

Make sure to read the overview article, [[Metamod:Source Development]].

=Introduction=
Before you begin, you should set up your [[Metamod:Source Environment]]. If you fail to complete this step, it is unlikely much else in this article will work for you.

The two sample plugins provided are:
*<tt>stub_mm</tt> - Bare-bones plugin that does almost nothing.
*<tt>sample_mm</tt> - More complete example plugin which implements a few things that Valve's serverplugin_sample does, such as hooking functions, creating ConVars, console commands, and showing dialog boxes.

=The Engine Divide=
The Orange Box and Episode 1 engines are not compatible, and thus there is a division:
*Metamod:Source 1.4 API, Episode 1 and lower
*Metamod:Source 1.6 API, Orange Box and higher

This is explained more in [[MM:S API Differences]].

As such, you will notice various idiosyncrasies in the sample plugins. For example, <tt>METAMOD_PLAPI_VERSION</tt> exists in Metamod:Source 1.6 or later, so it is used to decide between <tt>GetEngineFactory</tt> (1.6) or <tt>engineFactory</tt> (1.4). Similarly, the sample plugins use two macros:
*<tt>ENGINE_ORANGEBOX</tt> - Orange Box build
*<tt>ENGINE_ORIGINAL</tt> - Original/Episode 1 build

These two macros are used in a few places to toggle functionality compatible for the given build.

For more information, see:
*[[MM:S API Differences]]
*[[Porting to Orange Box]]
*[[Porting to Left 4 Dead]]

=Compiling=

==Windows==
Both plugins have a Visual Studio 2008 project file in their <tt>msvc9</tt> folders. Each plugin has six build modes:
*<tt>Release - Left 4 Dead</tt> - Release mode, Left 4 Dead
*<tt>Debug - Left 4 Dead</tt> - Debug mode, Left 4 Dead
*<tt>Release - Orange Box</tt> - Release mode, Orange Box
*<tt>Debug - Orange Box</tt> - Debug mode, Orange Box
*<tt>Release - Original</tt> - Release mode, Original/Episode1
*<tt>Debug - Original</tt> - Debug mode, Original/Episode1

There exists normal "Release" and "Debug" build modes -- you should not use them, as they are not configured.

==Linux==
On Linux, you cannot simply type "make" in the folder containing the <tt>Makefile</tt>. You must specify a combination of parameters:
*<tt>ENGINE</tt> - Required. Must be either "orangebox" or "original" or "left4dead".
*<tt>DEBUG</tt> - Optional. Can be empty (Release mode) or "true" (Debug mode).

Binaries and object files will be written to one of the following folders:
*<tt>Release.left4dead</tt>
*<tt>Debug.left4dead</tt>
*<tt>Debug.orangebox</tt>
*<tt>Release.orangebox</tt>
*<tt>Debug.orangebox</tt>
*<tt>Release.original</tt>
*<tt>Debug.original</tt>

Examples of building one of the example plugins:
<pre>
#Episode 1, debug mode
make DEBUG=true ENGINE=original
#Orange Box, release mode
make ENGINE=orangebox
#Cleaning the Episode 1 build
make clean ENGINE=original
</pre>

'''Note''' that you may need to edit the folder locations at the top of the Makefile, in case you set up your paths differently.
'''Note''' ignore any messages that start with the word echo. A successful build creates a Debug.[mod]/filename.so or Release.[mod]/filename.so plugin file.

=Stub Plugin=
The stub plugin is a very simple, bare-bones plugin. It has little, if anything, beyond an implementation of the required API callbacks.

It hooks one function, <tt>IServerGameDLL::ServerActivate</tt>, which is a callback fired after <tt>IServerGameDLL::LevelInit</tt>.

Note that for the most part, <tt>stub_mm</tt> is free of compatibility cruft, whereas <tt>sample_mm</tt> tries to abstract more. This is so <tt>stub_mm</tt> doesn't appear to be "hiding" anything -- it's laid out very simply.

=Sample Plugin=
The full sample plugin is a bit more complicated, as it contains some of the examples from Valve's <tt>serverplugin_sample</tt>. It also may be a bit messy to read because of the engine compatibility wrappers in it.

==Compatibility Wrappers==
The first file of importance is <tt>engine_wrappers.h</tt>, which is full of compatibility shims. For example:
*<tt>engineFactory</tt> became <tt>GetEngineFactory</tt> from 1.4 to 1.6
*<tt>serverFactory</tt> became <tt>GetServerFactory</tt> from 1.4 to 1.6
*<tt>ISmmAPI::Format</tt> did not exist in 1.4, so we created a simple <tt>#define</tt> to use <tt>snprintf</tt> instead. You could also use Valve's Q_snprintf if you desired.
*Valve renamed <tt>VENGINE_CVAR_INTERFACE_VERSION</tt> to <tt>CVAR_INTERFACE_VERSION</tt> from Episode 1 to Orange Box.
*The syntax to <tt>SH_CALL</tt> changed from 1.4 to 1.6 (which we have demonstrated for completeness and will be explained later).

Also note the <tt>CCommand</tt> class. This is a wrapper around the <tt>IVEngineServer::Cmd_Arg*</tt> functions, which were removed in Orange Box. Valve replaced it with a newer, more re-entrant set of functions based around <tt>CCommand</tt>. Rather than create two codebases, we've simply wrapped the old functions in the new API. The functionality isn't ''exactly'' the same (becaose of re-entrancy), but it works nicely for our purposes. You can read more about this trick in [[Porting to Orange Box]].

==Overview==
===BaseAccessor===
This is a singleton class responsible for registering anything extending from <tt>ConCommandBase</tt> (<tt>ConVar</tt> and <tt>ConCommand</tt>). You only need one, and it should wrap <tt>META_REGCVAR</tt>.

Note that the accessor is invoked differently based on the engine version. For Orange Box, <tt>g_pCVar</tt> is assigned and <tt>ConVar_Register</tt> is called, whereas on Episode 1, only <tt>ConCommandBaseMgr::OneTimeInit</tt> is needed.

===CallClasses===
[[SourceHook Development|SourceHook]] has a feature where you can invoke a virtual function while bypassing all hooks on it. In SourceHook v4 (Metamod:Source 1.4 and lower), <tt>SH_CALL</tt> required a special object called a '''call class'''. This was removed in SourceHook v5. However, to be compatible with both MM:S 1.4 and 1.6, the sample plugin creates and destroys a call class when necessary.

For more information on this syntax and what it means, see: [[Sourcehook Development#Bypassing_Hooks]].

Note that the <tt>ENGINE_CALL</tt> macro is in <tt>engine_wrappers.h</tt>, and wraps <tt>SH_CALL</tt> based on the MM:S version.

===VSP Listening===
Some of the sample functionality requires an IServerPluginCallbacks pointer, and Metamod:Source can provide one for you.

In the Metamod:Source 1.4 API, you had to implement <tt>IMetamodListener</tt>, and do something like this:
<pre>
ismm->AddListener(this, this);
ismm->EnableVSPListener();
</pre>

Then you had to wait for the callback to give you a correct pointer. In Metamod:Source 1.6, you can attempt to get the point immediately with:
<pre>
if ((vsp_callbacks = ismm->GetVSPInfo(NULL)) == NULL)
</pre>

===Hooked Functions===
The sample plugin hooks most of the functions available to <tt>IServerPluginCallbacks</tt>, in order to show you how to re-implement Valve's functionality.

Recall a few concepts:
*In [[SourceHook Development|SourceHook]], hooks can either be "pre" (pre-empting the final call), or "post" (occurring after the pre hooks and final call, if any).
*In Valve Server Plugins, only hooks labeled with <tt>PLUGIN_RESULT</tt> can override functionality. SourceHook, however, can override the functionality of '''any function'''. The default action is to continue (or pass-through), though there are options to override and supercede (see the [[Sourcehook Development#Hook_Functions]] for more information).
*A hook with a return value must return a value, or else the compiler will complain. However, unless you use <tt>RETURN_META_VALUE</tt> with <tt>MRES_SUPERCEDE</tt> or <tt>MRES_OVERRIDE</tt>, the value will not affect anything.

The following are generic hooks that Valve Server Plugins cannot override, so in the example they're hooked as '''post'''.
*<tt>IServerGameDLL::LevelInit</tt>: Translates to <tt>LevelInit</tt>.
*<tt>IServerGameDLL::ServerActivate</tt>: Translates to <tt>ServerActivate</tt>.
*<tt>IServerGameDLL::GameFrame</tt>: Translates to <tt>GameFrame</tt>.
*<tt>IServerGameDLL::LevelShutdown</tt>: Translates to <tt>LevelShutdown</tt>. (This is not actually hooked false in the example, but you probably shouldn't try overriding it.)
*<tt>IServerGameClients::ClientActive</tt>: Translates to <tt>ClientActive</tt>. Not a very useful callback, not recommended for real work.
*<tt>IServerGameClients::ClientDisconnect</tt>: Translates to <tt>ClientDisconnect</tt>. Called when the client disconnects.
*<tt>IServerGameClients::ClientPutInServer</tt>: Translates to <tt>ClientPutInServer</tt>. Called when the client is put in-game and is fully instantiated (that is, IPlayerInfoManager will return valid results).
*<tt>IServerGameClients::SetCommandClient</tt>: Translates to <tt>SetCommandClient</tt>. Called when a console command bound to a <tt>ConCommand</tt> is invoked, to tell all listeners which client typed the command. The index supplied is the client index minus one (that is, -1 for the server console, 0 for the first client, et cetera).

The following hooks are pre-empted, and thus can be overridden or superseded:
*<tt>IServerGameClients::ClientSettingsChanged</tt>: Translates to <tt>ClientSettingsChanged</tt>. Called when a client's info buffer changes (that is, anything from <tt>IVEngineServer::GetClientConVarValue</tt>). Overriding it will prevent the game from being notified.
*<tt>IServerGameClients::ClientConnect</tt>: Translates to <tt>ClientConnect</tt>. Called when a client is connecting. You can override/supersede with a value of <tt>false</tt> to reject the client (note, of course, you should fill the rejection message buffer).
*<tt>IServerGameClients::ClientCommand</tt>: Translates to <tt>ClientCommand</tt>. Called when the client types unrecognized text in their client console. If you don't override this function, the original game's handler will be called. If the game doesn't recognize the text, it will print "Unknown command" or something similar. Therefore, if you wish to block this text from appearing, you should supercede when you recognize the text. The sample plugin shows how to do this for a few commands.

=The VDF Files=
Note that both <tt>stub_mm</tt> and <tt>sample_mm</tt> come with their own VDF files. These are example files that load their respective binaries from the <tt>addons</tt> folder. Make two notes about this:
*'''VDF files go in Metamod's folder'''. That is, <tt>addons/metamod</tt> (or whatever <tt>mm_basedir</tt> is). They are not Valve Server Plugin files and they cannot go in the <tt>addons</tt> folder.
*If your plugin has more than one file, or it creates other files, it may be prudent to place it in its own sub-folder. The sample plugins are small and thus we placed the binaries in <tt>addons</tt> for simplicity. The extended convention for more complicated plugins is:
**<tt>addons/NAME/bin/NAME_mm.dll</tt> or <tt>addons/NAME/bin/NAME_mm_i486.so</tt>. For example, <tt>addons/sourcemod/bin/sourcemod_mm</tt> is [[SourceMod]]'s VDF path, since it has a large directory structure.
**''Note: This convention is not required, but it is recommended.''

=Modifying/Reusing the Build Files=
==Linux==
The <tt>Makefile</tt>s are organized into four main sections:
*User-specific paths
*Project-specific settings
*Build logic
*Build rules

The most important area to edit for a new project would be the "project-specific settings." These are variables such as:
*<tt>OPT_FLAGS</tt> - Optimization flags (release-only).
*<tt>DEBUG_FLAGS</tt> - Debug-only flags.
*<tt>GCC4_FLAGS</tt> - Flags that are only used with GCC4.
*<tt>CPP</tt> - The compiler to invoke.
*<tt>BINARY</tt> - The binary file name to produce.
*<tt>LINK</tt> - Extra link options.
*<tt>INCLUDE</tt> - Extra include options (don't forget that you need -I to each item).

You should probably keep the <tt>-DENGINE_ORANGEBOX</tt> and <tt>-DENGINE_ORIGINAL</tt> macros.

For more information on flags and distribution, see [[Metamod:Source Development#Compiling]].

==Windows==
You should probably keep the <tt>ENGINE_ORANGEBOX</tt> and <tt>ENGINE_ORIGINAL</tt> preprocessor macros.

You can edit the output binary name under the Linker options in the Project Properties dialog.

You should not add global include folders in order to compile. Set up your [[Metamod:Source Environment]] and, if you need more include folders, add them to the "Additional Include Directories" option under the C++ options in the Project Properties dialog. It is a semicolon-delimited list, for example: <tt>$(SOURCEMM14);$(HL2SDK)\public</tt>.

For the most part, editing a Visual Studio project is otherwise self-explanatory. See [[Metamod:Source Development#Compiling]] for more information on required "project-from-scratch" options.

[[Category:Metamod:Source Development]]

SDKTools (SourceMod Scripting)

2011-10-30T08:26:10Z

LumiStance: /* Raw address lookups */ replace 'TODO'

The SDKTools extension is an extension for various functions provided by the Source SDK. Additionally, it has the ability to dynamically call many C++ functions in the SDK, for example, from CBaseEntity or any derived class.

SDKTools contains simplified versions of SDK functions pre-written for ease of use. These can be found in the additional include files:
*<tt>sdktools_functions.inc</tt> - Popular functions from the SDK.
*<tt>sdktools_sound.inc</tt> - [[#Sound Functions|Sound-related functions]].
*<tt>sdktools_tempents.inc</tt> - [[#TempEnt Functions|TempEnt-related functions]].
*<tt>sdktools_tempents_stocks.inc</tt> - [[TempEnts (SourceMod SDKTools)|TempEnt Stocks for convenience]].

SDKTools is powered by "BinTools," a powerful extension for creating dynamic C/C++ calls. BinTools is automatically loaded by SDKTools.

=GameConfigs=
GameConfig files go into the "gamedata" folder under "sourcemod." In older revisions it was under "sourcemod/configs" which is now deprecated.

==Virtual Offsets==
For adding virtual offsets, add sub-sections to the "Offsets" section of your game config file. For example:

<pre>
"Games"
{
"cstrike"
{
"Offsets"
{
"GiveNamedItem"
{
"windows" "329"
"linux" "330"
}
"EyePosition"
{
"windows" "117"
"linux" "118"
}
}
}
}</pre>

==Signature Scans==
For automated signature scans, add sub-sections to the "Signatures" section of your game config file. There are three properties for a signature:
*<tt>library</tt>: Must be "server" right now.
*<tt>windows</tt>: A signature written in binary; for example, "\x56" instead of "0x56" -- the '*' character is a single byte wildcard.
*<tt>linux</tt>: Either a signature as with <tt>windows</tt>, or a named symbol. To use a named symbol, start the string with the '@' character. If a signature begins with '@', write the character in hexadecimal as above.

Example:
<pre>
"Games"
{
"cstrike"
{
"Signatures"
{
"RoundRespawn"
{
"library" "server"
"windows" "\x56\x8B\xF1\x8B\x06\xFF\x90*\x04\x00\x00\x8B\x86*\x0D\x00"
"linux" "@_ZN9CCSPlayer12RoundRespawnEv"
}
}
}
}</pre>

==Raw address lookups==
See https://bugs.alliedmods.net/show_bug.cgi?id=3520 and http://wiki.alliedmods.net/SourceMod_1.4.0_API_Changes#SourceMod

Lets you peek and poke (limitation may apply) the Source Dedicated Server memory space, and get the address of a named thingamajig.
Server crashes a possible side affect.

==Inheritance==
If you wish for multiple mods to inherit from one block, you can add a special "#supported" section under a "#default" section. For example:

<pre>
"Games"
{
"#default"
{
"#supported"
{
"game" "dod"
}
}
}</pre>

This specifies that the given block will be read for Day of Defeat as well.

=Calling Functions=
Calling functions is complicated and requires strict attention to the C++ API you are trying to use. If you make a mistake, something bad '''will''' happen (and if not, you got lucky!) SDKTools is more complicated than PimpinJuice's "Hacks" extension because it precompiles all of the information needed to convert from Plugin memory to C++ types. This precompilation step ensures better safety and speed, but it lengthens the preparation process.

With that said, let's look at an overview of the call creation process. Before making calls, we must ''prepare'' the call. This will give us a <tt>Handle</tt> which will let us make as many calls as we like.
<ol>
<li>Init - The preparation must be initialized. Here we can specify the calling convention, which is either static, or BaseEntity/BasePlayer-based. BasePlayer should be used when only player entities should be allowed as the <tt>this</tt> pointer.</li>
<li>Destination - The call must have a destination address or virtual index to use. This is normally done via <tt>PrepSDKCall_SetFromConf</tt> which ties into gameconf files.</li>
<li>Return Info - If the call has return information, it must be set via <tt>PrepSDKCall_SetReturnInfo</tt>.</li>
<li>Parameters - Each parameter (if any) must be added with <tt>PrepSDKCall_AddParameter</tt>.</li>
<li>Finalize - The call must be finalized with <tt>EndPrepSDKCall</tt>, which will return a <tt>Handle</tt>. If it doesn't, one or more of the preparation operations failed.</li>
</ol>

For the examples below, consider a plugin called "sdkexamples.sp" which has a gamedata file of "plugin.sdkexamples.txt" containing the definitions in the first section.

==RoundRespawn Example==
CCSPlayer::RoundRespawn is a Counter-Strike Source function which respawns players. It used by CS:S DM. Prototype:
<pre>void CCSPlayer::RoundRespawn()</pre>

SDKCall example:
<pawn>#include <sourcemod>
#include <sdktools>

new Handle:hGameConf;
new Handle:hRoundRespawn;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");
StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "RoundRespawn");
hRoundRespawn = EndPrepSDKCall();
}

RespawnPlayer(client)
{
SDKCall(hRoundRespawn, client);
}</pawn>

Note that we did not have to set any extra information for parameters or return info, since CCSPlayer::RoundRespawn has no parameters and has a void return.

==GiveNamedItem Example==
GiveNamedItem will give a player a named item. Prototype:
<pre>virtual CBaseEntity *CBasePlayer::GiveNamedItem(const char *item, int iSubType = 0);</pre>

<pawn>#include <sourcemod>
#include <sdktools>

new Handle:hGameConf;
new Handle:hGiveNamedItem;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "GiveNamedItem");
PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_String, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
hGiveNamedItem = EndPrepSDKCall();
}

GiveItem(client, const String:item[])
{
return SDKCall(hGiveNamedItem, client, item, 0);
}</pawn>

==GetEyePosition Example==
Prototype:
<pre>virtual Vector CBaseEntity::EyePosition();</pre>

<pawn>#include <sourcemod>
#include <sdktools>

new Handle:hGameConf;
new Handle:hGetEyePosition;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "EyePosition");
PrepSDKCall_SetReturnInfo(SDKType_Vector, SDKPass_ByValue);
hGetEyePosition= EndPrepSDKCall();
}

GetEyePosition(client, Float:pos[3])
{
SDKCall(hGetEyePosition, client, pos);
}</pawn>

Note that the vector is returned as the third parameter (first parameter after the <tt>this</tt> pointer).

=TempEnt Functions=
TempEnts, also called "temporary entities," "tempentities," or "TEs," are quick graphical displays that are too simple to justify the overhead of a <tt>CBaseEntity</tt> instantiation or full server-side networkability. In the SDK, they are statically defined instances that can be "played back" to the client by simply sending a copy of its network class properties.

Temporary Entities are mod-dependent, in that a mod can change any of their properties or even the <tt>ITempEnts</tt> class definition. Because of this, SourceMod takes a very flexible approach:
*First, a temp entity is ''started'' by name using <tt>TE_Start</tt>. A list of all tempent names and their network classes can be dumped with <tt>sm_print_telist</tt> (SDKTools must be loaded).
*Second, all of the tempent's properties are set via the <tt>TE_Write</tt> natives. All tempent properties can be dumped to a file using <tt>sm_dump_teprops</tt>.
*Third, the properties are transmitted using <tt>TE_Send</tt>, <tt>TE_SendToAll</tt>, or <tt>TE_SendToClient</tt>.

As a convenience, SourceMod provides a number of pre-written stocks for SDK-defined temporary entities. While the <tt>TE_*</tt> natives are guaranteed to work on any fully-supported SourceMod mod, the <tt>TE_Setup*</tt> stocks are not, as a mod might change the property layouts or the functionalities of the SDK-defined tempents.

Some examples are below. For pictures, see [[TempEnts (SourceMod SDKTools)]].

Using stocks:
<pawn>SparkClient(client, const Float:pos[3], const Float:dir[3])
{
TE_SetupMetalSparks(pos, dir);
TE_SendToClient(client);
}</pawn>

Not using stocks:
<pawn>SparkClient(client, const Float:pos[3], const Float:dir[3])
{
TE_Start("Metal Sparks");
TE_WriteVector("m_vecPos", pos);
TE_WriteVector("m_vecDir", dir);
TE_SendToClient(client);
}</pawn>

=Sound Functions=
SDKTools exposes various sound-related members of IVEngineServer and IEngineSound. The basic functions are in <tt>sdktools_sound.inc</tt>:
*<tt>EmitAmbientSound</tt>: Plays an ambient sound from an origin.
*<tt>EmitSound, EmitSoundToClient, EmitSoundToAll</tt>: Plays a sound to a list of clients from a specific entity.

There are a few important properties about sounds:
*Entity: The entity the sound should come from. When playing a generic sound file to player(s), you should use <tt>SOUND_FROM_PLAYER</tt>, which is a special SourceMod macro for making the sound come from the player target. For ambient sounds you'd use <tt>SOUND_FROM_WORLD</tt>, and for sounds from an entity you'd use the entity index.
*Channel: Exposed as <tt>SNDCHAN_*</tt>, normally you only need to use <tt>SNDCHAN_AUTO</tt>. The channel affects how the sound is spatialized[?]
*Level: The decibel level. There are a number of predefined levels as <tt>SNDLEVEL_*</tt> -- the standard one is <tt>SNDLEVEL_NORMAL</tt>. Half-Life 1 used attenuation values instead; you can convert from these using <tt>ATTN_TO_SNDLEVEL()</tt>.
*Volume: The volume, on a scale of 0.0 to 1.0. To use a volume other than the default, the <tt>SND_CHANGEVOL</tt> flag should be included in the "flags" parameter. The default volume is <tt>SNDVOL_NORMAL</tt>.
*Pitch: The pitch; predefined values are <tt>SNDPITCH_*</tt> with <tt>SNDPITCH_NORMAL</tt> being the default. <tt>SND_CHANGEPITCH</tt> should be passed to use a non-default pitch.
*Origin: If specified, an origin to play the sound from.

Some very simple examples:
<pawn>
EmitSoundToClient(client, "bot/affirmative.wav");
EmitSoundToAll("radio/terwin.wav");
</pawn>

=Supported Mods=
SDKTools must have specific support added for each mod. So far, default support exists for the following modifications:
*Counter-Strike: Source
*Day of Defeat: Source
*Dystopia
*Half-Life 2: Deathmatch
*Insurgency (only some of the CBasePlayer SDK functions are available)
*Pirates, Vikings, and Knights II
*The Ship
*SourceForts

=See Also=
*[[Vfunc_offsets_%28SourceMM%29|Virtual Functions]]
*[[TempEnts (SourceMod SDKTools)|TempEnts]]
*[[Useful_Signatures_%28Source%29|Useful Signatures]]

[[Category:SourceMod Scripting]]

Metamod:Source Environment

2010-07-01T07:15:26Z

LumiStance: /* Getting the Files */

This article explains how to set up your Windows or Linux environment to compile Metamod:Source's sample plugins.

This article does not guarantee that you will be able to build third-party plugins, which may have their own build environment requirements. However, it creates a baseline for making sure you can successfully build plugins.

'''Note:''' You can use Valve's HL2SDK source tree, but we have our own available. It fixes all of Valve's mistakes such that you can build on both GCC and Visual Studio with no warnings or errors.

'''Note:''' This article is intended to be used against Metamod:Source 1.7.

=Requirements=

==Windows==
*Microsoft Visual C++ 2008 (Express or higher) is supported and used for official builds.
*Microsoft Visual C++ 2005 (Express or higher) is unsupported, though it should work as it is capable of building compatible binaries.
*Microsoft Visual C++ 2003 7.1 is unsupported. It is capable of building compatible binaries against the original (non-Orange Box SDK) only.
*Microsoft Visual C++ 2003 7.0 or lower '''cannot''' be used.

If you are installing Visual C++ 2005 Express, it may not come with Microsoft's Platform SDK installed. If this is the case, you must manually install the Platform SDK. You can find directions on how to do this and test your setup [http://www.microsoft.com/express/2005/platformsdk/default.aspx here]. According to Microsoft, Visual C++ 2008 "streamlines" the Platform SDK installation for you.

==Linux==
For Linux, Metamod:Source requires the GNU C/C++ Compiler (from GCC):
*Version 4.1 is used for official binaries and is guaranteed to build.
*Versions 3.4 through 4.2 are guaranteed to be binary (ABI) compatible. Metamod:Source and its sample plugins will probably build fine on them.
*Any GCC version below 3.4 '''cannot''' be used.

=Setup=
==Getting the Files==
This section describes which files you must have and how to get them. Do not worry about where to place them yet -- that will be discussed on a per-platform basis. You can download the files anywhere you'd like.

You can use the HL2SDK from Valve, but it's recommended you use the one linked to here. We have a patched version that fixes many compilation bugs and it will make your life easier on both operating systems. Link for [http://hg.alliedmods.net/hl2sdks/ HLSDK changes] located at bottom of Metamod:Source downloads page.

You need each SDK for each game you want to compile against (if your plugin requires knowledge about the game).

To get Metamod:Source files, visit [http://www.metamodsource.net/?go=downloads Metamod:Source downloads]. Make sure to get the source code and not the binaries.

==Linux==
As of this writing, SourceMod's Makefiles are hardcoded to use a binary called "gcc-4.1" You can override this, for example:
<pre>make CPP=gcc</pre>

Otherwise, you can also just create a symlink:
<pre>sudo ln -s /usr/bin/gcc /usr/bin/gcc-4.1</pre>

Note that you must use <tt>gcc</tt> and not <tt>g++</tt>. Using <tt>g++</tt> creates a <tt>libstdc++</tt> dependency, which may interfere with Valve's <tt>libstdc++</tt> usage and will cause platform portability problems in general. As a corollary you should avoid using STL, RTTI (Run-Time Type Information), or exceptions.

Metamod:Source's Makefiles have a strict directory organization. You must have a top-level folder. For this document, we'll assume it is called <tt>project</tt>, though it can be named anything. The layout of <tt>project</tt> should be:
*<tt>project</tt>/
**<tt>mmsource-1.7</tt> - symlink or folder containing Metamod:Source 1.7 source code
**<tt>hl2sdk</tt> - symlink or folder containing the HL2SDK for Episode 1
**<tt>hl2sdk-ob</tt> - symlink or folder containing the HL2SDK for Orange Box/TF
**<tt>hl2sdk-l4d</tt> - symlink or folder containing the HL2SDK for Left 4 Dead

If you are using a 64-bit version of Linux, you may need to install extra packages to be able to compile SourceMod. On Debian-based distros, these are typically:
<pre>
#prerequisites
#apt-get install g++-4.1 gcc-4.1 make mercurial
#apt-get instal libz libz-dev
#only needed if you want to use the build tool
#apt-get install mono mono-devel
#32-bit support
apt-get install ia32-libs
apt-get install lib32z1 lib32z1-dev
apt-get install libc6-dev-i386 libc6-i386
</pre>

In your projects, you should use <tt>mmsource-1.7/core</tt> for the new (1.6+) API and <tt>mmsource-1.7/core-legacy</tt> for the legacy (1.4-) API, needed for compatibility with the original MM:S engine.

==Windows==
On Windows, there is no particular directory layout required -- environment variables are used instead. The directions below apply to Windows XP, and are assumed to be similar for other versions of Windows.
*Open the Control Panel (for example, via Start -> Settings).
*Open the System control. If you don't see it, you may need to switch to "Classic view" (either via the left-hand pane or by going to Tools -> Folder Options).
*Click the Advanced tab.
*Click the Environment Variables button.

You can add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE17</tt> - Path to Metamod:Source 1.7 source code.
*<tt>HL2SDK</tt> - Path to HL2SDK for Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK for Ep2/OrangeBox
*<tt>HL2SDKL4D</tt> - Path to HL2SDK for Left 4 Dead

In your projects, you should use <tt>$(MMSOURCE17)/core</tt> for the new (1.6+) API and <tt>$(MMSOURCE17)/core-legacy</tt> for the legacy (1.4-) API, needed for compatibility with the original MM:S engine.

[[Category:Metamod:Source Development]]

Metamod:Source Environment

2010-07-01T07:14:58Z

LumiStance: /* Getting the Files */

This article explains how to set up your Windows or Linux environment to compile Metamod:Source's sample plugins.

This article does not guarantee that you will be able to build third-party plugins, which may have their own build environment requirements. However, it creates a baseline for making sure you can successfully build plugins.

'''Note:''' You can use Valve's HL2SDK source tree, but we have our own available. It fixes all of Valve's mistakes such that you can build on both GCC and Visual Studio with no warnings or errors.

'''Note:''' This article is intended to be used against Metamod:Source 1.7.

=Requirements=

==Windows==
*Microsoft Visual C++ 2008 (Express or higher) is supported and used for official builds.
*Microsoft Visual C++ 2005 (Express or higher) is unsupported, though it should work as it is capable of building compatible binaries.
*Microsoft Visual C++ 2003 7.1 is unsupported. It is capable of building compatible binaries against the original (non-Orange Box SDK) only.
*Microsoft Visual C++ 2003 7.0 or lower '''cannot''' be used.

If you are installing Visual C++ 2005 Express, it may not come with Microsoft's Platform SDK installed. If this is the case, you must manually install the Platform SDK. You can find directions on how to do this and test your setup [http://www.microsoft.com/express/2005/platformsdk/default.aspx here]. According to Microsoft, Visual C++ 2008 "streamlines" the Platform SDK installation for you.

==Linux==
For Linux, Metamod:Source requires the GNU C/C++ Compiler (from GCC):
*Version 4.1 is used for official binaries and is guaranteed to build.
*Versions 3.4 through 4.2 are guaranteed to be binary (ABI) compatible. Metamod:Source and its sample plugins will probably build fine on them.
*Any GCC version below 3.4 '''cannot''' be used.

=Setup=
==Getting the Files==
This section describes which files you must have and how to get them. Do not worry about where to place them yet -- that will be discussed on a per-platform basis. You can download the files anywhere you'd like.

You can use the HL2SDK from Valve, but it's recommended you use the one linked to here. We have a patched version that fixes many compilation bugs and it will make your life easier on both operating systems. Link for [HLSDK changes HLSDK changes] located at bottom of Metamod:Source downloads page.

You need each SDK for each game you want to compile against (if your plugin requires knowledge about the game).

To get Metamod:Source files, visit [http://www.metamodsource.net/?go=downloads Metamod:Source downloads]. Make sure to get the source code and not the binaries.

==Linux==
As of this writing, SourceMod's Makefiles are hardcoded to use a binary called "gcc-4.1" You can override this, for example:
<pre>make CPP=gcc</pre>

Otherwise, you can also just create a symlink:
<pre>sudo ln -s /usr/bin/gcc /usr/bin/gcc-4.1</pre>

Note that you must use <tt>gcc</tt> and not <tt>g++</tt>. Using <tt>g++</tt> creates a <tt>libstdc++</tt> dependency, which may interfere with Valve's <tt>libstdc++</tt> usage and will cause platform portability problems in general. As a corollary you should avoid using STL, RTTI (Run-Time Type Information), or exceptions.

Metamod:Source's Makefiles have a strict directory organization. You must have a top-level folder. For this document, we'll assume it is called <tt>project</tt>, though it can be named anything. The layout of <tt>project</tt> should be:
*<tt>project</tt>/
**<tt>mmsource-1.7</tt> - symlink or folder containing Metamod:Source 1.7 source code
**<tt>hl2sdk</tt> - symlink or folder containing the HL2SDK for Episode 1
**<tt>hl2sdk-ob</tt> - symlink or folder containing the HL2SDK for Orange Box/TF
**<tt>hl2sdk-l4d</tt> - symlink or folder containing the HL2SDK for Left 4 Dead

If you are using a 64-bit version of Linux, you may need to install extra packages to be able to compile SourceMod. On Debian-based distros, these are typically:
<pre>
#prerequisites
#apt-get install g++-4.1 gcc-4.1 make mercurial
#apt-get instal libz libz-dev
#only needed if you want to use the build tool
#apt-get install mono mono-devel
#32-bit support
apt-get install ia32-libs
apt-get install lib32z1 lib32z1-dev
apt-get install libc6-dev-i386 libc6-i386
</pre>

In your projects, you should use <tt>mmsource-1.7/core</tt> for the new (1.6+) API and <tt>mmsource-1.7/core-legacy</tt> for the legacy (1.4-) API, needed for compatibility with the original MM:S engine.

==Windows==
On Windows, there is no particular directory layout required -- environment variables are used instead. The directions below apply to Windows XP, and are assumed to be similar for other versions of Windows.
*Open the Control Panel (for example, via Start -> Settings).
*Open the System control. If you don't see it, you may need to switch to "Classic view" (either via the left-hand pane or by going to Tools -> Folder Options).
*Click the Advanced tab.
*Click the Environment Variables button.

You can add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE17</tt> - Path to Metamod:Source 1.7 source code.
*<tt>HL2SDK</tt> - Path to HL2SDK for Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK for Ep2/OrangeBox
*<tt>HL2SDKL4D</tt> - Path to HL2SDK for Left 4 Dead

In your projects, you should use <tt>$(MMSOURCE17)/core</tt> for the new (1.6+) API and <tt>$(MMSOURCE17)/core-legacy</tt> for the legacy (1.4-) API, needed for compatibility with the original MM:S engine.

[[Category:Metamod:Source Development]]

Adding Admins (SourceMod)

2009-01-18T11:14:28Z

LumiStance: /* Quick Start */

__FORCETOC__
SourceMod has as very detailed and flexible administration system, and it can be quite daunting to users. To simplify things, there are a number of "flags" which specify generic permissions administrators can have.

Aside from that, there are (currently) two provided ways of storing admins. One via a simplified flat file, and another via a more complex tree-based file.

SourceMod provides three methods of authentication by default:
*''Steam ID'' (unique to a Steam account)
*''IP Address'' (semi-unique to a given computer, better for LANs)
*''Name'' (requires a password)

=Quick Start=
On the server, open cstrike/addons/sourcemod/configs/admins_simple.ini

In a new line, add the following, replacing yoursteamid (use your client's console '''status''' command to retrieve your steamid - formatted as STEAM_n:o:p)

'''"yoursteamid" "99:z"'''

Save

Restart Server

Connect to Server with Client

Enter sm_admin into console, and return to game. You should see admin menu.

=Levels=
First, let's quickly run down the provided levels:
:{| cellpadding="5"
|- class="t2th"
| Name
| Flag
| Purpose
|- class="t2td"
| reservation
| a
| Reserved slot access.
|- class="t2td"
| generic
| b
| Generic admin; required for admins.
|- class="t2td"
| kick
| c
| Kick other players.
|- class="t2td"
| ban
| d
| Ban other players.
|- class="t2td"
| unban
| e
| Remove bans.
|- class="t2td"
| slay
| f
| Slay/harm other players.
|- class="t2td"
| changemap
| g
| Change the map or major gameplay features.
|- class="t2td"
| cvar
| h
| Change most cvars.
|- class="t2td"
| config
| i
| Execute config files.
|- class="t2td"
| chat
| j
| Special chat privileges.
|- class="t2td"
| vote
| k
| Start or create votes.
|- class="t2td"
| password
| l
| Set a password on the server.
|- class="t2td"
| rcon
| m
| Use RCON commands.
|- class="t2td"
| cheats
| n
| Change sv_cheats or use cheating commands.
|- class="t2td"
| root
| z
| Magically enables all flags.
|}

=Immunity=
In SourceMod, immunity is a flexible system based on ''immunity levels''. Every admin can have an arbitrary immunity value assigned to them. Whether an admin can target another admin depends on who has a higher immunity value.

For example, say Admin #1 has an immunity level of "3" and Admin #2 has an immunity level of "10." Admin #2 can target Admin #1, but Admin #1 cannot target Admin #2. The numbers are completely arbitrary, and they can be any number equal to or higher than 0. Note that 0 always implies no immunity.

By default, admins with the same immunity value can target each other. This can be changed via <tt>sm_immunity_mode</tt> in <tt>cfg/sourcemod.cfg</tt>.

=Passwords=
For passwords to work, the server administrator must change the "PassInfoVar" line in <tt>addons/sourcemod/configs/core.cfg</tt>. For example:
<pre>"PassInfoVar" "_sm1337"</pre>

Next, if an admin has a password, he or she must set the password via the ''setinfo'' command in the client console. For example, using the examples above, <tt>BAILOPAN</tt> would need to type:
<pre>setinfo "_sm1337" "Gab3n"</pre>

To automate this upon connecting to a server, you can create an "autoexec.cfg" file in your client <tt>cstrike</tt> folder. This will be located under <tt>SteamApps\ACCOUNT\Counter-Strike Source\cstrike\cfg</tt>. For example:
*<tt>C:\program files\steam\steamapps\bailopan\counter-strike source\cstrike\cfg</tt>

You can also set the password upon connecting. For steam and IP authentication, your admin privileges will be automatically assigned if the password is correct. For name based authentication, your password must be correct before you change your name, or else you will be kicked from the server.

=Simple Admins=
The easiest way to add administrators is through <tt>configs/admins_simple.ini</tt>. This is a flat file which requires two parameters per line: authentication info, and flags. The flag string is somewhat flexible and can have the following information:
*An optional immunity level value, followed by a colon (':');
*A flag string, '''or''';
*A group name, preceded by an '@' symbol

Three examples are provided:
<pre>
"STEAM_0:1:16" "bce" //generic, kick, unban for this steam ID. no immunity
"!127.0.0.1" "5:z" //all permissions for this ip, immunity level = 5
"BAILOPAN" "abc" "Gab3n" //name BAILOPAN, password "Gab3n": gets reservation, generic, kick
</pre>

=Detailed Admins=
Alternatively, you can add admins via <tt>configs/admins.cfg</tt>, a more advanced file stored in a KeyValues format. Each admin is its own block inside a main "Admin" block. The format is as follows:

<pre>Admins
{
"Admin Name"
{
"auth" "[steam|name|ip]"
"identity" "[unique id]"
"[option1]" "[value1]"
"[option2]" "[value2]"
/* .... */
}
}</pre>

Available options are:
*<tt>auth</tt>: Required. Must be one of <tt>steam</tt>, <tt>name</tt>, or <tt>ip</tt> (unless there is a custom auth method), and instructs SourceMod how to interpret the <tt>identity</tt> value.
*<tt>identity</tt>: Required. Unique value that allows SourceMod to find this admin given an authentication method and the given value.
*<tt>password</tt>: Optional. Specifies the password the user must enter (see above section on passwords).
*<tt>group</tt>: Optional. Specifies a group name the user should inherit if available. More than one "group" line can be specified. There should be no '@' symbol as there is no ambiguity.
*<tt>flags</tt>: Optional. Default access flags the user should receive.
*<tt>immunity</tt>: Optional: Default immunity level the user should receive.

The admin name is optional (it can be blank). It is not used internally and is intended for convenience usage by 3rd party tools.

Example:
<pre>Admins
{
"BAILOPAN"
{
"auth" "steam"
"identity" "STEAM_0:1:2345"
"flags" "abcdef"
"immunity" "5"
"group" "Awesome Admins"
}

"Blue Crab"
{
"auth" "steam"
"identity" "STEAM_0:1:666666"
"flags" "z"
"immunity" "99"
}
}</pre>

=See Also=
*[[Adding Groups (SourceMod)]]
*[[Overriding Command Access (SourceMod)]]

[[Category:SourceMod Documentation]]

Adding Admins (SourceMod)

2009-01-18T11:12:56Z

LumiStance: /* Quick Start */

__FORCETOC__
SourceMod has as very detailed and flexible administration system, and it can be quite daunting to users. To simplify things, there are a number of "flags" which specify generic permissions administrators can have.

Aside from that, there are (currently) two provided ways of storing admins. One via a simplified flat file, and another via a more complex tree-based file.

SourceMod provides three methods of authentication by default:
*''Steam ID'' (unique to a Steam account)
*''IP Address'' (semi-unique to a given computer, better for LANs)
*''Name'' (requires a password)

=Quick Start=
On the server, open cstrike/addons/sourcemod/configs/admins_simple.ini

In a new line, add the following, replacing yoursteamid (use your client's console '''status''' command to retrieve your steamid)

'''"yoursteamid" "99:z"'''

Save

Restart Server

Connect to Server with Client

Enter sm_admin into console, and return to game. You should see admin menu.

=Levels=
First, let's quickly run down the provided levels:
:{| cellpadding="5"
|- class="t2th"
| Name
| Flag
| Purpose
|- class="t2td"
| reservation
| a
| Reserved slot access.
|- class="t2td"
| generic
| b
| Generic admin; required for admins.
|- class="t2td"
| kick
| c
| Kick other players.
|- class="t2td"
| ban
| d
| Ban other players.
|- class="t2td"
| unban
| e
| Remove bans.
|- class="t2td"
| slay
| f
| Slay/harm other players.
|- class="t2td"
| changemap
| g
| Change the map or major gameplay features.
|- class="t2td"
| cvar
| h
| Change most cvars.
|- class="t2td"
| config
| i
| Execute config files.
|- class="t2td"
| chat
| j
| Special chat privileges.
|- class="t2td"
| vote
| k
| Start or create votes.
|- class="t2td"
| password
| l
| Set a password on the server.
|- class="t2td"
| rcon
| m
| Use RCON commands.
|- class="t2td"
| cheats
| n
| Change sv_cheats or use cheating commands.
|- class="t2td"
| root
| z
| Magically enables all flags.
|}

=Immunity=
In SourceMod, immunity is a flexible system based on ''immunity levels''. Every admin can have an arbitrary immunity value assigned to them. Whether an admin can target another admin depends on who has a higher immunity value.

For example, say Admin #1 has an immunity level of "3" and Admin #2 has an immunity level of "10." Admin #2 can target Admin #1, but Admin #1 cannot target Admin #2. The numbers are completely arbitrary, and they can be any number equal to or higher than 0. Note that 0 always implies no immunity.

By default, admins with the same immunity value can target each other. This can be changed via <tt>sm_immunity_mode</tt> in <tt>cfg/sourcemod.cfg</tt>.

=Passwords=
For passwords to work, the server administrator must change the "PassInfoVar" line in <tt>addons/sourcemod/configs/core.cfg</tt>. For example:
<pre>"PassInfoVar" "_sm1337"</pre>

Next, if an admin has a password, he or she must set the password via the ''setinfo'' command in the client console. For example, using the examples above, <tt>BAILOPAN</tt> would need to type:
<pre>setinfo "_sm1337" "Gab3n"</pre>

To automate this upon connecting to a server, you can create an "autoexec.cfg" file in your client <tt>cstrike</tt> folder. This will be located under <tt>SteamApps\ACCOUNT\Counter-Strike Source\cstrike\cfg</tt>. For example:
*<tt>C:\program files\steam\steamapps\bailopan\counter-strike source\cstrike\cfg</tt>

You can also set the password upon connecting. For steam and IP authentication, your admin privileges will be automatically assigned if the password is correct. For name based authentication, your password must be correct before you change your name, or else you will be kicked from the server.

=Simple Admins=
The easiest way to add administrators is through <tt>configs/admins_simple.ini</tt>. This is a flat file which requires two parameters per line: authentication info, and flags. The flag string is somewhat flexible and can have the following information:
*An optional immunity level value, followed by a colon (':');
*A flag string, '''or''';
*A group name, preceded by an '@' symbol

Three examples are provided:
<pre>
"STEAM_0:1:16" "bce" //generic, kick, unban for this steam ID. no immunity
"!127.0.0.1" "5:z" //all permissions for this ip, immunity level = 5
"BAILOPAN" "abc" "Gab3n" //name BAILOPAN, password "Gab3n": gets reservation, generic, kick
</pre>

=Detailed Admins=
Alternatively, you can add admins via <tt>configs/admins.cfg</tt>, a more advanced file stored in a KeyValues format. Each admin is its own block inside a main "Admin" block. The format is as follows:

<pre>Admins
{
"Admin Name"
{
"auth" "[steam|name|ip]"
"identity" "[unique id]"
"[option1]" "[value1]"
"[option2]" "[value2]"
/* .... */
}
}</pre>

Available options are:
*<tt>auth</tt>: Required. Must be one of <tt>steam</tt>, <tt>name</tt>, or <tt>ip</tt> (unless there is a custom auth method), and instructs SourceMod how to interpret the <tt>identity</tt> value.
*<tt>identity</tt>: Required. Unique value that allows SourceMod to find this admin given an authentication method and the given value.
*<tt>password</tt>: Optional. Specifies the password the user must enter (see above section on passwords).
*<tt>group</tt>: Optional. Specifies a group name the user should inherit if available. More than one "group" line can be specified. There should be no '@' symbol as there is no ambiguity.
*<tt>flags</tt>: Optional. Default access flags the user should receive.
*<tt>immunity</tt>: Optional: Default immunity level the user should receive.

The admin name is optional (it can be blank). It is not used internally and is intended for convenience usage by 3rd party tools.

Example:
<pre>Admins
{
"BAILOPAN"
{
"auth" "steam"
"identity" "STEAM_0:1:2345"
"flags" "abcdef"
"immunity" "5"
"group" "Awesome Admins"
}

"Blue Crab"
{
"auth" "steam"
"identity" "STEAM_0:1:666666"
"flags" "z"
"immunity" "99"
}
}</pre>

=See Also=
*[[Adding Groups (SourceMod)]]
*[[Overriding Command Access (SourceMod)]]

[[Category:SourceMod Documentation]]

Adding Admins (SourceMod)

2009-01-18T11:03:34Z

LumiStance: Added quick start

__FORCETOC__
SourceMod has as very detailed and flexible administration system, and it can be quite daunting to users. To simplify things, there are a number of "flags" which specify generic permissions administrators can have.

Aside from that, there are (currently) two provided ways of storing admins. One via a simplified flat file, and another via a more complex tree-based file.

SourceMod provides three methods of authentication by default:
*''Steam ID'' (unique to a Steam account)
*''IP Address'' (semi-unique to a given computer, better for LANs)
*''Name'' (requires a password)

=Quick Start=
On the server, open cstrike/addons/sourcemod/configs/admins_simple.ini

In a new line, add the following, replacing yoursteamid (use your client's console status command to retrieve your steamid)

'''"yoursteamid" "99:z"'''

Save

Restart Server

Connect to Server with Client

Enter sm_admin into console, and return to game. You should see admin menu.

=Levels=
First, let's quickly run down the provided levels:
:{| cellpadding="5"
|- class="t2th"
| Name
| Flag
| Purpose
|- class="t2td"
| reservation
| a
| Reserved slot access.
|- class="t2td"
| generic
| b
| Generic admin; required for admins.
|- class="t2td"
| kick
| c
| Kick other players.
|- class="t2td"
| ban
| d
| Ban other players.
|- class="t2td"
| unban
| e
| Remove bans.
|- class="t2td"
| slay
| f
| Slay/harm other players.
|- class="t2td"
| changemap
| g
| Change the map or major gameplay features.
|- class="t2td"
| cvar
| h
| Change most cvars.
|- class="t2td"
| config
| i
| Execute config files.
|- class="t2td"
| chat
| j
| Special chat privileges.
|- class="t2td"
| vote
| k
| Start or create votes.
|- class="t2td"
| password
| l
| Set a password on the server.
|- class="t2td"
| rcon
| m
| Use RCON commands.
|- class="t2td"
| cheats
| n
| Change sv_cheats or use cheating commands.
|- class="t2td"
| root
| z
| Magically enables all flags.
|}

=Immunity=
In SourceMod, immunity is a flexible system based on ''immunity levels''. Every admin can have an arbitrary immunity value assigned to them. Whether an admin can target another admin depends on who has a higher immunity value.

For example, say Admin #1 has an immunity level of "3" and Admin #2 has an immunity level of "10." Admin #2 can target Admin #1, but Admin #1 cannot target Admin #2. The numbers are completely arbitrary, and they can be any number equal to or higher than 0. Note that 0 always implies no immunity.

By default, admins with the same immunity value can target each other. This can be changed via <tt>sm_immunity_mode</tt> in <tt>cfg/sourcemod.cfg</tt>.

=Passwords=
For passwords to work, the server administrator must change the "PassInfoVar" line in <tt>addons/sourcemod/configs/core.cfg</tt>. For example:
<pre>"PassInfoVar" "_sm1337"</pre>

Next, if an admin has a password, he or she must set the password via the ''setinfo'' command in the client console. For example, using the examples above, <tt>BAILOPAN</tt> would need to type:
<pre>setinfo "_sm1337" "Gab3n"</pre>

To automate this upon connecting to a server, you can create an "autoexec.cfg" file in your client <tt>cstrike</tt> folder. This will be located under <tt>SteamApps\ACCOUNT\Counter-Strike Source\cstrike\cfg</tt>. For example:
*<tt>C:\program files\steam\steamapps\bailopan\counter-strike source\cstrike\cfg</tt>

You can also set the password upon connecting. For steam and IP authentication, your admin privileges will be automatically assigned if the password is correct. For name based authentication, your password must be correct before you change your name, or else you will be kicked from the server.

=Simple Admins=
The easiest way to add administrators is through <tt>configs/admins_simple.ini</tt>. This is a flat file which requires two parameters per line: authentication info, and flags. The flag string is somewhat flexible and can have the following information:
*An optional immunity level value, followed by a colon (':');
*A flag string, '''or''';
*A group name, preceded by an '@' symbol

Three examples are provided:
<pre>
"STEAM_0:1:16" "bce" //generic, kick, unban for this steam ID. no immunity
"!127.0.0.1" "5:z" //all permissions for this ip, immunity level = 5
"BAILOPAN" "abc" "Gab3n" //name BAILOPAN, password "Gab3n": gets reservation, generic, kick
</pre>

=Detailed Admins=
Alternatively, you can add admins via <tt>configs/admins.cfg</tt>, a more advanced file stored in a KeyValues format. Each admin is its own block inside a main "Admin" block. The format is as follows:

<pre>Admins
{
"Admin Name"
{
"auth" "[steam|name|ip]"
"identity" "[unique id]"
"[option1]" "[value1]"
"[option2]" "[value2]"
/* .... */
}
}</pre>

Available options are:
*<tt>auth</tt>: Required. Must be one of <tt>steam</tt>, <tt>name</tt>, or <tt>ip</tt> (unless there is a custom auth method), and instructs SourceMod how to interpret the <tt>identity</tt> value.
*<tt>identity</tt>: Required. Unique value that allows SourceMod to find this admin given an authentication method and the given value.
*<tt>password</tt>: Optional. Specifies the password the user must enter (see above section on passwords).
*<tt>group</tt>: Optional. Specifies a group name the user should inherit if available. More than one "group" line can be specified. There should be no '@' symbol as there is no ambiguity.
*<tt>flags</tt>: Optional. Default access flags the user should receive.
*<tt>immunity</tt>: Optional: Default immunity level the user should receive.

The admin name is optional (it can be blank). It is not used internally and is intended for convenience usage by 3rd party tools.

Example:
<pre>Admins
{
"BAILOPAN"
{
"auth" "steam"
"identity" "STEAM_0:1:2345"
"flags" "abcdef"
"immunity" "5"
"group" "Awesome Admins"
}

"Blue Crab"
{
"auth" "steam"
"identity" "STEAM_0:1:666666"
"flags" "z"
"immunity" "99"
}
}</pre>

=See Also=
*[[Adding Groups (SourceMod)]]
*[[Overriding Command Access (SourceMod)]]

[[Category:SourceMod Documentation]]

Installing SourceMod

2009-01-18T10:26:42Z

LumiStance: /* Remote Server */ spelling

Installing SourceMod is very simple, and it can be added with almost no configuration changes.

=Prerequisites=
A GUI Web Browser to retrive Metamod and SourceMod compressed archives.
A tool to copy archive to your dedicated server host.

SourceMod requires [[Metamod:Source]] 1.4.3 or higher. [http://www.metamodsource.net/ Click here] to visit the Metamod:Source homepage. Instructions to install SourceMM muanually can be found [http://wiki.alliedmods.net/index.php/Installing_Metamod:Source here].

SourceMod will run on any mod built using the Source SDK. It also supports "The Ship," which uses the Source engine.

=Uploading/Installing=
==Local Server==
To install SourceMod locally, simply extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera).
[http://www.sourcemod.net/downloads.php Download Here]

==Remote Server==
To install SourceMod remotely, first extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your local computer (for example, your Desktop). You will see an <tt>addons</tt> folder.

Using a tool such as [http://www.google.com/search?q=FTP FTP], locate your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera). Underneath this folder, you should have an <tt>addons</tt> folder (if not, Metamod:Source is probably not installed). From your local <tt>addons</tt> folder, upload the entire contents to your remote <tt>addons</tt> folder. When done, your remote <tt>addons</tt> folder should have a <tt>sourcemod</tt> folder.

If you have trouble with these steps, you need to get acquainted with FTP and server management. However, you can also ask your server provider for help. Some providers also have web interfaces for managing your server.

Alternatively, if you copied the tar.gz to your srcds directory, execute the following from the cstrike sub directory:
tar -xzf ../sourcemod-1.1.0.tar.gz

=Checking the Install=
Your folder layout should look like:
*<tt>[mod]</tt> - Your mod's folder
**<tt>addons</tt>
***<tt>metamod</tt> - Metamod:Source
***<tt>sourcemod</tt> - SourceMod

Once SourceMod is uploaded/copied and configured with Metamod:Source, restart your server completely. If it is local, shut it down and restart it. If it is remote, you may need to ask your server provider for help. However, it is often safe to issue a "quit" command via [[rcon]], and most providers will automatically restart your server.

First, in your [[server console]] (not client console), type:
<pre>meta list</pre>

If the install worked, you will see something like:
<pre>] meta list
Listing 1 plugin:
[01] SourceMod (1.1.0.2489) by AlliedModders LLC</pre>

You should then be able to use the SourceMod root console command, which can be invoked with simply:
<pre>sm</pre>

For example:
<pre>] sm version
SourceMod Version Information:
SourceMod Version: 1.1.0.2489
SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)
SourcePawn API: v1 = 4, v2 = 2
Compiled on: Sep 5 2008 02:02:12
http://www.sourcemod.net/
</pre>

Lastly, assuming you have already setup your administration user, you can test the in game menu by joining the server, and in the client console type the following:
<pre>sm_admin</pre>
You should see a menu popup with all you options.

=Troubleshooting=
If the install failed, you will generally see one of four symptoms.

==Metamod reports NOFILE or FAILED==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status
[01] - - - NOFILE </pre>

Most likely, either the files are not located in the correct place, or the file could not be loaded. For more information, use the following command (except use the correct list number):
<pre>meta list 1</pre>

==Metamod lists no plugins==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status </pre>

You forgot to add SourceMod to the <tt>addons/metamod/metaplugins.ini</tt> file.
Or if that doesn't fix your problem, make sure you are using the correct build of Sourcemod (zip = windows, tar = linux).

==Metamod says nothing==
If "meta list" has no reply at all, Metamod:Source is not properly installed. [http://wiki.alliedmods.net/index.php/Installing_SourceMM This wiki page] may provide you with clues on how to solve this problem.

[[Category:SourceMod Documentation]]

Installing SourceMod

2009-01-18T10:26:19Z

LumiStance: /* Remote Server */

Installing SourceMod is very simple, and it can be added with almost no configuration changes.

=Prerequisites=
A GUI Web Browser to retrive Metamod and SourceMod compressed archives.
A tool to copy archive to your dedicated server host.

SourceMod requires [[Metamod:Source]] 1.4.3 or higher. [http://www.metamodsource.net/ Click here] to visit the Metamod:Source homepage. Instructions to install SourceMM muanually can be found [http://wiki.alliedmods.net/index.php/Installing_Metamod:Source here].

SourceMod will run on any mod built using the Source SDK. It also supports "The Ship," which uses the Source engine.

=Uploading/Installing=
==Local Server==
To install SourceMod locally, simply extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera).
[http://www.sourcemod.net/downloads.php Download Here]

==Remote Server==
To install SourceMod remotely, first extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your local computer (for example, your Desktop). You will see an <tt>addons</tt> folder.

Using a tool such as [http://www.google.com/search?q=FTP FTP], locate your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera). Underneath this folder, you should have an <tt>addons</tt> folder (if not, Metamod:Source is probably not installed). From your local <tt>addons</tt> folder, upload the entire contents to your remote <tt>addons</tt> folder. When done, your remote <tt>addons</tt> folder should have a <tt>sourcemod</tt> folder.

If you have trouble with these steps, you need to get acquainted with FTP and server management. However, you can also ask your server provider for help. Some providers also have web interfaces for managing your server.

Alternatively, if you copied the tar.gz to your srcds directory, excute the following from the cstrike sub directory:
tar -xzf ../sourcemod-1.1.0.tar.gz

=Checking the Install=
Your folder layout should look like:
*<tt>[mod]</tt> - Your mod's folder
**<tt>addons</tt>
***<tt>metamod</tt> - Metamod:Source
***<tt>sourcemod</tt> - SourceMod

Once SourceMod is uploaded/copied and configured with Metamod:Source, restart your server completely. If it is local, shut it down and restart it. If it is remote, you may need to ask your server provider for help. However, it is often safe to issue a "quit" command via [[rcon]], and most providers will automatically restart your server.

First, in your [[server console]] (not client console), type:
<pre>meta list</pre>

If the install worked, you will see something like:
<pre>] meta list
Listing 1 plugin:
[01] SourceMod (1.1.0.2489) by AlliedModders LLC</pre>

You should then be able to use the SourceMod root console command, which can be invoked with simply:
<pre>sm</pre>

For example:
<pre>] sm version
SourceMod Version Information:
SourceMod Version: 1.1.0.2489
SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)
SourcePawn API: v1 = 4, v2 = 2
Compiled on: Sep 5 2008 02:02:12
http://www.sourcemod.net/
</pre>

Lastly, assuming you have already setup your administration user, you can test the in game menu by joining the server, and in the client console type the following:
<pre>sm_admin</pre>
You should see a menu popup with all you options.

=Troubleshooting=
If the install failed, you will generally see one of four symptoms.

==Metamod reports NOFILE or FAILED==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status
[01] - - - NOFILE </pre>

Most likely, either the files are not located in the correct place, or the file could not be loaded. For more information, use the following command (except use the correct list number):
<pre>meta list 1</pre>

==Metamod lists no plugins==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status </pre>

You forgot to add SourceMod to the <tt>addons/metamod/metaplugins.ini</tt> file.
Or if that doesn't fix your problem, make sure you are using the correct build of Sourcemod (zip = windows, tar = linux).

==Metamod says nothing==
If "meta list" has no reply at all, Metamod:Source is not properly installed. [http://wiki.alliedmods.net/index.php/Installing_SourceMM This wiki page] may provide you with clues on how to solve this problem.

[[Category:SourceMod Documentation]]

Installing SourceMod

2009-01-18T10:20:30Z

LumiStance: Important download information

Installing SourceMod is very simple, and it can be added with almost no configuration changes.

=Prerequisites=
A GUI Web Browser to retrive Metamod and SourceMod compressed archives.
A tool to copy archive to your dedicated server host.

SourceMod requires [[Metamod:Source]] 1.4.3 or higher. [http://www.metamodsource.net/ Click here] to visit the Metamod:Source homepage. Instructions to install SourceMM muanually can be found [http://wiki.alliedmods.net/index.php/Installing_Metamod:Source here].

SourceMod will run on any mod built using the Source SDK. It also supports "The Ship," which uses the Source engine.

=Uploading/Installing=
==Local Server==
To install SourceMod locally, simply extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera).
[http://www.sourcemod.net/downloads.php Download Here]

==Remote Server==
To install SourceMod remotely, first extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your local computer (for example, your Desktop). You will see an <tt>addons</tt> folder.

Using a tool such as [http://www.google.com/search?q=FTP FTP], locate your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera). Underneath this folder, you should have an <tt>addons</tt> folder (if not, Metamod:Source is probably not installed). From your local <tt>addons</tt> folder, upload the entire contents to your remote <tt>addons</tt> folder. When done, your remote <tt>addons</tt> folder should have a <tt>sourcemod</tt> folder.

If you have trouble with these steps, you need to get acquainted with FTP and server management. However, you can also ask your server provider for help. Some providers also have web interfaces for managing your server.

=Checking the Install=
Your folder layout should look like:
*<tt>[mod]</tt> - Your mod's folder
**<tt>addons</tt>
***<tt>metamod</tt> - Metamod:Source
***<tt>sourcemod</tt> - SourceMod

Once SourceMod is uploaded/copied and configured with Metamod:Source, restart your server completely. If it is local, shut it down and restart it. If it is remote, you may need to ask your server provider for help. However, it is often safe to issue a "quit" command via [[rcon]], and most providers will automatically restart your server.

First, in your [[server console]] (not client console), type:
<pre>meta list</pre>

If the install worked, you will see something like:
<pre>] meta list
Listing 1 plugin:
[01] SourceMod (1.1.0.2489) by AlliedModders LLC</pre>

You should then be able to use the SourceMod root console command, which can be invoked with simply:
<pre>sm</pre>

For example:
<pre>] sm version
SourceMod Version Information:
SourceMod Version: 1.1.0.2489
SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)
SourcePawn API: v1 = 4, v2 = 2
Compiled on: Sep 5 2008 02:02:12
http://www.sourcemod.net/
</pre>

Lastly, assuming you have already setup your administration user, you can test the in game menu by joining the server, and in the client console type the following:
<pre>sm_admin</pre>
You should see a menu popup with all you options.

=Troubleshooting=
If the install failed, you will generally see one of four symptoms.

==Metamod reports NOFILE or FAILED==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status
[01] - - - NOFILE </pre>

Most likely, either the files are not located in the correct place, or the file could not be loaded. For more information, use the following command (except use the correct list number):
<pre>meta list 1</pre>

==Metamod lists no plugins==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status </pre>

You forgot to add SourceMod to the <tt>addons/metamod/metaplugins.ini</tt> file.
Or if that doesn't fix your problem, make sure you are using the correct build of Sourcemod (zip = windows, tar = linux).

==Metamod says nothing==
If "meta list" has no reply at all, Metamod:Source is not properly installed. [http://wiki.alliedmods.net/index.php/Installing_SourceMM This wiki page] may provide you with clues on how to solve this problem.

[[Category:SourceMod Documentation]]

Installing SourceMod

2009-01-18T10:14:55Z

LumiStance: Add link

Installing SourceMod is very simple, and it can be added with almost no configuration changes.

=Prerequisites=
SourceMod requires [[Metamod:Source]] 1.4.3 or higher. [http://www.metamodsource.net/ Click here] to visit the Metamod:Source homepage. Instructions to install SourceMM muanually can be found [http://wiki.alliedmods.net/index.php/Installing_Metamod:Source here].

SourceMod will run on any mod built using the Source SDK. It also supports "The Ship," which uses the Source engine.

=Uploading/Installing=
==Local Server==
To install SourceMod locally, simply extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera).
[http://www.sourcemod.net/downloads.php Download Here]

==Remote Server==
To install SourceMod remotely, first extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your local computer (for example, your Desktop). You will see an <tt>addons</tt> folder.

Using a tool such as [http://www.google.com/search?q=FTP FTP], locate your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera). Underneath this folder, you should have an <tt>addons</tt> folder (if not, Metamod:Source is probably not installed). From your local <tt>addons</tt> folder, upload the entire contents to your remote <tt>addons</tt> folder. When done, your remote <tt>addons</tt> folder should have a <tt>sourcemod</tt> folder.

If you have trouble with these steps, you need to get acquainted with FTP and server management. However, you can also ask your server provider for help. Some providers also have web interfaces for managing your server.

=Checking the Install=
Your folder layout should look like:
*<tt>[mod]</tt> - Your mod's folder
**<tt>addons</tt>
***<tt>metamod</tt> - Metamod:Source
***<tt>sourcemod</tt> - SourceMod

Once SourceMod is uploaded/copied and configured with Metamod:Source, restart your server completely. If it is local, shut it down and restart it. If it is remote, you may need to ask your server provider for help. However, it is often safe to issue a "quit" command via [[rcon]], and most providers will automatically restart your server.

First, in your [[server console]] (not client console), type:
<pre>meta list</pre>

If the install worked, you will see something like:
<pre>] meta list
Listing 1 plugin:
[01] SourceMod (1.1.0.2489) by AlliedModders LLC</pre>

You should then be able to use the SourceMod root console command, which can be invoked with simply:
<pre>sm</pre>

For example:
<pre>] sm version
SourceMod Version Information:
SourceMod Version: 1.1.0.2489
SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)
SourcePawn API: v1 = 4, v2 = 2
Compiled on: Sep 5 2008 02:02:12
http://www.sourcemod.net/
</pre>

Lastly, assuming you have already setup your administration user, you can test the in game menu by joining the server, and in the client console type the following:
<pre>sm_admin</pre>
You should see a menu popup with all you options.

=Troubleshooting=
If the install failed, you will generally see one of four symptoms.

==Metamod reports NOFILE or FAILED==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status
[01] - - - NOFILE </pre>

Most likely, either the files are not located in the correct place, or the file could not be loaded. For more information, use the following command (except use the correct list number):
<pre>meta list 1</pre>

==Metamod lists no plugins==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status </pre>

You forgot to add SourceMod to the <tt>addons/metamod/metaplugins.ini</tt> file.
Or if that doesn't fix your problem, make sure you are using the correct build of Sourcemod (zip = windows, tar = linux).

==Metamod says nothing==
If "meta list" has no reply at all, Metamod:Source is not properly installed. [http://wiki.alliedmods.net/index.php/Installing_SourceMM This wiki page] may provide you with clues on how to solve this problem.

[[Category:SourceMod Documentation]]