Sample Plugins (Metamod:Source) - Revision history

LumiStance: /* Linux */

2012-07-07T00:31:33Z

‎Linux

BAILOPAN at 07:57, 26 November 2008

2008-11-26T07:57:23Z

Dave Gomboc: typo fix

2008-08-20T19:38:21Z

typo fix

Dave Gomboc: List described as comma-delimited actually uses semi-colons to delimit it, so description changed accordingly.

2008-08-20T19:37:57Z

List described as comma-delimited actually uses semi-colons to delimit it, so description changed accordingly.

BAILOPAN at 18:48, 18 February 2008

2008-02-18T18:48:05Z

BAILOPAN at 18:39, 18 February 2008

2008-02-18T18:39:55Z

BAILOPAN at 17:33, 18 February 2008

2008-02-18T17:33:22Z

BAILOPAN at 17:27, 18 February 2008

2008-02-18T17:27:02Z

BAILOPAN at 13:51, 18 February 2008

2008-02-18T13:51:19Z

BAILOPAN at 13:46, 18 February 2008

2008-02-18T13:46:39Z

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

@@ Line 15: / Line 15: @@
 =The Engine Divide=
 The Orange Box and Episode 1 engines are not compatible, and thus there is a division:
-*Metamod:Source 1.4/Episode 1
+*Metamod:Source 1.4 API, Episode 1 and lower
-*Metamod:Source 1.6/Orange Box
+*Metamod:Source 1.6 API, Orange Box and higher
-Unfortunately, there is a "lag period" where not all games have moved to the new engine.  It is likely that this lag period will continue for at least another twelve months (this writing is as of February 2008).  As such, we are writing all of our plugin code such that it compiles against both platforms.  '''It is your choice whether to do this as well.''' As the usage of Metamod:Source 1.4 and the original engine decays, we will begin removing the legacy cruft from the sample plugins.  That probably won't happen until Valve has a stable port of CS:S to Orange Box.
+This is explained more in [[MM:S API Differences]].
-As such, you will notice various idiosyncracies in the sample plugins.  For example, <tt>METAMOD_PLAPI_VERSION</tt> exists in Metamod:Source 1.6 or later, so it is used to decide between <tt>GetEngineFactory</tt> (1.6) or <tt>engineFactory</tt> (1.4).  Similarly, the sample plugins use two macros:
+As such, you will notice various idiosyncrasies in the sample plugins.  For example, <tt>METAMOD_PLAPI_VERSION</tt> exists in Metamod:Source 1.6 or later, so it is used to decide between <tt>GetEngineFactory</tt> (1.6) or <tt>engineFactory</tt> (1.4).  Similarly, the sample plugins use two macros:
 *<tt>ENGINE_ORANGEBOX</tt> - Orange Box build
 *<tt>ENGINE_ORIGINAL</tt> - Original/Episode 1 build
@@ Line 27: / Line 27: @@
 For more information, see:
-*[[Upgrading Plugins to Metamod:Source 1.6.0]]
+*[[MM:S API Differences]]
 *[[Porting to Orange Box]]
@@ Line 34: / Line 35: @@
 ==Windows==
-Both plugins have a Visual Studio 2005 project file in their <tt>msvc8</tt> folders.  Each plugin has four build modes:
+Both plugins have a Visual Studio 2008 project file in their <tt>msvc9</tt> folders.  Each plugin has six build modes:
-*<tt>Release - Orange Box</tt> - Release mode, Orange Box, MM:S 1.6
+*<tt>Release - Left 4 Dead</tt> - Release mode, Left 4 Dead
-*<tt>Debug - Orange Box</tt> - Debug mode, Orange Box, MM:S 1.6
+*<tt>Debug - Left 4 Dead</tt> - Debug mode, Left 4 Dead
-*<tt>Release - Original</tt> - Release mode, Original/Episode1, MM:S 1.4
+*<tt>Release - Orange Box</tt> - Release mode, Orange Box
-*<tt>Debug - Original</tt> - Debug mode, Original/Episode1, MM:S 1.4
+*<tt>Debug - Orange Box</tt> - Debug mode, Orange Box
 There exists normal "Release" and "Debug" build modes -- you should not use them, as they are not configured.
@@ Line 44: / Line 47: @@
 ==Linux==
 On Linux, you cannot simply type "make" in the folder containing the <tt>Makefile</tt>.  You must specify a combination of parameters:
-*<tt>ENGINE</tt> - Required.  Must be either "orangebox" or "original".
+*<tt>ENGINE</tt> - Required.  Must be either "orangebox" or "original" or "left4dead".
 *<tt>DEBUG</tt> - Optional.  Can be empty (Release mode) or "true" (Debug mode).
 Binaries and object files will be written to one of the following folders:
 *<tt>Release.orangebox</tt>
 *<tt>Debug.orangebox</tt>
@@ Line 55: / Line 61: @@
 Examples of building one of the example plugins:
 <pre>
-#MM:S 1.4/Episode 1, debug mode
+#Episode 1, debug mode
 make DEBUG=true ENGINE=original
