1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/doc/html/faq.html Tue Apr 06 07:36:14 2004 +0000
1.3 @@ -0,0 +1,158 @@
1.4 +<!-- vi: set ts=4 sw=4 : -->
1.5 +<!-- vim: set tw=75 : -->
1.6 +
1.7 +<HTML>
1.8 +<head>
1.9 +<title>Metamod FAQ</title>
1.10 +</head>
1.11 +<body>
1.12 +
1.13 +<h1>Metamod FAQ
1.14 +</h1>
1.15 +
1.16 +<p><a name=modsupport>
1.17 +<b> Please add support for <i>(some)</i> mod.</b>
1.18 +</a><p> <blockquote>
1.19 +Please see <a href="gamesupport.html#requirements">game support
1.20 +requirements</a> in the documentation.
1.21 +</blockquote>
1.22 +
1.23 +
1.24 +<p><a name=bots>
1.25 +<b> How do I use bots with Metamod?</b>
1.26 +</a><p> <blockquote>
1.27 +If the bot is <i>not</i> a Metamod plugin, then you will need to tell
1.28 +Metamod to use your bot as the gamedll, by specifying it on the hlds
1.29 +command line with the "+localinfo mm_gamedll" option. See the
1.30 +<a href="metamod.html#localinfo">Metamod docs</a>. See also the
1.31 +<a href="http://www.adminmod.org/help/online/Configuration/How_to_Use_Bots_with_MetaMod_AM_2.50_and_up.htm">AdminMod docs</a>.
1.32 +</blockquote>
1.33 +
1.34 +
1.35 +<p><a name=corrupt>
1.36 +<b> The download links give corrupt files.</b>
1.37 +</a><p> <blockquote>
1.38 +I think what you're observing is that your web client is quietly
1.39 +uncompressing the file, but not updating the name of the downloaded file to
1.40 +reflect this. In particular, some web clients will silently decompress
1.41 +(gunzip) files _without_ removing the ".gz" from the filename, so you'll
1.42 +end up with a file "metamod_i386.so.gz" which is _really_
1.43 +"metamod_i386.so", and so trying to gunzip it will produce an error ("not
1.44 +in gzip format"). Try running "file" on the resulting file to see what the
1.45 +OS thinks it is. Or, where you don't have "file" (ie windows), just look
1.46 +at the file size - it should be pretty indicative of whether the file is
1.47 +still compressed or not.
1.48 +</blockquote>
1.49 +
1.50 +
1.51 +<p><a name=install>
1.52 +<b> How do I install Metamod?</b>
1.53 +</a><p> <blockquote>
1.54 +This is covered briefly in the <a href="metamod.html#installation">Metamod
1.55 +docs</a>. Typically, though, Metamod is installed as part of some major
1.56 +plugin, like <a href="http://www.adminmod.org/">AdminMod</a>. There is
1.57 +also some discussion of installing Metamod by hand in the <a href="http://www.adminmod.org/help/online/Installing/Manual_Installation_-_Walk-Through.htm">AdminMod docs</a>. If you already have Metamod installed and merely want
1.58 +to update it, this requires only replacing the .so/.dll with the latest
1.59 +version from the <a href="http://metamod.org/">webpage</a>.
1.60 +</blockquote>
1.61 +
1.62 +
1.63 +<p><a name=adminmod>
1.64 +<b> I'm having trouble with AdminMod.</b>
1.65 +</a><p> <blockquote>
1.66 +You'll need to ask your AdminMod questions on the <a href="http://www.ozforums.com/forumdisplay.php?forumid=143">AdminMod forums</a>.
1.67 +</blockquote>
1.68 +
1.69 +
1.70 +<p><a name=hlcoding>
1.71 +<b> How do I do <i>(something)</i> in a Metamod plugin?</b>
1.72 +</a><p> <blockquote>
1.73 +Generally speaking, a Metamod plugin works very much like an Half-Life Game
1.74 +Mod, since all it's doing is making the same calls to the same SDK that the
1.75 +Game Mod does. So, the question typically isn't "how do I do this in
1.76 +Metamod?" but instead "how do I do this in an Half-Life Mod?", and is best
1.77 +asked in a HL SDK Programming forum/mailinglist (see <a href="links.html">related links</a>
1.78 +and especially <a href="http://planethalflife.com/botman/MOD_FAQ.shtml">Botman's MOD FAQ</a>).
1.79 +Once you figure out how it would normally be done in a Game Mod, figuring
1.80 +out how to do it in Metamod is relatively straightforward.
1.81 +<p>
1.82 +However, if you have questions on how to convert a piece of code from HLmod
1.83 +to Metamod plugin, then I can provide some pointers, or you can ask on the
1.84 +<a href="http://groups.yahoo.com/group/metamod/">Metamod mailing list</a>.
1.85 +And of course, if you have questions about things in the code specific to
1.86 +Metamod (ie things mentioned in the <a href="coding.html">Metamod Coding
1.87 +docs</a>) feel free to ask me or on the mailing list.
1.88 +</blockquote>
1.89 +
1.90 +
1.91 +<p><a name=examples>
1.92 +<b> Is there a tutorial or example of how to write a Metamod plugin?</b>
1.93 +</a><p> <blockquote>
1.94 +The sourcecode includes a couple of plugins that can be used as examples.
1.95 +The "stub" plugin is the bare basics of what a plugin needs. The "trace"
1.96 +plugin provides an example of hooking _every_ SDK function. The "wdmisc"
1.97 +plugin provides a couple of basic useful features. You can also look at
1.98 +several of the other plugins out there for more examples.
1.99 +<p>
1.100 +Note that the example plugins in the Metamod sourcecode show how to use
1.101 +Metamod to interface with Half-Life code, but they mostly assume you
1.102 +already know how to write Half-Life code. If you need examples or info on
1.103 +how to write Half-Life code itself, you'll need to go look through the HL
1.104 +SDK programming websites (see <a href="links.html">related links</a>
1.105 +and <a href="http://planethalflife.com/botman/MOD_FAQ.shtml">Botman's MOD FAQ</a>).
1.106 +</blockquote>
1.107 +
1.108 +
1.109 +<p><a name=pluginlink>
1.110 +<b> I have (or know of) a Metamod plugin not listed on the webpage.</b>
1.111 +</a><p> <blockquote>
1.112 +Send me the information about the plugin (name, author, description, URL),
1.113 +and I'd be happy to provide a link from the webpage.
1.114 +</blockquote>
1.115 +
1.116 +
1.117 +<p><a name=msvc>
1.118 +<b> I'm having trouble compiling under MSVC.</b>
1.119 +</a><p> <blockquote>
1.120 +Please note that I do not use MSVC, so I can't help a lot with using that
1.121 +compiler. I do all my development under linux, using gcc for linux
1.122 +binaries and <a href="http://www.mingw.org/">mingw32</a> for windows
1.123 +binaries. The sourcecode does include an MSVC project file for Metamod, as
1.124 +well as a project file for the stub plugin, both mostly as examples. They
1.125 +<i>should</i> work, and indeed did work the last time I dug up MSVC to test
1.126 +them. That said, there are a few folks on the <a href="http://groups.yahoo.com/group/metamod/">Metamod mailing list</a> that
1.127 +do use MSVC, so you might find some assistance there.
1.128 +</blockquote>
1.129 +
1.130 +
1.131 +<p><a name=gpl>
1.132 +<b> If I create a Metamod plugin, does it have to be open source?</b>
1.133 +</a><p> <blockquote>
1.134 +Generally speaking, yes. The way the GPL is interpreted, plugins of a GPL
1.135 +program need to be also GPL. See also the FAQ entry on the GNU site about
1.136 +<a href="http://www.gnu.org/licenses/gpl-faq.html#GPLAndPlugins">plugins of a GPL program</a>.
1.137 +</blockquote>
1.138 +
1.139 +
1.140 +<p><a name=otherengines>
1.141 +<b> How about a port of Metamod to other engines like Q3, Unreal, etc?</b>
1.142 +</a><p> <blockquote>
1.143 +I haven't looked into it myself, but several folks on the AdminMod team
1.144 +(from which Metamod was derived) had looked at porting to other games like
1.145 +Q3 and UT, and determined that those engines either didn't provide the
1.146 +necessary API hooks, or that they already provided a suitable method for
1.147 +extending functionality. So, I wouldn't expect to see a version of Metamod
1.148 +for those. Perhaps for some other future engines, although I believe most
1.149 +modern engines are now providing their own method for extensions or
1.150 +plugins, so that a third-party solution like Metamod wouldn't be necessary.
1.151 +<p>
1.152 +If Half-Life 2 ever sees the light of day, I expect I'd look seriously at
1.153 +porting to that - unless, of course, Valve ends up providing their
1.154 +<b>own</b> plugin framework themselves. :)
1.155 +</blockquote>
1.156 +
1.157 +<p>
1.158 +<hr>
1.159 +
1.160 +</body>
1.161 +</HTML>