AlliedModders Wiki - User contributions [en]

Porting to Orange Box

2010-08-30T19:33:15Z

C0ldfyr3: RegisterConCommandBase is a bool return type, added return to the function it calls...

__FORCETOC__
Porting Valve Server Plugins or Metamod:Source plugins to Orange Box is not very difficult. This article explores some of the changes and how to simplify them.

Users of Metamod:Source should upgrade to Metamod:Source 1.7 and use the 1.6+ API (see [[MM:S API Differences]]).

This document will assume a single preprocessor macro, <tt>ORANGEBOX_BUILD</tt>, determines that an Orange Box build is being made.

=Command Callbacks=
In the original Half-Life 2 engine, all commands used <tt>IVEngineServer::Cmd_Arg*</tt> in order to receive information about the current command's tokenization. However, these functions have been completely removed, and a new re-entrant version is in place.

Each of the following callbacks:
<cpp>void IServerGameClients::ClientCommand(edict_t *pEdict);
typedef void (*FnCommandCallback)(void);</cpp>

Is now:
<cpp>void IServerGameClients::ClientCommand(edict_t *pEdict, const CCommand &args);
typedef void (*FnCommandCallback)(const CCommand &args);</cpp>

Definitions for <tt>CCommand</tt> can be found in <tt>convar.h</tt>. A simple way to work around this change is to use wrapper functions. For example:

<cpp>
#if defined ORANGEBOX_BUILD
SH_DECL_HOOK2_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *, const CCommand &);
#else
SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
#endif

#if !defined ORANGEBOX_BUILD
class CCommand
{
public:
const char *ArgS()
{
return engine->Cmd_Args();
}
int ArgC()
{
return engine->Cmd_Argc();
}

const char *Arg(int index)
{
return engine->Cmd_Argv(index);
}
};
#endif

#if defined ORANGEBOX_BUILD
void Hook_ClientCommand(edict_t *pEntity, const CCommand &args)
#else
void Hook_ClientCommand(edict_t *pEntity)
#endif

{
#if !defined ORANGEBOX_BUILD
CCommand args;
#endif

const char *cmd = args.Arg(0);
/* ... stuff ... */
}</cpp>

=ConCommandBaseMgr Removed=
ConCommandBaseMgr has been removed. That means the normal call, <tt>ConCommandBaseMgr::OneTimeInit()</tt>, is no longer applicable. There are two other solutions to registering your ConVars and ConCommands:
*Use <tt>ConVar_Register</tt> instead.
*Use <tt>META_REGCVAR</tt> on each pointer (it will work on any ConCommandBase *) pointer, or <tt>META_REGCMD</tt> on each individual command name.

It is highly recommended that Metamod:Source plugins go through Metamod:Source's ConCommandBase registration process. This will make your plugin more compatible across engines and other plugins. Example:

<cpp>
class BaseAccessor : public IConCommandBaseAccessor
{
public:
bool RegisterConCommandBase(ConCommandBase *pVar)
{
return META_REGCVAR(pVar);
}
} s_BaseAccessor;

void SetupEverything()
{
#if defined ORANGEBOX_BUILD
/* NOTE! g_pCvar must be set to a valid ICvar instance first. */
ConVar_Register(0, &s_BaseAccessor);
#else
ConCommandBaseMgr::OneTimeInit(&s_BaseAccessor);
#endif
}</cpp>

Note that Valve Server Plugins can pass <tt>NULL</tt> to use the default accessor. '''Metamod:Source plugins should not do this.''' Otherwise, Metamod:Source will not be able to keep track of the ConCommandBase allocations per-plugin.

=Renamings/Removals=
*<tt>VENGINE_CVAR_INTERFACE_VERSION</tt> was renamed to <tt>CVAR_INTERFACE_VERSION</tt>.
*<tt>FCVAR_PLUGIN</tt> was removed. It is probably no longer needed with the advent of <tt>ConVar_Unregister</tt>.

=Sample Port=
An example of a plugin that fully supports both versions is [http://www.bailopan.net/stripper Stripper:Source] ([http://svn.alliedmods.net/viewvc.cgi/sourcemm/stripper/?root=dvander SVN here]).

Note that this plugin uses the new "extended loading" API available in Metamod:Source 1.6.0. The thin-loader library runs on any Metamod:Source version, and will correctly pick one of 6 child plugins to load. This allows Stripper:Source to be distributed as one package with no configuration hassle.

[[Category:Metamod:Source Development]]

User:C0ldfyr3

2006-01-31T13:10:13Z

C0ldfyr3: /* Latest Links */

== About c0ldfyr3 ==
Regular joe, hobbiest at the best of times.

== Current Projects ==
*[http://www.c0ld.net/GoreMod/ GoreMod]
*[http://www.c0ld.net ProjectX]
*[http://www.c0ld.net/SprayMod SprayMod]

== Accomplishments ==
* www.EliteProdigy.com 2,000,000 uniques in two years.
* First program I ever wrote was downloaded over 500,000 times from my server alone.
* Was the king of Yahoo! for the entire duration.

== Latest Links ==
*[http://www.LobItInThereBoss.com LobItInThereBoss.com - A place for me and my friends.]

== Home Page ==
*[http://www.c0ld.net c0ld.net]

User:C0ldfyr3

2006-01-31T13:09:29Z

C0ldfyr3:

== About c0ldfyr3 ==
Regular joe, hobbiest at the best of times.

== Current Projects ==
*[http://www.c0ld.net/GoreMod/ GoreMod]
*[http://www.c0ld.net ProjectX]
*[http://www.c0ld.net/SprayMod SprayMod]

== Accomplishments ==
* www.EliteProdigy.com 2,000,000 uniques in two years.
* First program I ever wrote was downloaded over 500,000 times from my server alone.
* Was the king of Yahoo! for the entire duration.

== Latest Links ==
*NONE

== Home Page ==
*[http://www.c0ld.net c0ld.net]

User:C0ldfyr3

2006-01-31T13:08:10Z

C0ldfyr3:

Cross Compiling Plugins (Metamod:Source)

2006-01-23T23:12:29Z

C0ldfyr3: /* Installing Cygwin */

==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-23T23:11:02Z

C0ldfyr3: /* 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.

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)]]

Gabe Newell

2006-01-15T20:42:22Z

C0ldfyr3:

{{Gaben|C’mon, people, you can’t show the player a really big bomb and not let them blow it up.|Half-Life 1}}

{{Gaben|Yes.|turning into cows when eating grass}}

{{Gaben|this extents the original player_death by a new fields|Counter-Strike:Source modevents.res}}