AlliedModders Wiki - User contributions [en]

Cross Compiling Plugins (Metamod:Source)

2008-03-14T05:24:59Z

Sslice: /* Installing CrossTool */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

This tutorial assumes the following.
<OL>
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfully accomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'. 
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'. 
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option. 
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using. 
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time. 
Finaly, you are presented with a 'Select Packages' screen. 
I *think* it should work fine without all of the dev packages. 

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list. 
Items marked in bold are extremely important. 

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
Download Mirrors for 'crosstool_gcc.tar.gz'
*[http://files.filefront.com/crosstool+gcc+341targz/;9813824;/fileinfo.html FileFront]
*[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]

This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad. 
Inside the Makefile I have shown examples on how your paths are translated into unix/cygwin hybrid paths. 
So, before trying any compling just yet, you need to insert the paths for the following. 

HL2SDK: The path to where your HL2SDK files are located. 
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package] 
SRCDS: The path to the linux SRCDS binaries. 
PLUGIN: The plugin filename. 

For the convenience of those who don't have access to a Linux srcds installation, you can grab the files required at one of the mirrors below. 
Extract them to a new folder which will be your SRCDS path in the Makefile. 
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An example path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://forums.alliedmods.net/forumdisplay.php?f=75 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Cross Compiler compiled by: L. Duke
*Makefile originally written by: David "BAILOPAN" Anderson
*Converted to Wiki by: James "sslice" Gray

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

[[Category:Metamod:Source Development]]

User talk:Sslice

2007-06-11T05:12:41Z

Sslice:

hai i talkz to meselfs --[[User:Sslice|Sslice]] 00:12, 11 June 2007 (CDT)

User talk:Sslice

2007-06-11T05:06:47Z

Sslice:

hi lolz

HAI
CAN HAS STDIO?
KTHXBYE

-- NOES PLZ DIE

User:Sslice

