AlliedModders Wiki - User contributions [en]

Building SourceMod

2018-06-10T00:49:45Z

Castile: /* Source and Dependencies */

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++. VS/VC 2010 or above is required for SourceMod 1.6.x and earlier. VS/VC 2013 Update 2 or above is required for SourceMod 1.7.x and later. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild to <tt>C:\mozilla-build</tt>.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run as administrator the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, version 4.4 or higher is required for SourceMod 1.6.x and earlier, and version 4.7 or high for SourceMod 1.7.x and later. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>

Newer versions, for example Debian 7.0+ or Ubuntu 13.04+ require slightly different packages:
<pre>
sudo apt-get install lib32stdc++-4.8-dev
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

''You can find the latest release of Clang in LLVM's apt repositories for Debian and Ubuntu. Information on this is at http://llvm.org/apt/''

==Archlinux==

# Enable multilib repository as described in the [https://wiki.archlinux.org/index.php/multilib Archlinux wiki page].
# Install the following packages:
#:<pre>pacman -S git python2 gcc-multilib lib32-glibc lib32-libstdc++5 lib32-zlib</pre>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.

'''You should do a recursive checkout of the git repo since the sourcepawn repo is a submodule of sourcemod now, see https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules to do that.'''
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone --recursive https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone --mirror https://github.com/alliedmodders/hl2sdk hl2sdk-proxy-repo
# For each SDK you want to build with:
# git clone hl2sdk-proxy-repo hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-proxy-repo hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev

# If building version 1.10 of SourceMod, use MySQL 5.5
wget https://cdn.mysql.com/archives/mysql-5.5/mysql-5.5.54-win32.zip mysql-5.5

# If building < version 1.10 of SourceMod, use MySQL 5.0
wget https://cdn.mysql.com/archives/mysql-5.0/mysql-noinstall-5.0.24a-win32.zip mysql-5.0

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder within your sourcemod folder, and then run <tt>configure.py</tt>. For example:
<pre>
cd sourcemod
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.
*--sdks css - Only build css.

See configure.py for all the options.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#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.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Building SourceMod

2018-06-10T00:49:15Z

Castile:

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++. VS/VC 2010 or above is required for SourceMod 1.6.x and earlier. VS/VC 2013 Update 2 or above is required for SourceMod 1.7.x and later. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild to <tt>C:\mozilla-build</tt>.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run as administrator the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, version 4.4 or higher is required for SourceMod 1.6.x and earlier, and version 4.7 or high for SourceMod 1.7.x and later. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>

Newer versions, for example Debian 7.0+ or Ubuntu 13.04+ require slightly different packages:
<pre>
sudo apt-get install lib32stdc++-4.8-dev
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

''You can find the latest release of Clang in LLVM's apt repositories for Debian and Ubuntu. Information on this is at http://llvm.org/apt/''

==Archlinux==

# Enable multilib repository as described in the [https://wiki.archlinux.org/index.php/multilib Archlinux wiki page].
# Install the following packages:
#:<pre>pacman -S git python2 gcc-multilib lib32-glibc lib32-libstdc++5 lib32-zlib</pre>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.

'''You should do a recursive checkout of the git repo since the sourcepawn repo is a submodule of sourcemod now, see https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules to do that.'''
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone --recursive https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone --mirror https://github.com/alliedmodders/hl2sdk hl2sdk-proxy-repo
# For each SDK you want to build with:
# git clone hl2sdk-proxy-repo hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-proxy-repo hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev

# If building version 1.10 of SourceMod, use MySQL 5.5
wget https://cdn.mysql.com/archives/mysql-5.5/mysql-5.5.54-win32.zip mysql-5.5

# If building < version 1.10 of SourceMod, use MySQL 5.0
wget https://cdn.mysql.com/archives/mysql-5.0/mysql-noinstall-5.0.24a-win32.zip mysql-noinstall-5.0.24a-win32

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder within your sourcemod folder, and then run <tt>configure.py</tt>. For example:
<pre>
cd sourcemod
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.
*--sdks css - Only build css.

See configure.py for all the options.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#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.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Building SourceMod

2018-06-09T22:05:41Z