-#MM:S 1.6/Orange Box, release mode
+#Orange Box, release mode
 make ENGINE=orangebox
-#Cleaning the MM:S 1.4 build
+#Cleaning the Episode 1 build
 make clean ENGINE=original
 </pre>
@@ Line 103: / Line 109: @@
 Some of the sample functionality requires an IServerPluginCallbacks pointer, and Metamod:Source can provide one for you.
-In Metamod:Source 1.4, you had to implement <tt>IMetamodListener</tt>, and do something like this:
+In the Metamod:Source 1.4 API, you had to implement <tt>IMetamodListener</tt>, and do something like this:
 <pre>
 		ismm->AddListener(this, this);

@@ Line 172: / Line 172: @@
 You can edit the output binary name under the Linker options in the Project Properties dialog.
-You should not add global include folders in order to compile.  Set up your [[Metamod:Source Environment]] and, if you need more include folders, add them to the "Additional Include Directories" option under the C++ options in the Project Properties dialog.  It is a seimcolon-delimited list, for example: <tt>$(SOURCEMM14);$(HL2SDK)\public</tt>.
+You should not add global include folders in order to compile.  Set up your [[Metamod:Source Environment]] and, if you need more include folders, add them to the "Additional Include Directories" option under the C++ options in the Project Properties dialog.  It is a semicolon-delimited list, for example: <tt>$(SOURCEMM14);$(HL2SDK)\public</tt>.
 For the most part, editing a Visual Studio project is otherwise self-explanatory.  See [[Metamod:Source Development#Compiling]] for more information on required "project-from-scratch" options.
 [[Category:Metamod:Source Development]]

@@ Line 172: / Line 172: @@
 You can edit the output binary name under the Linker options in the Project Properties dialog.
-You should not add global include folders in order to compile.  Set up your [[Metamod:Source Environment]] and, if you need more include folders, add them to the "Additional Include Directories" option under the C++ options in the Project Properties dialog.  It is a comma-delimited list, for example: <tt>$(SOURCEMM14);$(HL2SDK)\public</tt>.
+You should not add global include folders in order to compile.  Set up your [[Metamod:Source Environment]] and, if you need more include folders, add them to the "Additional Include Directories" option under the C++ options in the Project Properties dialog.  It is a seimcolon-delimited list, for example: <tt>$(SOURCEMM14);$(HL2SDK)\public</tt>.
 For the most part, editing a Visual Studio project is otherwise self-explanatory.  See [[Metamod:Source Development#Compiling]] for more information on required "project-from-scratch" options.
 [[Category:Metamod:Source Development]]

@@ Line 162: / Line 162: @@
 *<tt>LINK</tt> - Extra link options.
 *<tt>INCLUDE</tt> - Extra include options (don't forget that you need -I to each item).
 For more information on flags and distribution, see [[Metamod:Source Development#Compiling]].
 [[Category:Metamod:Source Development]]

@@ Line 144: / Line 144: @@
 **<tt>addons/NAME/bin/NAME_mm.dll</tt> or <tt>addons/NAME/bin/NAME_mm_i486.so</tt>.  For example, <tt>addons/sourcemod/bin/sourcemod_mm</tt> is [[SourceMod]]'s VDF path, since it has a large directory structure.
 **''Note: This convention is not required, but it is recommended.''
 [[Category:Metamod:Source Development]]

← Older revision		Revision as of 17:33, 18 February 2008
Line 2:		Line 2:

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

	=Introduction=		=Introduction=

@@ Line 75: / Line 75: @@
 The full sample plugin is a bit more complicated, as it contains some of the examples from Valve's <tt>serverplugin_sample</tt>.  It also may be a bit messy to read because of the engine compatibility wrappers in it.
 The first file of importance is <tt>engine_wrappers.h</tt>, which is full of compatibility shims.  For example:
 *<tt>engineFactory</tt> became <tt>GetEngineFactory</tt> from 1.4 to 1.6
@@ Line 83: / Line 84: @@
 Also note the <tt>CCommand</tt> class.  This is a wrapper around the <tt>IVEngineServer::Cmd_Arg*</tt> functions, which were removed in Orange Box.  Valve replaced it with a newer, more re-entrant set of functions based around <tt>CCommand</tt>.  Rather than create two codebases, we've simply wrapped the old functions in the new API.  The functionality isn't ''exactly'' the same (becaose of re-entrancy), but it works nicely for our purposes.  You can read more about this trick in [[Porting to Orange Box]].

← Older revision		Revision as of 13:51, 18 February 2008
Line 85:		Line 85:


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

	[[Category:Metamod:Source Development]]		[[Category:Metamod:Source Development]]

@@ Line 23: / Line 23: @@
 These two macros are used in a few places to toggle functionality compatible for the given build.
@@ Line 67: / Line 71: @@
 Note that for the most part, <tt>stub_mm</tt> is free of compatibility cruft, whereas <tt>sample_mm</tt> tries to abstract more.  This is so <tt>stub_mm</tt> doesn't appear to be "hiding" anything -- it's laid out very simply.
 [[Category:Metamod:Source Development]]