2007-06-11T05:03:42Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than [[User:L. Duke|L. Duke]]
*He develops this anti-cheat thing called [http://detox.steambans.com/ Detox Anti-Cheat]
*He is also fond of pleasantries such as lime and cheese.

User:Sslice

2007-06-11T05:03:28Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than [[User:L. Duke|L. Duke]]
*He develops this anti-cheat thing called [http://detox.steambans.com/ Detox Anti-Cheat]
*He also is fond of pleasantries such as lime and cheese.

User:FlyingMongoose

2007-06-11T05:02:19Z

Sslice:

A mysterious creature, the FlyingMongoose is seemingly like a wing-ed mongoose. It is frightened easily and often hides when trouble is about, and often dies from heart failure.

----
=== Current projects ===

[http://forums.alliedmods.net/showthread.php?t=55452 Advanced Team Attack Control a.k.a ATAC] - This plugin's title is self explanatory, it was preceded by [http://forums.alliedmods.net/showthread.php?t=53902 SpawnProtect] (no longer supported)

[http://forums.alliedmods.net/showthread.php?t=53900 KnifeMug] - Originally created as an alternative to mattie's MugMod, this provides features from the knife mugging scripts in beetlesmod, mattie's mugmod, as well as it's own special knife mugging method.

[http://www.sourcebans.net/ SourceBans] - The concept is a web based fully featured ban and admin management system for Source servers operating the SourceMod plugin, it includes a web-mange-able bans database as well as a web interface to the SourceMod admin SQL.

[[User:FlyingMongoose|FlyingMongoose]] is part of the [http://www.gameconnect.net GameConnect] Development Team

User:Sslice

2007-06-11T05:01:17Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than [[User:L. Duke|L. Duke]]
*He also develops this anti-cheat thing called [http://detox.steambans.com/ Detox Anti-Cheat]

User:Sslice

2007-06-11T05:00:44Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than [[User:L. Duke|L. Duke]]
*He also develops this anti-cheat thing called [[Detox Anti-Cheat]http://detox.steambans.com/]

User:Sslice

2007-06-11T05:00:29Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than [[User:L. Duke|L. Duke]]
*He also develops this anti-cheat thing called [Detox Anti-Cheat|http://detox.steambans.com/]

User:Sslice

2007-06-11T04:59:51Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than [[User:L. Duke|L. Duke]] but sux compared to [[User:FlyingMongoose|FlyingMongoose]]
*He also develops this anti-cheat thing called [Detox Anti-Cheat|http://detox.steambans.com/]

User:Sslice

2007-06-11T04:59:43Z

Sslice: /* sslice */

User talk:L. Duke

2007-06-11T04:58:03Z

Sslice:

gyarrrr! -- [[User:BAILOPAN|BAILOPAN]] 21:30, 21 January 2006 (EST)
:aaaarrr! -- [[User:L. Duke|L. Duke]] 23:44, 21 January 2006 (EST)
::i have spotted teh gaben! -- [[User:sslice|sslice]] 0:57, 10 August 2041 (EST)

User:Sslice

2007-06-11T04:54:11Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than [[User:L. Duke|L. Duke]]

User talk:Sslice

2007-06-11T04:53:50Z

Sslice:

hi lolz

User talk:Sslice

2007-06-11T04:53:40Z

Sslice: Removing all content from page

User:Sslice

2007-06-11T04:53:05Z

Sslice: /* sslice */

== sslice ==
*sslice is a mysterious entity who is cooler than L. Duke

User talk:Sslice

2007-06-11T04:52:29Z

Sslice:

hi lolz

User talk:Sslice

2007-06-11T04:52:13Z

Sslice: New page: noooooees

noooooees

User:L. Duke

2007-06-11T04:51:28Z

Sslice:

== About L. Duke ==
L. Duke is a gaben eater.

== Current Projects ==
*[http://vipmod.punkassfraggers.com VIP Mod]
*[http://www.sourcemod.net/forums/viewtopic.php?t=2059 FakeClients]
*[http://www.sourcemod.net/forums/viewtopic.php?p=34892 CS:S Weapon Restrictions 2]

== Home Page ==
*[http://www.lduke.com LDuke.com]

My First Script

2007-06-09T02:38:33Z

Sslice: /* Initialize */

== Intro ==
This is a Hello World type plugin tutorial. Every beginner should learn these first baby steps. The full code is at the bottom. Now let's begin.

== Includes ==
We first need to have our include file added. This file is located in the addons/sourcemod/scripting/include/ . Includes are your best friend. They give you access to all functions Sourcemod and its Module Extensions allow! Note: This always goes at the top of the entire source code.
<pawn>
#include <sourcemod>
</pawn>

== Plugin Info ==
Next we give our information, so people who download know who made it and what version they have.
<pawn>
public Plugin:myinfo = {
name = "Hello Gaben",
author = "AlliedModders, LLC",
description = "Hi",
version = "1.0",
url = "http://www.sourcemod.net/"
};
</pawn>

== Initialize ==
This function will be used in nearly every plugin available. It is your friend. This runs one time when your plugin is loaded. You will use it to register many of SourceMod's capabilities including Custom Console Commands, CVARs, Natives, and Forwards.

Here I just ran a simple function I created to print a '''LogMessage''' to our log files in '''sourcemod/logs/''' folder.
<pawn>
public OnPluginStart()
{
SayHello();
}
</pawn>

== My Function ==
Here is the function ran at OnPluginStart(). Very simple and it uses the '''LogMessage''' function located in '''sourcemod.inc'''.
<pawn>
//Print Message to LogFile
SayHello()
{
LogMessage("Hello Gaben | Time: %i", GetTime());
}
</pawn>

== Conclusion ==
Sourcemod scripting has been extended in syntax compared to AMXX. This allows for better organization. However there is the learning curve of learning the syntax for each corresponding function or variable. Study the includes in the scripting/includes folder and you should be fine. All functions are in there so make them your friend!

Here is the code used in its entirety.
<pawn>
/* Hello Gaben */

#include <sourcemod>

public Plugin:myinfo = {
name = "Hello Gaben",
author = "AlliedModders, LLC",
description = "Hi",
version = "1.0",
url = "http://www.sourcemod.net/"
};

public OnPluginStart()
{
SayHello();
}

SayHello()
{
LogMessage("Hello Gaben | Time: %i", GetTime());
}
</pawn>

[[Category:SourceMod Scripting]]

Game Events (Source)

2007-06-08T05:20:57Z

Sslice: /* player_activate */

= Half-Life 2 Events =

=== team_info ===
{{qnotice|Info about team}} 
{{begin-hl2msg|team_info|string}}
{{hl2msg|byte|teamid}}
{{hl2msg|string|teamname}}
{{end-hl2msg}}

=== team_score ===
{{qnotice|Team score changed}} 
{{begin-hl2msg|team_info|string}}
{{hl2msg|byte|teamid}}
{{hl2msg|short|score}}
{{end-hl2msg}}

=== player_team ===
{{qnotice|Player change his team}} 
{{begin-hl2msg|player_team|string}}
{{hl2msg|short|userid}}
{{hl2msg|byte|team}}
{{hl2msg|byte|oldteam}}
{{hl2msg|bool|disconnect}}
{{end-hl2msg}}

=== player_class ===
{{qnotice|A player changed his class}} 
{{begin-hl2msg|player_class|string}}
{{hl2msg|short|userid}}
{{hl2msg|string|class}}
{{end-hl2msg}}

=== player_death ===
{{qnotice|A game event, name may be 32 charaters long}} 
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|attacker}}
{{end-hl2msg}}

=== player_hurt ===
{{qnotice|A player was hurt}} 
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|attacker}}
{{hl2msg|byte|health}}
{{end-hl2msg}}

=== player_chat ===
{{qnotice|A public player chat}} 
{{begin-hl2msg|player_chat|string}}
{{hl2msg|bool|teamonly}}
{{hl2msg|short|userid}}
{{hl2msg|string|text}}
{{end-hl2msg}}

=== player_score ===
{{qnotice|Players scores changed}} 
{{begin-hl2msg|player_score|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|kills}}
{{hl2msg|short|deaths}}
{{hl2msg|short|score}}
{{end-hl2msg}}

=== player_spawn ===
{{qnotice|player spawned in game}} 
{{begin-hl2msg|player_score|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== player_shoot ===
{{qnotice|Player shoot his weapon}} 
{{begin-hl2msg|player_shoot|string}}
{{hl2msg|short|userid}}
{{hl2msg|byte|weapon}}
{{hl2msg|byte|mode}}
{{end-hl2msg}}

=== player_use ===
{{qnotice|When a player uses an option}} 
{{begin-hl2msg|player_use|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|entity}}
{{end-hl2msg}}

=== player_changename ===
{{qnotice|Player changed name}} 
{{begin-hl2msg|player_changename|string}}
{{hl2msg|string|userid}}
{{hl2msg|string|oldname}}
{{hl2msg|string|newname}}
{{end-hl2msg}}

=== game_newmap ===
{{qnotice|Send when new map is completely loaded}} 
{{begin-hl2msg|game_newmap|string}}
{{hl2msg|string|mapname}}
{{end-hl2msg}}

=== game_start ===
{{qnotice|A new game starts}} 
{{begin-hl2msg|game_start|string}}
{{hl2msg|long|roundslimit}}
{{hl2msg|long|timelimit}}
{{hl2msg|long|fraglimit}}
{{hl2msg|string|objective}}
{{end-hl2msg}}

=== game_end ===
{{qnotice|A game ended}} 
{{begin-hl2msg|game_end|string}}
{{hl2msg|byte|winner}}
{{end-hl2msg}}

=== round_start ===
{{qnotice|The round started}} 
{{begin-hl2msg|player_changename|string}}
{{hl2msg|long|timelimit}}
{{hl2msg|long|fraglimit}}
{{hl2msg|string|objective}}
{{end-hl2msg}}

=== round_end ===
{{qnotice|The round ended}} 
{{begin-hl2msg|round_end|string}}
{{hl2msg|byte|winner}}
{{hl2msg|byte|reason}}
{{hl2msg|string|message}}
{{end-hl2msg}}

=== game_message ===
{{qnotice|A game message}} 
{{begin-hl2msg|game_message|string}}
{{hl2msg|byte|target}}
{{hl2msg|string|text}}
{{end-hl2msg}}

=== break_breakable ===
{{qnotice|A breakable is broken.}} 
{{begin-hl2msg|break_breakable|string}}
{{hl2msg|long|entindex}}
{{hl2msg|short|userid}}
{{hl2msg|byte|material}}
{{end-hl2msg}}

=== break_prop ===
{{qnotice|A breakable prop is broken.}} 
{{begin-hl2msg|break_prop|string}}
{{hl2msg|long|entindex}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

= Half-Life 2 Server Events =
=== server_spawn ===
{{qnotice|Send once a server starts}} 
{{begin-hl2msg|server_start|string}}
{{hl2msg|string|hostname}}
{{hl2msg|string|address}}
{{hl2msg|string|port}}
{{hl2msg|string|game}}
{{hl2msg|string|mapname}}
{{hl2msg|long|maxplayers}}
{{hl2msg|string|os}}
{{hl2msg|bool|dedicated}}
{{hl2msg|bool|password}}
{{end-hl2msg}}

=== server_shutdown ===
{{qnotice|Server shut down}}
{{begin-hl2msg|server_shutdown|string}}
{{hl2msg|string|reason}}
{{end-hl2msg}}

=== server_cvar ===
{{qnotice|A server console var has changed}}
{{begin-hl2msg|server_cvar|string}}
{{hl2msg|string|cvarname}}
{{hl2msg|string|cvarvalue}}
{{end-hl2msg}}

=== server_msg ===
{{qnotice|A generic server message}}
{{begin-hl2msg|server_message|string}}
{{hl2msg|string|text}}
{{end-hl2msg}}

=== server_addban ===
{{qnotice|When the server has a ban added}}
{{begin-hl2msg|server_addban|string}}
{{hl2msg|string|name}}
{{hl2msg|string|userid}}
{{hl2msg|string|networkid}}
{{hl2msg|string|ip}}
{{hl2msg|string|duration}}
{{hl2msg|string|by}}
{{hl2msg|bool|kicked}}
{{end-hl2msg}}

=== server_removeban ===
{{qnotice|When the server has a ban removed}}
{{begin-hl2msg|server_removeban|string}}
{{hl2msg|string|networkid}}
{{hl2msg|string|ip}}
{{hl2msg|stsring|by}}
{{end-hl2msg}}

=== player_connect ===
{{qnotice|A new player connected}}
{{begin-hl2msg|player_connect|string}}
{{hl2msg|string|name}}
{{hl2msg|byte|index}}
{{hl2msg|short|userid}}
{{hl2msg|string|networkid}}
{{hl2msg|string|address}}
{{end-hl2msg}}

=== player_info ===
{{qnotice|A player changed his name}}
{{begin-hl2msg|player_info|string}}
{{hl2msg|string|name}}
{{hl2msg|byte|index}}
{{hl2msg|short|userid}}
{{hl2msg|string|networkid}}
{{hl2msg|bool|bot}}
{{end-hl2msg}}

=== player_disconnect ===
{{qnotice|A client was disconnected}}
{{begin-hl2msg|player_disconnect|string}}
{{hl2msg|short|userid}}
{{hl2msg|string|reason}}
{{hl2msg|string|name}}
{{hl2msg|string|networkid}}
{{end-hl2msg}}

=== player_activate ===
{{qnotice|''A client has entered the game (connected and loaded)''}}
{{begin-hl2msg|player_activate|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== player_say ===
{{qnotice|When a client sends a message in chat}}
{{begin-hl2msg|player_say|string}}
{{hl2msg|short|userid}}
{{hl2msg|string|text}}
{{end-hl2msg}}

= Counter-Strike: Source Events =
=== player_death ===
{{qnotice|When a client dies}}
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|attacker}}
{{hl2msg|string|weapon}}
{{hl2msg|bool|headshot}}
{{end-hl2msg}}

=== player_hurt ===
{{qnotice|When a client is damaged}}
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|attacker}}
{{hl2msg|byte|health}}
{{hl2msg|byte|armor}}
{{hl2msg|string|weapon}}
{{hl2msg|byte|dmg_health}}
{{hl2msg|byte|dmg_armor}}
{{hl2msg|byte|hitgroup}}
{{end-hl2msg}}

=== bomb_beginplant ===
{{qnotice|When the bomb is starting to get planted}}
{{begin-hl2msg|bomb_beginplant|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{end-hl2msg}}

=== bomb_abortplant ===
{{qnotice|When the bomb planter stops planting the bomb}}
{{begin-hl2msg|bomb_abortplant|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{end-hl2msg}}

=== bomb_plant ===
{{qnotice|When the bomb has been planted}}
{{begin-hl2msg|bomb_planted|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{hl2msg|short|posx}}
{{hl2msg|short|posy}}
{{end-hl2msg}}

Open Source Plugins for Metamod:Source

2006-10-20T01:59:56Z

Sslice: /* IRC Relay */

= Open Source Plugins for SourceMM =
This page lists known plugins with available source code. Please check the licenses for each one as they may not truly be "open source."
 
== Basic Templates ==
=== stub_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: minmum implentation of a valid SourceMM plugin 
Features: starting template 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: implements the features of the standard Valve server plugin from the SDK 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample2_mm ===
Author: [[User:BAILOPAN|BAILOPAN]], edited by [[User:L._Duke|L. Duke]] 
Description: fixes (by inheriting from IGameEventListener2 instead of hooking FireGameEvent) the problem in sample_mm plugin where some events are not received 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: [http://forums.alliedmods.net/showthread.php?p=342749 forums.alliedmods.net/showthread.php?p=342749] (you must be logged in to view the download link)
 

== Functional Plugins ==
=== Anti-Griefer ===
Author: [[User:devicenull|devicenull]] 
Description: This plugin is for the mod SourceForts. In keeps track of what player unfreezes or freezes a block, and allows any other player to retrieve this information by aiming at a block. 
Features: Basic VFuncs, listening for events, partial traceline (The method used for traceline might not be effective for any other mod) 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3652 http://www.sourcemod.net/forums/viewtopic.php?t=3652]
 
=== Basic Admin Tool (BAT) ===
Author: [[User:EKS|EKS]] 
Description: Provides basic admin functions 
Features: Kick, ban, menus, reserved slots, timeleft/nextmap say commands, and more 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=2923 www.sourcemod.net/forums/viewtopic.php?t=2923]
 
=== Counter Strike Bot Control ===
Author: [[User:EKS|EKS]] 
Description: This plugin allows you to control the counter strike source bots more easly, you can have them them automaticly keep the server populated. You can have bots automaticly killed when all the human players are dead, and any changes can be made in the bot menu. 
Features: Control the built in bots in CSS via a menu 
Download: [http://forums.alliedmods.net/showthread.php?t=40097 http://forums.alliedmods.net/showthread.php?t=40097]
 

=== CS:S Weapon Restrictions 2 ===
Author: [[User:L._Duke|L. Duke]] 
Description: Prevents players from picking up restricted weapons (if bought, they fall to the ground). Also includes an option to remove restricted weapons from the game. 
Features: Hook CCSPlayer::Weapon_CanUse(CBaseCombatWeapon *pWeapon) and returns false for restricted weapons. Also shows how to use virtual functions on weapons such as Delete()and GetName() and on players for Weapon_GetSlot(int) and Drop(CBaseCombatWeapon*). 
Download: [http://forums.alliedmods.net/showthread.php?p=342750 forums.alliedmods.net/showthread.php?p=342750]
 
=== ForgiveTK ===
Author: [[User:EKS|EKS]] 
Description: This is a basic plugin to handle teamkilll and teamattack on your source server, it supports any Source mod. It will automaticly kick someone with to many offenses 
Features: Forgive via menu or chat. Support both Valves ESC menus and radio menus. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3081 http://www.sourcemod.net/forums/viewtopic.php?t=3081]
 
=== Global Banlist===
Author: [[User:devicenull|devicenull]] 
Description: This plugin allows srcds to reguarly connect to an external PHP page, and download updates about it's banlist. Srcds then stores these in a SQLite database. 
Features: Embedding sqlite, using pthreads, using libcurl. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3539 http://www.sourcemod.net/forums/viewtopic.php?t=3539]
 
=== HLStatsX ( Allows srcds to interact with hlstatsx ingame) ===
Author: [[User:EKS|EKS]] 
Description: This plugin is made to interact with hlstatsx ( www.hlstatsx.org ) to give proper ingame stats, and provide the extra logging required for hit detection 
Download: [http://forums.alliedmods.net/showthread.php?t=42502 http://forums.alliedmods.net/showthread.php?t=42502]
 
=== IRC Relay ===
Author: [[User:sslice|sslice]] 
Description: Reports game events to an IRC channel and allows you to administrate your server from IRC 
Features: ConCommand hooks and general networking using asynchronous sockets 
Download: [http://forums.alliedmods.net/showthread.php?t=39395 AlliedModders] or [http://www.tcmagazine.info/modules.php?modname=custompage&name=ircrelay&catid=4 Gameconnect]
 

=== Last Users Connected ===
Author: [[User:devicenull|devicenull]] 
Description: With this plugin, every player who comes onto your server has their steamid logged, along with any name they used on the server. You can then either view the names/steamid's of the last people to disconnect, or you can search for a name/steamid and see everyone who has used that name. 
Features: shows how to embed sqlite3, send basic messages/basic hooks. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3339 http://www.sourcemod.net/forums/viewtopic.php?t=3339]
 
=== Stripper:Source ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: You can add any type of entity - hostage, spawn point, physics prop, permanently to the map. You can also filter out entities for deletion, either by specific entries or regular expressions. Stripper:Source lets you define global rules and per-map rules. It also lets other plugins (both SourceMM plugins and Server Plugins) use its API. 
Features: shows how to edit the map entity lump in memory to change map entities 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3008 www.sourcemod.net/forums/viewtopic.php?t=3008]
 
[[Category:Documentation (SourceMM)]]

= Open Source Valve Server Plugins (VSP) =
A list of open source plugins for the Valve Server Plugin (VSP) interface can be found [http://developer.valvesoftware.com/wiki/List_of_Open_Source_Server_Plugins here].

Open Source Plugins for Metamod:Source

2006-10-20T01:59:15Z

Sslice: /* IRC Relay */

= Open Source Plugins for SourceMM =
This page lists known plugins with available source code. Please check the licenses for each one as they may not truly be "open source."
 
== Basic Templates ==
=== stub_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: minmum implentation of a valid SourceMM plugin 
Features: starting template 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: implements the features of the standard Valve server plugin from the SDK 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample2_mm ===
Author: [[User:BAILOPAN|BAILOPAN]], edited by [[User:L._Duke|L. Duke]] 
Description: fixes (by inheriting from IGameEventListener2 instead of hooking FireGameEvent) the problem in sample_mm plugin where some events are not received 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: [http://forums.alliedmods.net/showthread.php?p=342749 forums.alliedmods.net/showthread.php?p=342749] (you must be logged in to view the download link)
 

== Functional Plugins ==
=== Anti-Griefer ===
Author: [[User:devicenull|devicenull]] 
Description: This plugin is for the mod SourceForts. In keeps track of what player unfreezes or freezes a block, and allows any other player to retrieve this information by aiming at a block. 
Features: Basic VFuncs, listening for events, partial traceline (The method used for traceline might not be effective for any other mod) 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3652 http://www.sourcemod.net/forums/viewtopic.php?t=3652]
 
=== Basic Admin Tool (BAT) ===
Author: [[User:EKS|EKS]] 
Description: Provides basic admin functions 
Features: Kick, ban, menus, reserved slots, timeleft/nextmap say commands, and more 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=2923 www.sourcemod.net/forums/viewtopic.php?t=2923]
 
=== Counter Strike Bot Control ===
Author: [[User:EKS|EKS]] 
Description: This plugin allows you to control the counter strike source bots more easly, you can have them them automaticly keep the server populated. You can have bots automaticly killed when all the human players are dead, and any changes can be made in the bot menu. 
Features: Control the built in bots in CSS via a menu 
Download: [http://forums.alliedmods.net/showthread.php?t=40097 http://forums.alliedmods.net/showthread.php?t=40097]
 

=== CS:S Weapon Restrictions 2 ===
Author: [[User:L._Duke|L. Duke]] 
Description: Prevents players from picking up restricted weapons (if bought, they fall to the ground). Also includes an option to remove restricted weapons from the game. 
Features: Hook CCSPlayer::Weapon_CanUse(CBaseCombatWeapon *pWeapon) and returns false for restricted weapons. Also shows how to use virtual functions on weapons such as Delete()and GetName() and on players for Weapon_GetSlot(int) and Drop(CBaseCombatWeapon*). 
Download: [http://forums.alliedmods.net/showthread.php?p=342750 forums.alliedmods.net/showthread.php?p=342750]
 
=== ForgiveTK ===
Author: [[User:EKS|EKS]] 
Description: This is a basic plugin to handle teamkilll and teamattack on your source server, it supports any Source mod. It will automaticly kick someone with to many offenses 
Features: Forgive via menu or chat. Support both Valves ESC menus and radio menus. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3081 http://www.sourcemod.net/forums/viewtopic.php?t=3081]
 
=== Global Banlist===
Author: [[User:devicenull|devicenull]] 
Description: This plugin allows srcds to reguarly connect to an external PHP page, and download updates about it's banlist. Srcds then stores these in a SQLite database. 
Features: Embedding sqlite, using pthreads, using libcurl. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3539 http://www.sourcemod.net/forums/viewtopic.php?t=3539]
 
=== HLStatsX ( Allows srcds to interact with hlstatsx ingame) ===
Author: [[User:EKS|EKS]] 
Description: This plugin is made to interact with hlstatsx ( www.hlstatsx.org ) to give proper ingame stats, and provide the extra logging required for hit detection 
Download: [http://forums.alliedmods.net/showthread.php?t=42502 http://forums.alliedmods.net/showthread.php?t=42502]
 
=== IRC Relay ===
Author: [[User:sslice|sslice]] 
Description: Reports game events to an IRC channel and allows you to administrate your server from IRC 
Features: ConCommand hooks and asynchronous networking using sockets 
Download: [http://forums.alliedmods.net/showthread.php?t=39395 AlliedModders] or [http://www.tcmagazine.info/modules.php?modname=custompage&name=ircrelay&catid=4 Gameconnect]
 

=== Last Users Connected ===
Author: [[User:devicenull|devicenull]] 
Description: With this plugin, every player who comes onto your server has their steamid logged, along with any name they used on the server. You can then either view the names/steamid's of the last people to disconnect, or you can search for a name/steamid and see everyone who has used that name. 
Features: shows how to embed sqlite3, send basic messages/basic hooks. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3339 http://www.sourcemod.net/forums/viewtopic.php?t=3339]
 
=== Stripper:Source ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: You can add any type of entity - hostage, spawn point, physics prop, permanently to the map. You can also filter out entities for deletion, either by specific entries or regular expressions. Stripper:Source lets you define global rules and per-map rules. It also lets other plugins (both SourceMM plugins and Server Plugins) use its API. 
Features: shows how to edit the map entity lump in memory to change map entities 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3008 www.sourcemod.net/forums/viewtopic.php?t=3008]
 
[[Category:Documentation (SourceMM)]]

= Open Source Valve Server Plugins (VSP) =
A list of open source plugins for the Valve Server Plugin (VSP) interface can be found [http://developer.valvesoftware.com/wiki/List_of_Open_Source_Server_Plugins here].

Open Source Plugins for Metamod:Source

2006-10-20T01:58:36Z

Sslice: /* IRC Relay */

= Open Source Plugins for SourceMM =
This page lists known plugins with available source code. Please check the licenses for each one as they may not truly be "open source."
 
== Basic Templates ==
=== stub_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: minmum implentation of a valid SourceMM plugin 
Features: starting template 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: implements the features of the standard Valve server plugin from the SDK 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample2_mm ===
Author: [[User:BAILOPAN|BAILOPAN]], edited by [[User:L._Duke|L. Duke]] 
Description: fixes (by inheriting from IGameEventListener2 instead of hooking FireGameEvent) the problem in sample_mm plugin where some events are not received 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: [http://forums.alliedmods.net/showthread.php?p=342749 forums.alliedmods.net/showthread.php?p=342749] (you must be logged in to view the download link)
 

== Functional Plugins ==
=== Anti-Griefer ===
Author: [[User:devicenull|devicenull]] 
Description: This plugin is for the mod SourceForts. In keeps track of what player unfreezes or freezes a block, and allows any other player to retrieve this information by aiming at a block. 
Features: Basic VFuncs, listening for events, partial traceline (The method used for traceline might not be effective for any other mod) 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3652 http://www.sourcemod.net/forums/viewtopic.php?t=3652]
 
=== Basic Admin Tool (BAT) ===
Author: [[User:EKS|EKS]] 
Description: Provides basic admin functions 
Features: Kick, ban, menus, reserved slots, timeleft/nextmap say commands, and more 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=2923 www.sourcemod.net/forums/viewtopic.php?t=2923]
 
=== Counter Strike Bot Control ===
Author: [[User:EKS|EKS]] 
Description: This plugin allows you to control the counter strike source bots more easly, you can have them them automaticly keep the server populated. You can have bots automaticly killed when all the human players are dead, and any changes can be made in the bot menu. 
Features: Control the built in bots in CSS via a menu 
Download: [http://forums.alliedmods.net/showthread.php?t=40097 http://forums.alliedmods.net/showthread.php?t=40097]
 

=== CS:S Weapon Restrictions 2 ===
Author: [[User:L._Duke|L. Duke]] 
Description: Prevents players from picking up restricted weapons (if bought, they fall to the ground). Also includes an option to remove restricted weapons from the game. 
Features: Hook CCSPlayer::Weapon_CanUse(CBaseCombatWeapon *pWeapon) and returns false for restricted weapons. Also shows how to use virtual functions on weapons such as Delete()and GetName() and on players for Weapon_GetSlot(int) and Drop(CBaseCombatWeapon*). 
Download: [http://forums.alliedmods.net/showthread.php?p=342750 forums.alliedmods.net/showthread.php?p=342750]
 
=== ForgiveTK ===
Author: [[User:EKS|EKS]] 
Description: This is a basic plugin to handle teamkilll and teamattack on your source server, it supports any Source mod. It will automaticly kick someone with to many offenses 
Features: Forgive via menu or chat. Support both Valves ESC menus and radio menus. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3081 http://www.sourcemod.net/forums/viewtopic.php?t=3081]
 
=== Global Banlist===
Author: [[User:devicenull|devicenull]] 
Description: This plugin allows srcds to reguarly connect to an external PHP page, and download updates about it's banlist. Srcds then stores these in a SQLite database. 
Features: Embedding sqlite, using pthreads, using libcurl. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3539 http://www.sourcemod.net/forums/viewtopic.php?t=3539]
 
=== HLStatsX ( Allows srcds to interact with hlstatsx ingame) ===
Author: [[User:EKS|EKS]] 
Description: This plugin is made to interact with hlstatsx ( www.hlstatsx.org ) to give proper ingame stats, and provide the extra logging required for hit detection 
Download: [http://forums.alliedmods.net/showthread.php?t=42502 http://forums.alliedmods.net/showthread.php?t=42502]
 
=== IRC Relay ===
Author: [[User:sslice|sslice]] 
Description: Reports game events to an IRC channel and allows you to administrate your server from IRC 
Features: ConCommand hooks and general networking using sockets 
Download: [http://forums.alliedmods.net/showthread.php?t=39395 AlliedModders] or [http://www.tcmagazine.info/modules.php?modname=custompage&name=ircrelay&catid=4 Gameconnect]
 

=== Last Users Connected ===
Author: [[User:devicenull|devicenull]] 
Description: With this plugin, every player who comes onto your server has their steamid logged, along with any name they used on the server. You can then either view the names/steamid's of the last people to disconnect, or you can search for a name/steamid and see everyone who has used that name. 
Features: shows how to embed sqlite3, send basic messages/basic hooks. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3339 http://www.sourcemod.net/forums/viewtopic.php?t=3339]
 
=== Stripper:Source ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: You can add any type of entity - hostage, spawn point, physics prop, permanently to the map. You can also filter out entities for deletion, either by specific entries or regular expressions. Stripper:Source lets you define global rules and per-map rules. It also lets other plugins (both SourceMM plugins and Server Plugins) use its API. 
Features: shows how to edit the map entity lump in memory to change map entities 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3008 www.sourcemod.net/forums/viewtopic.php?t=3008]
 
[[Category:Documentation (SourceMM)]]

= Open Source Valve Server Plugins (VSP) =
A list of open source plugins for the Valve Server Plugin (VSP) interface can be found [http://developer.valvesoftware.com/wiki/List_of_Open_Source_Server_Plugins here].

Open Source Plugins for Metamod:Source

2006-10-20T01:54:54Z

Sslice: /* Functional Plugins */

= Open Source Plugins for SourceMM =
This page lists known plugins with available source code. Please check the licenses for each one as they may not truly be "open source."
 
== Basic Templates ==
=== stub_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: minmum implentation of a valid SourceMM plugin 
Features: starting template 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: implements the features of the standard Valve server plugin from the SDK 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample2_mm ===
Author: [[User:BAILOPAN|BAILOPAN]], edited by [[User:L._Duke|L. Duke]] 
Description: fixes (by inheriting from IGameEventListener2 instead of hooking FireGameEvent) the problem in sample_mm plugin where some events are not received 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: [http://forums.alliedmods.net/showthread.php?p=342749 forums.alliedmods.net/showthread.php?p=342749] (you must be logged in to view the download link)
 

== Functional Plugins ==
=== Anti-Griefer ===
Author: [[User:devicenull|devicenull]] 
Description: This plugin is for the mod SourceForts. In keeps track of what player unfreezes or freezes a block, and allows any other player to retrieve this information by aiming at a block. 
Features: Basic VFuncs, listening for events, partial traceline (The method used for traceline might not be effective for any other mod) 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3652 http://www.sourcemod.net/forums/viewtopic.php?t=3652]
 
=== Basic Admin Tool (BAT) ===
Author: [[User:EKS|EKS]] 
Description: Provides basic admin functions 
Features: Kick, ban, menus, reserved slots, timeleft/nextmap say commands, and more 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=2923 www.sourcemod.net/forums/viewtopic.php?t=2923]
 
=== Counter Strike Bot Control ===
Author: [[User:EKS|EKS]] 
Description: This plugin allows you to control the counter strike source bots more easly, you can have them them automaticly keep the server populated. You can have bots automaticly killed when all the human players are dead, and any changes can be made in the bot menu. 
Features: Control the built in bots in CSS via a menu 
Download: [http://forums.alliedmods.net/showthread.php?t=40097 http://forums.alliedmods.net/showthread.php?t=40097]
 

=== CS:S Weapon Restrictions 2 ===
Author: [[User:L._Duke|L. Duke]] 
Description: Prevents players from picking up restricted weapons (if bought, they fall to the ground). Also includes an option to remove restricted weapons from the game. 
Features: Hook CCSPlayer::Weapon_CanUse(CBaseCombatWeapon *pWeapon) and returns false for restricted weapons. Also shows how to use virtual functions on weapons such as Delete()and GetName() and on players for Weapon_GetSlot(int) and Drop(CBaseCombatWeapon*). 
Download: [http://forums.alliedmods.net/showthread.php?p=342750 forums.alliedmods.net/showthread.php?p=342750]
 
=== ForgiveTK ===
Author: [[User:EKS|EKS]] 
Description: This is a basic plugin to handle teamkilll and teamattack on your source server, it supports any Source mod. It will automaticly kick someone with to many offenses 
Features: Forgive via menu or chat. Support both Valves ESC menus and radio menus. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3081 http://www.sourcemod.net/forums/viewtopic.php?t=3081]
 
=== Global Banlist===
Author: [[User:devicenull|devicenull]] 
Description: This plugin allows srcds to reguarly connect to an external PHP page, and download updates about it's banlist. Srcds then stores these in a SQLite database. 
Features: Embedding sqlite, using pthreads, using libcurl. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3539 http://www.sourcemod.net/forums/viewtopic.php?t=3539]
 
=== HLStatsX ( Allows srcds to interact with hlstatsx ingame) ===
Author: [[User:EKS|EKS]] 
Description: This plugin is made to interact with hlstatsx ( www.hlstatsx.org ) to give proper ingame stats, and provide the extra logging required for hit detection 
Download: [http://forums.alliedmods.net/showthread.php?t=42502 http://forums.alliedmods.net/showthread.php?t=42502]
 
=== IRC Relay ===
Author: [[User:sslice|sslice]] 
Description: Reports game events to an IRC channel and allows you to administrate your server from IRC 
Features: Interaction between players and IRC users, as well as general administration 
Download: [http://forums.alliedmods.net/showthread.php?t=39395 AlliedModders] or [http://www.tcmagazine.info/modules.php?modname=custompage&name=ircrelay&catid=4 Gameconnect]
 
=== Last Users Connected ===
Author: [[User:devicenull|devicenull]] 
Description: With this plugin, every player who comes onto your server has their steamid logged, along with any name they used on the server. You can then either view the names/steamid's of the last people to disconnect, or you can search for a name/steamid and see everyone who has used that name. 
Features: shows how to embed sqlite3, send basic messages/basic hooks. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3339 http://www.sourcemod.net/forums/viewtopic.php?t=3339]
 
=== Stripper:Source ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: You can add any type of entity - hostage, spawn point, physics prop, permanently to the map. You can also filter out entities for deletion, either by specific entries or regular expressions. Stripper:Source lets you define global rules and per-map rules. It also lets other plugins (both SourceMM plugins and Server Plugins) use its API. 
Features: shows how to edit the map entity lump in memory to change map entities 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3008 www.sourcemod.net/forums/viewtopic.php?t=3008]
 
[[Category:Documentation (SourceMM)]]

= Open Source Valve Server Plugins (VSP) =
A list of open source plugins for the Valve Server Plugin (VSP) interface can be found [http://developer.valvesoftware.com/wiki/List_of_Open_Source_Server_Plugins here].

Metamod:Source Development

2006-03-22T00:54:48Z

Sslice: /* Requirements */

This article is an introduction to [[SourceMM]] coding.

{{qnotice|The majority of this documentation should be merged or moved into an article about [[SourceHook]].}}

{{qnotice|This article probably needs some better formatting.}}

=Requirements=
You must have the Valve [[HL2SDK]], available from your [[Steam]] Menu. For Windows, you must have [[Microsoft Visual Studio]] 7.0 or 7.1 (we have not tried 6.0). For [[Linux]], Valve requires you use at least [[GCC]] 3.4.1. You should also have a copy of the [[Metamod:Source]] source code, available [http://www.sourcemm.net/ here] (sourcemm/sourcehook and sourcemm/sourcemm).

For [[Microsoft Visual Studio]], you should make sure that you have the following HL2SDK paths in your include settings (Tools -> Options -> Projects, VC++ Directories, Include Files), as well as the "sourcehook" and "sourcemm" folders:
*dlls
*public
*public\vsdtlib
*public\tier1
*public\tier0
*public\engine
*public\dlls
*tier1
*lib\public (this should be in your Library Paths!)

=Plugin API=
In order to write a plugin, you must implement the ISmmPlugin interface, similar to IServerPluginCallbacks. Each Metamod:Source release has a minimum required interface version and a current version. The minimum version is guaranteed to be upward compatible to the current, however, it may be lacking some features.

Once you've implemented the interface, you must also have a global singleton of your plugin available. There are a few macros to assist you in properly exposing the interface as a DLL and setting up the API states.

*{{bcode|PLUGIN_GLOBALVARS}}() - Place in header. Declares the global variables that some API calls require (such as g_SHPtr and g_PLAPI).
*{{bcode|PLUGIN_EXPOSE}}(class, singleton) - Place in .cpp file. Declares the external CreateInterface function which exposes the API.
*{{bcode|PLUGIN_SAVEVARS}}() - Use first thing in ISmmPlugin::Load(), saves the global variables sent from SourceMM.

The actual plugin API you must implement as of this writing is version 004. To see a description of each of the functions, you can view the doxygen information here. Note that the Load, Unload, Pause, and Unpause functions allow you to refuse the action and copy an error message (you should check to make sure error is not NULL - it can be).

=SourceHook (Hooking)=
SourceHook is the engine used to intercept function calls, much like Metamod. The difference with SourceHook is that it can intercept any virtual function in any class that, at compile time, you have the header for. SourceHook has the following steps of operation:

* Declare the prototype of the function you are going to hook. This generates compile-time code that is able to pinpoint exactly how to go about hooking the function.
* Hook the function - as a member function of another class or a regular static function.
* Before the hooked function is called, all of the "pre" hook handlers attached to it are called. Each hook can set a special flag, the highest of which is chosen as a final operation. This flag specifies whether the original function should be called or not.
* Once all the hooks have been called, SourceHook decides whether to call the original function. Another set of hooks are called directly after, called "post" hook handlers. You can specify whether each hook is a post or pre hook - it simply changes whether it's called before or after the original call is made.
* After you are done using a hook, you can safely remove it.

For example, let's say you wanted to intercept log messages in VEngineServer. Observe the prototype:
<pre>
virtual void LogPrint( const char *msg ) = 0;
</pre>
This is a virtual, public function of a class we have an instance of (let's say in IVEngineServer *m_Engine) and that we have the header for. It can be intercepted.

The first step is to figure out how to declare its prototype to SourceHook. This function is void, and has one parameter. The declaration macro follows these formats:

*{{bcode|SH_DECL_HOOK}}n - n is the number of parameters
**The parameters are: Class name, member function name, attributes, overloaded?, the return type, and a list of the parameter types.
*{{bcode|SH_DECL_HOOKn_void}} - n is the number of parameters
**_void specifies that the function does not return a value. The format is the same as above except the "return type" parameter is missing.
*'''Note:''' Not covered here are the SH_DECL_HOOKn[_void]_vafmt hooks. These can hook string-formattable variable argument lists. You do not pass the string format or ellipses parameter. SourceHook will automatically format the string for your hook.

Our macro will look like this:
<pre>
SH_DECL_HOOK1_void(IVEngineServer, LogPrint, SH_NOATTRIB, 0, const char *);
</pre>
This line must appear outside of a function. It means "Declare a hook prototype for LogPrint in IVEngineServer, which is a void function that has one parameter, which is a const char *".

Next we must actually hook the function. You can do this wherever you want to begin the interception. The two macros for hooking look like this:

*{{bcode|SH_ADD_HOOK_STATICFUNC}}(class, memberfunction, instance_pointer, handler, post Hooks a virtual function to a static/global function.
**class - The name of the class
**memberfunction - The name of the member function
**instance - A pointer to an instance of the class
**handler - Your function that will be called on hooking
**post - true for post operation, false for pre operation
*{{bcode|SH_ADD_HOOK_MEMFUNC}}(class, memberfunction, instance, myinstance, myfunction, post) Hooks a virtual function to a member function of another class.
**class - The name of the class
**memberfunction - The name of the member function
**instance - An pointer to an instance of the class
**myinstance - A pointer to an instance of the class that has the handler member function
**myfunction - The name of the handler member function in your class
**post - true for post operation, false for pre-operation

Let's continue with the example. To hook LogPrint to a function in your class, CMetaHooks (instance, g_MetaHooks), you would use:
<pre>
SH_ADD_HOOK_MEMFUNC(IVEngineServer, LogPrint, m_Engine, &g_MetaHooks, &CMetaHooks::LogPrint, false);
</pre>
To remove the hook (either once it will no longer be unused, or at unload time):
<pre>
SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, LogPrint, m_Engine &g_MetaHooks, &CMetaHooks::LogPrint, false);
</pre>
Now, your function contents will look something like this:
<pre>
void CMetaHooks::LogPrint(const char *msg)
{
//Code here
RETURN_META(MRES_IGNORED);
}
</pre>
Note this return statement. This style of returning is similar to Metamod's, where you can set four different flags to indicate how you would like SourceHook to proceed. In Metamod, this return statement was required. In SourceMM, it is only required if you wish to set a return state other than MRES_IGNORED.

*{{bcode|MRES_IGNORED}} - No states were changed, act as though nothing happened. Original function is still called.
*{{bcode|MRES_HANDLED}} - Something changed, but the original function was still called. This can be used to tell another plugin that you did something.
*{{bcode|MRES_OVERRIDE}} - The original function will still be called, but your return value will override whatever it returns.
*{{bcode|MRES_SUPERCEDE}} - The original function is not called, and your return value will be what is returned to the caller.

Note, that if you need to return a value, there is another macro. For example:
<pre>
RETURN_META_VALUE(MRES_SUPERCEDE, value);
</pre>
This is required for non-void functions, athough the return value is ignored using MRES_IGNORED or MRES_HANDLED.

Alternatively, you can hook to static member functions which has a slightly easier syntax. The DECL_HOOK line does not change. To add the hook:
<pre>
SH_ADD_HOOK_STATICFUNC(IVEngineServer, LogPrint, m_Engine, LogPrint_handler, false);
</pre>
Removing the hook:
<pre>
SH_REMOVE_HOOK_STATICFUNC(IVEngineServer, LogPrint, m_Engine, LogPrint_handler, false);
</pre>
Declaring the handler:
<pre>
void LogPrint_handler(const char *msg)
{
//Code here
RETURN_META(MRES_IGNORED);
}
</pre>
Note that vafmt functions hooked with SourceHook assume that the vafmt is for a printf style string, and that the vafmt occurs at the end. When setting the parameters, you do not include the '...' notation, and SourceHook will vafmt the input string for you (meaning you also don't specify ... in your hooked function).

=Calling Original Functions=
Often it will be necessary for you to call a function that's hooked, however, you don't want the hooks to be included in the calling. For example, if you want to entirely supercede a function and call it yourself from within a hook. To do this, you must request a call class. This is similar to MDLL_x() from Metamod for Half-Life 1.

Continuing with the above example, let's say we want to supercede the original call and log a different message. Assume we also have the pointer m_Engine which is a <tt>IVEngineServer *</tt>.
<cpp>
SourceHook::CallClass<IVEngineServer> *Engine_CC = SH_GET_CALLCLASS(m_Engine);

SH_CALL(Engine_CC, &IVEngineServer::LogPrint)("This is a log message!\n");

//When you are done with the pointer..
SH_RELEASE_CALLCLASS(Engine_CC);
</cpp>

Because of the complex nature of inheritance, instance pointers, and vtables, this syntax can be quite daunting. You may wish to make macros for specific functions or classes you use quite often, to reduce the amount of typing. For example:
<cpp>
//Assuming you have a global pointer g_Engine...
#define ENGCALL(func) SH_CALL(g_Engine, &IVEngineServer::func)

//Then you can do:
ENGCALL(LogPrint)("This is a test!");
</cpp>

The syntax of calling class construction is:
*<tt>SourceHook::CallClass<class> *ptr = SH_GET_CALLCLASS(instance);</tt>
**Returns an object which allows you to call the original function. Class is the name of the class which is the target, instance is an instance of that class.
*<tt>SH_CALL(cc_ptr, &class::func)([params])</tt>
**Pass the pointer returned from SH_GET_CALLCLASS as cc_ptr. The target function you call must be passed as a pointer-to-member-function, which takes the form &Class::Function as seen in previous examples. You must then complete the function call by adding a parenthetical parameter expression, even for void functions, which would be ().

=Other Macros=
All of the macros take g_PLAPI as the first parameter. For more information on this, see the global variables section.

*{{bcode|META_CONPRINT}}(const char *msg)
*{{bcode|META_CONPRINTF}}(const char *fmt, ...)
**These two functions are recommended over Msg() for printing to the server console. Msg() does not relay commands back through rcon, and as of this writing Valve does not expose the function which does. To be able to display text through the rcon console (much like HL1), you should use these functions. If SourceMM is unable to extract the function properly, it will automatically default to Msg.
*{{bcode|META_LOG}}(g_PLAPI, const char *msg, ...)
**Logs a message through IVEngineServer::LogPrint(). A newline is automatically added, and msg is formatted as a sprintf() style string.
*{{bcode|META_REGCVAR}}(var)
**Registers a ConCommandBase pointer through SourceMM. The correct way to use this is to create an IConCommandBaseAccessor, and inside RegisterConCommandBase, call the macro on the given ConComandBase. This will ensure that SourceMM correctly detects and unloads your cvars and concommands at the appopriate time. Otherwise, unloading your plugin will cause a crash.
*{{bcode|META_UNREGCVAR}}(var)
**Unregisters a ConCommandBase pointer. This is not needed if you have set up your IConCommandBaseAccessor correctly (and called ConCommandBaseMngr::OneTimeInit()).

=Events System=
The Events System is based on IMetamodListener. By implementing the IMetamodListener class and using g_SMAPI->AddListener, you can watch for certain, low-traffic events. These events are split into three categories:

*Plugin Events let you listen for plugin pauses and unloads. This is important if you're relying on information from another plugin, as you can handle cases where a live plugin has become invalid.
*Game Events are simple events that SourceMM is already hooking and makes available. These are LevelShutdown and LevelInit right now.
*Query Events occur when a factory is used. The four main factories (Engine, GameDLL, FileSystem, and Physics) are all overridable. You should simply return a non-NULL result to override, and fill the return code with IFACE_OK if available. There is no way to handle the case of two plugins overriding right now. The final factory is the Metamod Factory, which is the factory that Metamod:Source adds to the runtime space for plugins. By default, it only contains the interfaces for the PluginManager and SourceHook. Plugins can use this to add new interfaces. Other plugins request these interfaces through g_SMAPI->MetaFactory().

=Global Variables=
These global variables are saved by PLUGIN_EXPOSE and PLUGIN_SAVEVARS. They are declared with PLUGIN_GLOBALVARS.

*{{bcode|g_PLAPI}}
**ISmmPlugin * pointer to your global class singleton.
*{{bcode|g_PLID}}
**The internal PluginId of your plugin.
*{{bcode|g_SHPtr}}
**The SourceHook::ISourceHook * pointer to SourceHook's interface.
*{{bcode|g_SMAPI}}
**The ISmmAPI * pointer to SourceMM's interface.

=Compiling=
To see more about compiling, see the Sample Plugin Compiling section.

Modifying the default Makefiles for your own projects:

*<tt>OPT_FLAGS</tt> - Optimization flags
*<tt>DEBUG_FLAGS</tt> - Debug flags
*<tt>CPP</tt> - C++ Compiler
*<tt>OBJETS</tt> - List of C++ files to compile
*<tt>LINK</tt> - Linker Options
*<tt>CFLAGS</tt> - Base Compiler Flags
*<tt>BINARY</tt> - Output Binary Name

Makefile commands:

*clean - Cleans all build files
*debug - Builds debug version

=1.1 Changes - Late Loading, Events=
SourceMM 1.1 changed quite a few things internally, and externally made many breaking changes. These include:

*ISmmPlugin::Load() has removed the factory list parameter (the factory system was replaced with the event system). Also, a boolean parameter was added, specifying whether the plugin was loaded late or not.
*ISmmPlugin::Load() is now called BEFORE DLLInit(), rather than after. This means it might not have all information it needs -- for example, IGameEvents won't be parsed yet. You will need to do things like this in ISmmPlugin:AllPluginsLoaded() instead, as it is guaranteed to occur when all DLLs are initialized.
*ISmmPlugin now has default functions -- you don't have to implement all of them.
*SourceHook was modified to use interfaces rather than straight struct pointers. This breaking changes will ensure that future SourceHook modifications do not break older plugins.
*SourceHook was modified to be re-entrant.
*SourceHook now has a tiny template library with it. This removes the necessity to link against libstdc++.so.*, which harms binary compatibility across linux distributions.
*SourceMM's GameDLL code was completely rewritten. It will now work with newer mods much easier, and issues like the DoD:S release will be much easier to deal with (if at all). It also removes a few important speed bottlenecks.
*An events system was added.

=1.2 Changes - Changing Parameters, Manual Hooking=
SourceMM 1.2 now supports changing the parameters in a hook chain. For example, say the GameDLL has a function called IGameDLL::PrintString(const char *str). You can hook this, let it continue, but change the "str" parameter passed in to the rest of the hooks and the GameDLL. To do this, use the following macros:

*<tt>RETURN_META_NEWPARAMS</tt>
*<tt>RETURN_META_VALUE_NEWPARAMS</tt>

Example:
<cpp>
class ISomething
{
virtual void Function1(int num) =0;
virtual bool Function2(bool what, int hi) =0;
}

void MyHook1(int num)
{
//if num is 0,
// we will change the num parameter in the rest of the hooks, and the gamedll, to be 1.
if (num == 0)
RETURN_META_NEWPARAMS(MRES_IGNORED, &ISomething::Function1, (1))
RETURN_META(MRES_SUPERCEDE);
}

bool MyHook2(bool what, int hi)
{
//change the "what" and "hi" parameters to be false and 3 respectively
//also, return true, but specify that the value is ignored
RETURN_META_VALUE_NEWPARAMS(MRES_IGNORED, true, &ISomething::Function2, (false, 3));
}
</cpp>
SourceHook also supports manual hooking of functions. This means you must know the virtual table index, the virtual table offset (for polymorphism), and the "this" pointer offset. Luckily, the polymorphic offsets are usually zero. This type of hook is ideal when supporting different ABI, for example, across different gamedlls. The API is almost identical:

*<tt>SH_DECL_MANUALHOOKn[_void|_vafamt]</tt> -
**Declares the manual hook. A unique name must be given to each manual hook.
*<tt>SH_[ADD|REMOVE]_MANUALHOOK_[STATIC|MEM]FUNC</tt> -
**Adds or removes a static or member function hook on a manually declared hook.
*<tt>SH_MANUALHOOK_RECONFIGURE</tt> -
**Reconfigures the indexes and offsets of a manual hook.

An example is below, using the ISomething class from above.

<cpp>
SH_DECL_MANUALHOOK2(_M_Function1, 1, 0, 0, bool, bool, int);

void OnLoad(ISomething *pSomething)
{
//we reference the static function by its unique handle we gave it
//the parameters are otherwise the same - this pointer, hook handler, and post/non-post
SH_ADD_MANUALHOOK_STATICFUNC(_M_Function1, pSomething, MyHook1, false);
}

void OnUnload(ISomething *pSomething)
{
SH_REMOVE_MANUALHOOK_STATICFUNC(_M_Function1, pSomething, MyHook1, false);
}
</cpp>

For more examples of the above features, you can look in SourceHook CVS's [http://www.tcwonline.org/cgi-bin/viewcvs.cgi/sourcemm/sourcehook/test/ test suite], which demonstrates a variety of hooking scenarios.

[[Category:SourceHook]]
[[Category:Documentation (SourceMM)]]

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:30:04Z

Sslice: /* Credits */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

This tutorial assumes the following.
<OL>
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
Download Mirrors for 'crosstool_gcc.tar.gz'
*[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
*[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
*[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]

This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Cross Compiler compiled by: L. Duke
*Makefile originally written by: David "BAILOPAN" Anderson
*Converted to Wiki by: James "sslice" Gray

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

[[Category:Documentation (SourceMM)]]

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:29:57Z

Sslice: /* Credits */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

This tutorial assumes the following.
<OL>
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
Download Mirrors for 'crosstool_gcc.tar.gz'
*[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
*[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
*[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]

This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson
*Converted to Wiki by: James "sslice" Gray

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

[[Category:Documentation (SourceMM)]]

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:29:40Z

Sslice: /* Credits */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

This tutorial assumes the following.
<OL>
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
Download Mirrors for 'crosstool_gcc.tar.gz'
*[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
*[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
*[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]

This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Converted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

[[Category:Documentation (SourceMM)]]

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:28:10Z

Sslice:

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

This tutorial assumes the following.
<OL>
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
Download Mirrors for 'crosstool_gcc.tar.gz'
*[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
*[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
*[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]

This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

[[Category:Documentation (SourceMM)]]

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:27:33Z

Sslice: /* Installing CrossTool */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

This tutorial assumes the following.
<OL>
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
Download Mirrors for 'crosstool_gcc.tar.gz'
*[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
*[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
*[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]

This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:27:14Z

Sslice: /* Introduction */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

This tutorial assumes the following.
<OL>
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI>[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
<LI>[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
<LI>[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:26:47Z

Sslice: /* Installing The CrossCompiler */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

<OL>This tutorial assumes the following.
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing CrossTool==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI>[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
<LI>[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
<LI>[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:26:33Z

Sslice: /* Installing The CrossCompiler */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

<OL>This tutorial assumes the following.
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing The CrossCompiler==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI>[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
<LI>[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
<LI>[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:

cd /
tar -xzf crosstool_gcc-3.4.1.tar.gz

This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.


==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:25:57Z

Sslice: /* Compiling Plugins */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

<OL>This tutorial assumes the following.
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing The CrossCompiler==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI>[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
<LI>[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
<LI>[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:
cd /

tar -xzf crosstool_gcc-3.4.1.tar.gz
This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.

==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:25:44Z

Sslice: /* Compiling Plugins */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

<OL>This tutorial assumes the following.
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing The CrossCompiler==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI>[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
<LI>[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
<LI>[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:
cd /

tar -xzf crosstool_gcc-3.4.1.tar.gz
This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.

==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'

Download Mirrors for 'srcds_l_binaries.zip'
*[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
*[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:24:56Z

Sslice: /* Introduction */

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.

<OL>This tutorial assumes the following.
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing The CrossCompiler==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI>[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
<LI>[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
<LI>[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:
cd /

tar -xzf crosstool_gcc-3.4.1.tar.gz
This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.

==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'
<UL>Download Mirrors for 'srcds_l_binaries.zip'
<LI>[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
<LI>[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
</UL>
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:24:31Z

Sslice:

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.
<OL>This tutorial assumes the following.
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extremely important.

*binutils
*bzip2
*cygutils
*gcc
*glib
*gzip

*libiconv
*make
*zlib
*grep

Click next and it should install the packages to the target path you specified.


==Installing The CrossCompiler==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI>[http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html FileFront]
<LI>[http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html RapidShare.de]
<LI>[http://downloads.punkassfraggers.com/redirect.php?dlid=1224 PunkAssFraggers.com]
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:
cd /

tar -xzf crosstool_gcc-3.4.1.tar.gz
This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 [http://www.lduke.com (Thanks LDuke)] installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.

==Compiling Plugins==
Download the Makefile by clicking on [http://www.c0ld.net/Tutorials/CrossTool/Makefile this link.]

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the [http://www.sourcemm.net/ SourceMM package]

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'
<UL>Download Mirrors for 'srcds_l_binaries.zip'
<LI>[http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html FileFront Mirror]
<LI>[http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html RapidShare.de Mirror]
</UL>
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool

Cross Compiling Plugins (Metamod:Source)

2006-01-22T22:20:26Z

Sslice:

==Introduction==
The aim of this tutorial is to allow Windows Half-Life 2 plugin coders to compile their plugins on the same machine as the windows binaries.
The binaries are compatible with 99% of all linux servers and do not suffer from bulky file sizes.
One of the main benefits to using this method of compiling is that your code can be left wherever you currently have it so that compile time reluctance is removed and coders can concentrate on coding the plugins instead of "How on earth am I to compile this for linux ???".
All you need to get started are the base Cygwin installation, the CrossTool.tar.gz file and the makefile. Links to the latter two are included at the end of the tutorial.
<OL>This tutorial assumes the following.
<LI>You currently have a plugin which you can compile on windows using MSVC.
<LI>You have a copy of the HL2SDK Source Code installed on your hard drive.
<LI>You have a copy of the [http://www.sourcemm.net Metamod:Source] source code on your hard drive.
</OL>

Although the cross compiler will allow for compiling of Valves standard plugins, I do not include a Makefile or instructions on how to successfuly occomplish this.

==Installing Cygwin==
First, download CygWin from [http://www.cygwin.com www.CygWin.com] by clicking on "Install Now" located in the middle of the page.

Once the download finishes, run setup.exe
Click 'Next' on the introduction screen.

On the second page, select 'Install from Internet'.
The following page is all user preferances, except the 'Default Text File Type' which is recommended you use 'Unix / binary'.
After clicking next, you are prompted for a CygWin temporary folder, any folder will suffice, the default is usually the better option.
The next screen's options are firewall/proxy settings, these are specific to the Computer/Network you are currently using.
Once you click next on the previous screen, the installer will download a list of mirror sites containing the CygWin binaries. Select one which you think is closest to you for a faster installation time.
Finaly, you are presented with a 'Select Packages' screen.
I *think* it should work fine without all of the dev packages.

If anyone has gotten this to work by selecting less packages, please let me know so I can remove them from this list.
Items marked in bold are extreemly important.
<UL>
<LI>binutils
<LI>bzip2
<LI>cygutils
<LI>gcc
<LI>glib
<LI>gzip

<LI>libiconv
<LI>make
<LI>zlib
<LI>grep
</UL>
Click next and it should install the packages to the target path you specified.


==Installing The CrossCompiler==
Download the CrossCompiler from one of the mirrors below to the root cygwin folder (c:\cygwin).
If it gets renamed to 'crosstool_gcc-3.4.1.tar.tar' please rename it to 'crosstool_gcc-3.4.1.tar.gz'.
<UL>Download Mirrors for 'crosstool_gcc.tar.gz'
<LI><a href="http://files.filefront.com/crosstool_gcc_341targz/;4650645;;/fileinfo.html" target="_blank" class="postlink"><img height="15" width="15" border="0" src="http://c0ld.net/dls/styles/c0ld.net/images/download.gif">  </a><a href="http://www.FileFront.com" target="_blank" class="postlink">FileFront Mirror</a>
<LI><a href="http://rapidshare.de/files/11588086/crosstool_gcc-3.4.1.tar.gz.html" target="_blank" class="postlink"><img height="15" width="15" border="0" src="http://c0ld.net/dls/styles/c0ld.net/images/download.gif">  </a><a href="http://www.RapidShare.de" target="_blank" class="postlink">RapidShare.de Mirror</a>
<LI><a href="http://downloads.punkassfraggers.com/redirect.php?dlid=1224" target="_blank" class="postlink"><img height="15" width="15" border="0" src="http://c0ld.net/dls/styles/c0ld.net/images/download.gif">  </a><a href="http://www.punkassfraggers.com" target="_blank" class="postlink">PunkAssFraggers.com Mirror</a>
</UL>
This is the most important part of the entire tutorial.

Do not try and extract 'crosstool_gcc-3.4.1.tar.gz' using any Windows Archiving utility !
They do not extract the files correctly and if you don't get errors during the extraction, you will while trying to compile !
Once the download is complete, run cygwin by navigating to the cygwin root folder, and double clicking on 'cygwin.bat'.
Type the following two commands in order into the cygwin bash shell followed by the enter key:
cd /

tar -xzf crosstool_gcc-3.4.1.tar.gz
This will start extracting the tar file to the '<cygroot>/opt' folder on your hard drive.
And thats it, now you have the pre-compiled GCC 3.4.1 <a href="http://www.lduke.com" target="_blank" class="postlink">(Thanks LDuke)</a> installed on your computer you can compile server plugins for both regular and SourceMM flavours with ease and compatibility with Valves GCC 3.4.1 requirements.

Compiling Plugins.
Download the Makefile by clicking on <a href="./Tutorials/CrossTool/Makefile" class="postlink" target="_blank">this link.</a>

Save it to your project's root source folder and open it with a text editor like notepad.
Inside the Makfile I have shown examples on how your paths are translated into unix/cygwin hybrid paths.
So, before trying any compling just yet, you need to insert the paths for the following.
HL2SDK: The path to where your HL2SDK files are located.
SMM_ROOT: The path to where you extracted the contents of the <a href="http://www.sourcemm.net/">SourceMM package</a>.

SRCDS: The path to the linux SRCDS binaries.
PLUGIN: The plugin filename.
For the convenience of those who dont have access to a linux srcds installation, you can grab the files required at one of the mirrors below.
Extract them to a new folder which will be your SRCDS path in the Makefile.
Note:The bin folder must be inside the srcds folder for maximum compatibility. For example, your files end up being something like this 'C:\MyFiles\srcds_l\bin\vstdlib_i486.so'.

So, in your Makefile, SRCDS would be '/cygdrive/c/MyFiles/srcds_l'
<UL>Download Mirrors for 'srcds_l_binaries.zip'
<LI><a href="http://files.filefront.com/srcds_l_binarieszip/;4651213;;/fileinfo.html" target="_blank" class="postlink"><img height="15" width="15" border="0" src="http://c0ld.net/dls/styles/c0ld.net/images/download.gif">  </a><a href="http://www.FileFront.com" target="_blank" class="postlink">FileFront Mirror</a>
<LI><a href="http://rapidshare.de/files/11597264/srcds_l_binaries.zip.html" target="_blank" class="postlink"><img height="15" width="15" border="0" src="http://c0ld.net/dls/styles/c0ld.net/images/download.gif">  </a><a href="http://www.RapidShare.de" target="_blank" class="postlink">RapidShare.de Mirror</a>
</UL>
Now you're ready to try compiling.
Back to the cygwin bash window, and we're now going to have to navigate to your code's location.
An exmaple path could be 'C:\MyCode\MyPlugin\' so in the bash shell we type the following:

cd /cygdrive/c/MyCode/MyPlugin/
make

If all your paths are set correctly, it should start compiling the plugin.
Ignore all the warnings in the HL2SDK, they are harmless.
What you should be looking out for are errors and warnings located inside your own code.
Unfortunately I cannot compile plugins for you, but there is a forum dedicated to helping you with hl2sdk coding problems.

[http://www.sourcemod.net/forums/viewforum.php?f=24 Click here to visit the forum]

==Credits==
*Tutorial by: Jason "c0ldfyr3" Croghan
*Conerted to Wiki by: James "sslice" Gray
*Cross Compiler compiled by: L. Duke
*MakeFile originally written by: David "BAILOPAN" Anderson

Original Location: http://www.c0ld.net/index.php?inc=CrossTool