Castile:

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++. VS/VC 2010 or above is required for SourceMod 1.6.x and earlier. VS/VC 2013 Update 2 or above is required for SourceMod 1.7.x and later. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild to <tt>C:\mozilla-build</tt>.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run as administrator the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, version 4.4 or higher is required for SourceMod 1.6.x and earlier, and version 4.7 or high for SourceMod 1.7.x and later. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>

Newer versions, for example Debian 7.0+ or Ubuntu 13.04+ require slightly different packages:
<pre>
sudo apt-get install lib32stdc++-4.8-dev
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

''You can find the latest release of Clang in LLVM's apt repositories for Debian and Ubuntu. Information on this is at http://llvm.org/apt/''

==Archlinux==

# Enable multilib repository as described in the [https://wiki.archlinux.org/index.php/multilib Archlinux wiki page].
# Install the following packages:
#:<pre>pacman -S git python2 gcc-multilib lib32-glibc lib32-libstdc++5 lib32-zlib</pre>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.

'''You should do a recursive checkout of the git repo since the sourcepawn repo is a submodule of sourcemod now, see https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules to do that.'''
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone --recursive https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone --mirror https://github.com/alliedmodders/hl2sdk hl2sdk-proxy-repo
# For each SDK you want to build with:
# git clone hl2sdk-proxy-repo hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-proxy-repo hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev
wget https://cdn.mysql.com/archives/mysql-5.5/mysql-5.5.54-win32.zip mysql-5.5

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder within your sourcemod folder, and then run <tt>configure.py</tt>. For example:
<pre>
cd sourcemod
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.
*--sdks css - Only build css.

See configure.py for all the options.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#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.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Introduction to SourceMod Plugins

2014-05-28T23:21:14Z

Castile: /* Getting code to run */

This guide will give you a basic introduction to writing a [[SourceMod]] plugin. If you are not familiar with the SourcePawn language, it is recommended that you at least briefly read the [[Introduction to SourcePawn]] article.

For information on compiling plugins, see [[Compiling SourceMod Plugins]]. You can use [http://www.crimsoneditor.com/ Crimson Editor], [http://www.pspad.com/ PSPad], [http://www.ultraedit.com/ UltraEdit], [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++], [http://www.textpad.com/ TextPad], [http://sourceforge.net/projects/pawnstudio/ Pawn Studio] or any other text editor you're comfortable with to write plugins.

=Starting from scratch=
Open your favorite text editor and create a new empty file. When you have an empty file you can just start writing code using the core language, however, you will not be able to use any of SourceMod features because the compiler does not now about them. This is done deliberately so it is possible to use SourcePawn outside of SourceMod. But since we are writing a SourceMod plugin, it is a good idea to enable access to SourceMod features first. This it done using <tt>#include</tt> directive. It tells compiler to "paste" the code from another file into yours.
<pawn>#include <sourcemod></pawn>
How does this work? First of all, note that we enclosed file name into angle brackets. Angle brackets tell the compiler to look in the default include directory. By default, it is '''scripting/include'''. You can open it right now and see a lot of inc files there. Those are SourceMod include files that describe various functions, tags and other features available for SourceMod plugins. The files are plain-text and you are encouraged to read them. You will notice however, that there's not much code in there, certainly not enough to implement all the great features of SourceMod, so where are they? They are implemented inside a SourceMod core which is written in C++ and is compiled into binary files which end up in '''bin''' directory. So how does your SourcePawn code and SM core link together if compiler doesn't know about existence of the latter? SourceMod include files are written specially, so they say that the implementation of functions is ''somewhere else''. Compiler understands that and generate a special code that says that this function call is going outside. When SourceMod loads your plugin, it inspects these bits of code and substitutes it's own internal functions instead. This is called [http://en.wikipedia.org/wiki/Dynamic_linking dynamic linking].

=Setting up plugin info=
Now that we got access to SourceMod features, it is time to setup the information that will be displayed via <tt>sm plugins list</tt> command. No one likes unnamed plugins. To do that we are going to look inside '''sourcemod.inc''' file and see the format that information should be declared. It's always helpful to look inside SM include files to find out information you don't know. There is also an [http://docs.sourcemod.net/api/ API documentation] but it can be outdated and it only has SM core files so if your plugin are going to use any third party extension or another plugin, you will have to study inc files. So, open '''sourcemod.inc''' and scroll down a bit until you see this:
<pawn>/**
* Plugin public information.
*/
struct Plugin
{
const String:name[], /**< Plugin Name */
const String:description[], /**< Plugin Description */
const String:author[], /**< Plugin Author */
const String:version[], /**< Plugin Version */
const String:url[], /**< Plugin URL */
};</pawn>
and this:
<pawn>/**
* Declare this as a struct in your plugin to expose its information.
* Example:
*
* public Plugin:myinfo =
* {
* name = "My Plugin",
* //etc
* };
*/
public Plugin:myinfo;</pawn>

It tells us that we need to create a global public variable <tt>myinfo</tt> which must be of type <tt>Plugin</tt> which is a struct with 5 fields which themselves are strings. It may sound complicated for a beginner but it's easy. Let's go ahead and create one:
<pawn>public Plugin:myinfo =
{
name = "My First Plugin",
author = "Me",
description = "My first plugin ever",
version = "1.0",
url = "http://www.sourcemod.net/"
};</pawn>

The <tt>public</tt> keyword means that SourceMod will be able to directly access our variable. <tt>Plugin:</tt> defines a type of our variable. <tt>myinfo</tt> is, obviously, a name of our variable as required by SourceMod. You see that we initialize it right away. This is preferred way to do when filling out plugin info.

After that the full code of your plugin should look like this:
<pawn>#include <sourcemod>

public Plugin:myinfo =
{
name = "My First Plugin",
author = "Me",
description = "My first plugin ever",
version = "1.0",
url = "http://www.sourcemod.net/"
};</pawn>

=Getting code to run=
We already include SourceMod features and filled up or plugin info. We now have a perfectly well formed plugin which can be compiled and loaded by SourceMod. However, there is one problem - it does nothing. You might be tempted to just start writing a code after <tt>myinfo</tt> declaration just to see that it will not compile. SourcePawn, unlike other scripting languages like Lua, does not allow a code to be outside of functions. After reading that, you may probably want to just define some function, name it <tt>main</tt> probably, compile and load a plugin and see that your code never gets called. So how do we make SourceMod call our code? For this exact reason we have forwards. Forwards are function prototypes declared by one party that can be implemented by another party as a [http://en.wikipedia.org/wiki/Callback_%28computer_programming%29 callback]. When a first party starts a forward call, all parties that have matching callbacks receive the call. SourceMod declares a plenty of interesting forwards that we can implement. As you can see, forwards are the only way to get our code executed, keep that in mind. So let's implement <tt>OnPluginStart</tt> forward. As you may have guessed, it is called when our plugin starts. To do that, we'll have to look up the declaration of <tt>OnPluginStart</tt>. It is declared inside '''sourcemod.inc''', a file we are already familiar with, let's find it:
<pawn>/**
* Called when the plugin is fully initialized and all known external references
* are resolved. This is only called once in the lifetime of the plugin, and is
* paired with OnPluginEnd().
*
* If any run-time error is thrown during this callback, the plugin will be marked
* as failed.
*
* It is not necessary to close any handles or remove hooks in this function.
* SourceMod guarantees that plugin shutdown automatically and correctly releases
* all resources.
*
* @noreturn
*/
forward OnPluginStart();</pawn>
Empty parentheses tells us that no arguments are passed inside this forward, <tt>@noreturn</tt> inside documentation tells us that we don't have to return anything, pretty simple forward. So how to write a correct callback for it? Firstly, our callback must have the same name, so it's <tt>OnPluginStart</tt>, secondly, our callback should have the same number of arguments, none in this case, and lastly, SourceMod needs to be able to call our callback so it needs to be <tt>public</tt>. So the implementation looks like this:
<pawn>public OnPluginStart()
{
}</pawn>

Now we can write code inside curly brackets and it will be executed when our plugin starts. Let's output <tt>"Hello world!"</tt> to server console. To do that we are going to use <tt>PrintToServer</tt> function. It is declared inside '''console.inc''', however, we don't need to manually include '''console.inc''' because it is included automatically as part of '''sourcemod.inc'''.
<pawn>/**
* Sends a message to the server console.
*
* @param format Formatting rules.
* @param ... Variable number of format parameters.
* @noreturn
*/
native PrintToServer(const String:format[], any:...);</pawn>
As you can see, this is a native function. It is implemented inside SM core. Judging by it's arguments, we can see that it is a [[Format_Class_Functions_%28SourceMod_Scripting%29|format class function]]. However, we don't need any formatting right now, so let's just pass <tt>"Hello world!"</tt> string as an only argument:
<pawn>public OnPluginStart()
{
PrintToServer("Hello world!");
}</pawn>
That's it! The full code of your plugin should look like this:
<pawn>#include <sourcemod>

public Plugin:myinfo =
{
name = "My First Plugin",
author = "Me",
description = "My first plugin ever",
version = "1.0",
url = "http://www.sourcemod.net/"
};

public OnPluginStart()
{
PrintToServer("Hello world!");
}</pawn>
Compile and load your plugin on your server and see for yourself that the message is displayed in server console.

=Includes=
Pawn requires '''include files''', much like C requires header files. Include files list all of the structures, functions, callbacks, and tags that are available. There are three types of include files:
*'''Core''' - <tt>sourcemod.inc</tt> and anything it includes. These are all provided by SourceMod's Core.
*'''Extension''' - adds a dependency against a certain extension.
*'''Plugin''' - adds a dependency against a certain plugin.

Include files are loaded using the <tt>#include</tt> compiler directive.

=Commands=
Our first example will be writing a simple admin command to slap a player. We'll continue to extend this example with more features until we have a final, complete result.

==Declaration==
First, let's look at what an admin command requires. Admin commands are registered using the [http://docs.sourcemod.net/api/index.php?fastload=show&id=471& RegAdminCmd] function. They require a '''name''', a '''callback function''', and '''default admin flags'''.

The callback function is what's invoked every time the command is used. [http://docs.sourcemod.net/api/index.php?fastload=show&id=771& Click here] to see its prototype. Example:

<pawn>
public OnPluginStart()
{
RegAdminCmd("sm_myslap", Command_MySlap, ADMFLAG_SLAY);
}

public Action:Command_MySlap(client, args)
{
}</pawn>

Now we've successfully implemented a command -- though it doesn't do anything yet. In fact, it will say "Unknown command" if you use it! The reason is because of the <tt>Action</tt> tag. Any command that you type in the console, even if it's registered by SourceMod, will be sent to the engine to be processed. Because we have not had SourceMod block this functionality yet, the engine replies with "Unknown command" because it is not a valid engine command.

<pawn>public Action:Command_MySlap(client, args)
{
return Plugin_Handled;
}</pawn>

Now the command will report no error, but it still won't do anything. This is because returning "Plugin_Handled" in a command callback will prevent the engine from processing the command. The engine will never even see that the command was run. This is what you will want to do if you are registering a completely new command through SourceMod.

==Implementation==
Let's decide what the command will look like. Let's have it act like the default <tt>sm_slap</tt> command:
<pre>sm_myslap <name|#userid> [damage]</pre>

To implement this, we'll need a few steps:
*Get the input from the console. For this we use [http://docs.sourcemod.net/api/index.php?fastload=show&id=473& GetCmdArg()].
*Find a matching player. For this we use [http://docs.sourcemod.net/api/index.php?fastload=show&id=144& FindTarget()].
*Slap them. For this we use [http://docs.sourcemod.net/api/index.php?fastload=show&id=42& SlapPlayer()], which requires including <tt>sdktools</tt>, an extension bundled with SourceMod.
*Respond to the admin. For this we use [http://docs.sourcemod.net/api/index.php?fastload=show&id=462& ReplyToCommand()].

Full example:

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

public Plugin:myinfo =
{
name = "My First Plugin",
author = "Me",
description = "My first plugin ever",
version = "1.0.0.0",
url = "http://www.sourcemod.net/"
}

public OnPluginStart()
{
RegAdminCmd("sm_myslap", Command_MySlap, ADMFLAG_SLAY);
}

public Action:Command_MySlap(client, args)
{
new String:arg1[32], String:arg2[32];
new damage;

/* Get the first argument */
GetCmdArg(1, arg1, sizeof(arg1));

/* If there are 2 or more arguments, and the second argument fetch
* is successful, convert it to an integer.
*/
if (args >= 2 && GetCmdArg(2, arg2, sizeof(arg2)))
{
damage = StringToInt(arg2);
}

/* Try and find a matching player */
new target = FindTarget(client, arg1);
if (target == -1)
{
/* FindTarget() automatically replies with the
* failure reason.
*/
return Plugin_Handled;
}

SlapPlayer(target, damage);

new String:name[MAX_NAME_LENGTH];

GetClientName(target, name, sizeof(name));
ReplyToCommand(client, "[SM] You slapped %s for %d damage!", name, damage);

return Plugin_Handled;
}</pawn>

For more information on what %s and %d are, see [[Format Class Functions (SourceMod Scripting)|Format Class Functions]]. Note that you never need to unregister or remove your admin command. When a plugin is unloaded, SourceMod cleans it up for you.

=ConVars=
ConVars, also known as cvars, are global console variables in the Source engine. They can have integer, float, or string values. ConVar accessing is done through [[Handles (SourceMod Scripting)|Handles]]. Since ConVars are global, you do not need to close ConVar Handles (in fact, you cannot).

The handy feature of ConVars is that they are easy for users to configure. They can be placed in any .cfg file, such as <tt>server.cfg</tt> or <tt>sourcemod.cfg</tt>. To make this easier, SourceMod has an [http://docs.sourcemod.net/api/index.php?fastload=show&id=607& AutoExecConfig()] function. This function will automatically build a default .cfg file containing all of your cvars, annotated with comments, for users. It is highly recommend that you call this if you have customizable ConVars.

Let's extend your example from earlier with a new ConVar. Our ConVar will be <tt>sm_myslap_damage</tt> and will specify the default damage someone is slapped for if no damage is specified.

<pawn>new Handle:sm_myslap_damage = INVALID_HANDLE

public OnPluginStart()
{
RegAdminCmd("sm_myslap", Command_MySlap, ADMFLAG_SLAY);

sm_myslap_damage = CreateConVar("sm_myslap_damage", "5", "Default slap damage");
AutoExecConfig(true, "plugin_myslap");
}

public Action:Command_MySlap(client, args)
{
new String:arg1[32], String:arg2[32];
new damage = GetConVarInt(sm_myslap_damage);

/* The rest remains unchanged! */
</pawn>

=Showing Activity, Logging=
Almost all admin commands should log their activity, and some admin commands should show their activity to in-game clients. This can be done via the [http://docs.sourcemod.net/api/index.php?fastload=show&id=599& LogAction()] and [http://docs.sourcemod.net/api/index.php?fastload=show&id=466& ShowActivity2()] functions. The exact functionality of ShowActivity2() is determined by the <tt>sm_show_activity</tt> cvar.

For example, let's rewrite the last few lines of our slap command:
<pawn>
SlapPlayer(target, damage);

new String:name[MAX_NAME_LENGTH];

GetClientName(target, name, sizeof(name));

ShowActivity2(client, "[SM] ", "Slapped %s for %d damage!", name, damage);
LogAction(client, target, "\"%L\" slapped \"%L\" (damage %d)", client, target, damage);

return Plugin_Handled;
}
</pawn>

=Multiple Targets=
To fully complete our slap demonstration, let's make it support multiple targets. SourceMod's [[Admin_Commands_%28SourceMod%29#How_to_Target|targeting system]] is quite advanced, so using it may seem complicated at first.

The function we use is [http://docs.sourcemod.net/api/index.php?fastload=show&id=703& ProcessTargetString()]. It takes in input from the console, and returns a list of matching clients. It also returns a noun that will identify either a single client or describe a list of clients. The idea is that each client is then processed, but the activity shown to all players is only processed once. This reduces screen spam.

This method of target processing is used for almost every admin command in SourceMod, and in fact FindTarget() is just a simplified version.

Full, final example:
<pawn>
#include <sourcemod>
#include <sdktools>

new Handle:sm_myslap_damage = INVALID_HANDLE

public Plugin:myinfo =
{
name = "My First Plugin",
author = "Me",
description = "My first plugin ever",
version = "1.0.0.0",
url = "http://www.sourcemod.net/"
}

public OnPluginStart()
{
LoadTranslations("common.phrases");
RegAdminCmd("sm_myslap", Command_MySlap, ADMFLAG_SLAY);

sm_myslap_damage = CreateConVar("sm_myslap_damage", "5", "Default slap damage");
AutoExecConfig(true, "plugin_myslap");
}

public Action:Command_MySlap(client, args)
{
new String:arg1[32], String:arg2[32];
new damage = GetConVarInt(sm_myslap_damage);

/* Get the first argument */
GetCmdArg(1, arg1, sizeof(arg1));

/* If there are 2 or more arguments, and the second argument fetch
* is successful, convert it to an integer.
*/
if (args >= 2 && GetCmdArg(2, arg2, sizeof(arg2)))
{
damage = StringToInt(arg2);
}

/**
* target_name - stores the noun identifying the target(s)
* target_list - array to store clients
* target_count - variable to store number of clients
* tn_is_ml - stores whether the noun must be translated
*/
new String:target_name[MAX_TARGET_LENGTH];
new target_list[MAXPLAYERS], target_count;
new bool:tn_is_ml;

if ((target_count = ProcessTargetString(
arg1,
client,
target_list,
MAXPLAYERS,
COMMAND_FILTER_ALIVE, /* Only allow alive players */
target_name,
sizeof(target_name),
tn_is_ml)) <= 0)
{
/* This function replies to the admin with a failure message */
ReplyToTargetError(client, target_count);
return Plugin_Handled;
}

for (new i = 0; i < target_count; i++)
{
SlapPlayer(target_list[i], damage);
LogAction(client, target_list[i], "\"%L\" slapped \"%L\" (damage %d)", client, target_list[i], damage);
}

if (tn_is_ml)
{
ShowActivity2(client, "[SM] ", "Slapped %t for %d damage!", target_name, damage);
}
else
{
ShowActivity2(client, "[SM] ", "Slapped %s for %d damage!", target_name, damage);
}

return Plugin_Handled;
}</pawn>

=Client and Entity Indexes=
One major point of confusion with Half-Life 2 is the difference between the following things:
*Client index
*Entity index
*Userid

The first answer is that clients are entities. Thus, a client index and an entity index are the same thing. When a SourceMod function asks for an entity index, a client index can be specified. When a SourceMod function asks for a client index, usually it means only a client index can be specified.

A fast way to check if an entity index is a client is checking whether it's between 1 and [http://docs.sourcemod.net/api/index.php?fastload=show&id=397& GetMaxClients()] (inclusive). If a server has N client slots maximum, then entities 1 through N are always reserved for clients. Note that 0 is a valid entity index; it is the world entity (worldspawn).

A userid, on the other hand, is completely different. The server maintains a global "connection count" number, and it starts at 1. Each time a client connects, the connection count is incremented, and the client receives that new number as their userid.

For example, the first client to connect has a userid of 2. If he exits and rejoins, his userid will be 3 (unless another client joins in-between). Although SourceMod fires the OnClientConnected and OnClientDisconnected callbacks every map change, the server tracks players across map changes and does not change their userids or client indexes. To see if a client really connected or disconnected, hook the [[Generic Source Server Events#player_connect|player_connect]] and [[Generic Source Server Events#player_disconnect|player_disconnect]] events instead.

SourceMod provides two functions for userids: [http://docs.sourcemod.net/api/index.php?fastload=show&id=442& GetClientOfUserId()] and [http://docs.sourcemod.net/api/index.php?fastload=show&id=402& GetClientUserId()].

=Events=
Events are informational notification messages passed between objects in the server. Many are also passed from the server to the client. They are defined in .res files under the <tt>hl2/resource</tt> folder and <tt>resource</tt> folders of specific mods. For a basic listing, see [[Game Events (Source)|Source Game Events]].

It is important to note a few concepts about events:
*They are almost always informational. That is, blocking <tt>player_death</tt> will not stop a player from dying. It may block a HUD or console message or something else minor.
*They almost always use userids instead of client indexes.
*Just because it is in a resource file does not mean it is ever called, or works the way you expect it to. Mods are notorious at not properly documenting their event functionality.

An example of finding when a player dies:
<pawn>
public OnPluginStart()
{
HookEvent("player_death", Event_PlayerDeath);
}

public Event_PlayerDeath(Handle:event, const String:name[], bool:dontBroadcast)
{
new victim_id = GetEventInt(event, "userid");
new attacker_id = GetEventInt(event, "attacker");

new victim = GetClientOfUserId(victim_id);
new attacker = GetClientOfUserId(attacker_id);

/* CODE */
}</pawn>

=Callback Orders and Pairing=
SourceMod has a number of builtin callbacks about the state of the server and plugin. Some of these are paired in special ways which is confusing to users.

==Pairing==
'''Pairing''' is SourceMod terminology. Examples of it are:
*OnMapEnd() cannot be called without an OnMapStart(), and if OnMapStart() is called, it cannot be called again without an OnMapEnd().
*OnClientConnected(N) for a given client N will only be called once, until an OnClientDisconnected(N) for the same client N is called (which is guaranteed to happen).

There is a formal definition of SourceMod's pairing. For two functions X and Y, both with input A, the following conditions hold:
*If X is invoked with input A, it cannot be invoked again with the same input unless Y is called with input A.
*If X is invoked with input A, it is guaranteed that Y will, at some point, be called with input A.
*Y cannot be invoked with any input A unless X was called first with input A.
*The relationship is described as, "X is paired with Y," and "Y is paired to X."

==General Callbacks==
These callbacks are listed in the order they are called, in the lifetime of a plugin and the server.

*[http://docs.sourcemod.net/api/index.php?fastload=show&id=940& AskPluginLoad2()] - Called once, immediately after the plugin is loaded from the disk. This function can be used to stop a plugin from loading and return a custom error message; return APLRes_Failure and use strcopy on to replace the error string. All CreateNative and RegPluginLibrary calls should be done here.
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=575& OnPluginStart()] - Called once, after the plugin has been fully initialized and can proceed to load. Any run-time errors in this function will cause the plugin to fail to load. '''This is paired with OnPluginEnd()'''.
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=583& OnAllPluginsLoaded()] - Called once, after all non-late loaded plugins have called OnPluginStart.
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=580& OnMapStart()] - Called every time the map loads. If the plugin is loaded late, and the map has already started, this function is called anyway after load, in order to preserve pairing. '''This function is paired with OnMapEnd().'''
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=582& OnConfigsExecuted()] - Called once per map-change after <tt>servercfgfile</tt> (usually <tt>server.cfg</tt>), <tt>sourcemod.cfg</tt>, and all plugin config files have finished executing. If a plugin is loaded after this has happened, the callback is called anyway, in order to preserve pairing. '''This function is paired with OnMapEnd().'''
*At this point, most game callbacks can occur, such as events and callbacks involving clients (or other things, like OnGameFrame).
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=581& OnMapEnd()] - Called when the map is about to end. At this point, all clients are disconnected, but <tt>TIMER_NO_MAPCHANGE</tt> timers are not yet destroyed. '''This function is paired to OnMapStart().'''
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=577& OnPluginEnd()] - Called once, immediately before the plugin is unloaded. '''This function is paired to OnPluginStart().'''

==Client Callbacks==
These callbacks are listed in no specific order, however, their documentation holds for both fake and real clients.

*[http://docs.sourcemod.net/api/index.php?fastload=show&id=388& OnClientConnect()] - Called when a player initiates a connection. You can block a player from connecting by returning Plugin_Stop and setting rejectmsg to an error message.
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=916& OnClientConnected()] - Called after a player connects. Signifies that the player is in-game and IsClientConnected() will return true. '''This is paired with OnClientDisconnect() for successful connections only.'''
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=394& OnClientAuthorized()] - Called when a player gets a Steam ID. It is important to note that this may never be called. It may occur any time in between OnClientConnected and OnClientPreAdminCheck/OnClientDisconnect. Do not rely on it unless you are writing something that needs Steam IDs, and even then you should use OnClientPostAdminCheck().
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=389& OnClientPutInServer()] - Signifies that the player is in-game and IsClientInGame() will return true.
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=396& OnClientPostAdminCheck()] - Called after the player is '''both authorized and in-game'''. This is the best callback for checking administrative access after connect.
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=390& OnClientDisconnect()] - Called when a player's disconnection starts. '''This is paired to OnClientConnected().'''
*[http://docs.sourcemod.net/api/index.php?fastload=show&id=391& OnClientDisconnect_Post()] - Called when a player's disconnection ends. '''This is paired to OnClientConnected().'''

=Frequently Asked Questions=
==Are plugins reloaded every mapchange?==
Plugins, by default, are not reloaded on mapchange unless their timestamp changes. This is a feature so plugin authors have more flexibility with the state of their plugins.

==Do I need to call CloseHandle in OnPluginEnd?==
No. SourceMod automatically closes your Handles when your plugin is unloaded, in order to prevent memory errors.

==Do I need to #include every individual .inc?==
No. <tt>#include <sourcemod></tt> will give you 95% of the .incs. Similarly, <tt>#include <sdktools></tt> includes everything starting with <sdktools>.

==Why don't some events fire?==
There is no guarantee that events will fire. The event listing is not a specification, it is a list of the events that a game is capable of firing. Whether the game actually fires them is up to Valve or the developer.

==Do I need to CloseHandle timers?==
No. In fact, doing so may cause errors. Timers naturally die on their own unless they are infinite timers, in which case you can use KillTimer() or die gracefully by returning <tt>Plugin_Stop</tt> in the callback.

==Are clients disconnected on mapchange?==
All clients are fully disconnected before the map changes. They are all reconnected after the next map starts.

If you only want to detect when a client initially connects or leaves your server, hook the [[Generic Source Server Events#player_connect|player_connect]] or [[Generic Source Server Events#player_disconnect|player_disconnect]] events respectively.

=Further Reading=
For further reading, see the "Scripting" section at the [http://docs.sourcemod.net/ SourceMod Documentation].

[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

Building SourceMod

2014-05-27T04:49:32Z

Castile: /* Windows */

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++ 2010 or higher. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild to <tt>C:\mozilla-build</tt>.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, 4.4 or higher is required. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone https://github.com/alliedmodders/hl2sdk hl2sdk-repo-proxy
# For each SDK you want to build with:
# git clone hl2sdk-repo-proxy hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-repo-proxy hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev
wget http://cdn.mysql.com/archives/mysql-5.0/mysql-noinstall-5.0.24a-win32.zip mysql-noinstall-5.0.24a-win32

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder within your sourcemod folder, and then run <tt>configure.py</tt>. For example:
<pre>
cd sourcemod
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#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.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Building SourceMod

2014-05-27T04:48:33Z

Castile: /* Configuring */

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++ 2010 or higher. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, 4.4 or higher is required. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone https://github.com/alliedmodders/hl2sdk hl2sdk-repo-proxy
# For each SDK you want to build with:
# git clone hl2sdk-repo-proxy hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-repo-proxy hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev
wget http://cdn.mysql.com/archives/mysql-5.0/mysql-noinstall-5.0.24a-win32.zip mysql-noinstall-5.0.24a-win32

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder within your sourcemod folder, and then run <tt>configure.py</tt>. For example:
<pre>
cd sourcemod
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#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.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Building SourceMod

2014-05-27T04:44:54Z

Castile:

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++ 2010 or higher. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, 4.4 or higher is required. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone https://github.com/alliedmodders/hl2sdk hl2sdk-repo-proxy
# For each SDK you want to build with:
# git clone hl2sdk-repo-proxy hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-repo-proxy hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev
wget http://cdn.mysql.com/archives/mysql-5.0/mysql-noinstall-5.0.24a-win32.zip mysql-noinstall-5.0.24a-win32

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder, and then run <tt>configure.py</tt>. For example:
<pre>
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#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.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]