doc/html/faq.html
author Scott Ehlert <ds@alliedmods.net>
Thu Sep 26 17:00:32 2013 -0500 (2013-09-26)
changeset 284 ca90ccdb8d49
parent 250 1f5fb7d1d9b3
permissions -rw-r--r--
Fixed makefile error when issuing 'make clean' or 'make distclean'.
darope@0
     1
<!-- vi: set ts=4 sw=4 : -->
darope@0
     2
<!-- vim: set tw=75 : -->
darope@0
     3
darope@0
     4
<HTML>
darope@0
     5
<head>
darope@0
     6
<title>Metamod FAQ</title>
darope@0
     7
</head>
darope@0
     8
<body>
darope@0
     9
darope@0
    10
<h1>Metamod FAQ
darope@0
    11
</h1>
darope@0
    12
darope@0
    13
<p><a name=modsupport>
darope@0
    14
<b> Please add support for <i>(some)</i> mod.</b>
darope@0
    15
</a><p> <blockquote>
darope@0
    16
Please see <a href="gamesupport.html#requirements">game support
darope@0
    17
requirements</a> in the documentation.
darope@0
    18
</blockquote>
darope@0
    19
darope@0
    20
darope@0
    21
<p><a name=bots>
darope@0
    22
<b> How do I use bots with Metamod?</b>
darope@0
    23
</a><p> <blockquote>
darope@0
    24
If the bot is <i>not</i> a Metamod plugin, then you will need to tell
darope@0
    25
Metamod to use your bot as the gamedll, by specifying it on the hlds
darope@0
    26
command line with the "+localinfo mm_gamedll" option.  See the 
darope@0
    27
<a href="metamod.html#localinfo">Metamod docs</a>.  See also the 
darope@0
    28
<a href="http://www.adminmod.org/help/online/Configuration/How_to_Use_Bots_with_MetaMod_AM_2.50_and_up.htm">AdminMod docs</a>.
darope@0
    29
</blockquote>
darope@0
    30
darope@0
    31
darope@0
    32
<p><a name=corrupt>
darope@0
    33
<b> The download links give corrupt files.</b>
darope@0
    34
</a><p> <blockquote>
darope@0
    35
I think what you're observing is that your web client is quietly
darope@0
    36
uncompressing the file, but not updating the name of the downloaded file to
darope@0
    37
reflect this.  In particular, some web clients will silently decompress
darope@0
    38
(gunzip) files _without_ removing the ".gz" from the filename, so you'll
darope@0
    39
end up with a file "metamod_i386.so.gz" which is _really_
darope@0
    40
"metamod_i386.so", and so trying to gunzip it will produce an error ("not
darope@0
    41
in gzip format").  Try running "file" on the resulting file to see what the
darope@0
    42
OS thinks it is.  Or, where you don't have "file" (ie windows), just look
darope@0
    43
at the file size - it should be pretty indicative of whether the file is
darope@0
    44
still compressed or not.
darope@0
    45
</blockquote>
darope@0
    46
darope@0
    47
darope@0
    48
<p><a name=install>
darope@0
    49
<b> How do I install Metamod?</b>
darope@0
    50
</a><p> <blockquote>
darope@0
    51
This is covered briefly in the <a href="metamod.html#installation">Metamod
darope@0
    52
docs</a>.  Typically, though, Metamod is installed as part of some major
darope@0
    53
plugin, like <a href="http://www.adminmod.org/">AdminMod</a>.  There is
darope@0
    54
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
darope@0
    55
to update it, this requires only replacing the .so/.dll with the latest
darope@0
    56
version from the <a href="http://metamod.org/">webpage</a>.
darope@0
    57
</blockquote>
darope@0
    58
darope@0
    59
darope@0
    60
<p><a name=adminmod>
darope@0
    61
<b> I'm having trouble with AdminMod.</b>
darope@0
    62
</a><p> <blockquote>
darope@0
    63
You'll need to ask your AdminMod questions on the <a href="http://www.ozforums.com/forumdisplay.php?forumid=143">AdminMod forums</a>.
darope@0
    64
</blockquote>
darope@0
    65
darope@0
    66
darope@0
    67
<p><a name=hlcoding>
darope@0
    68
<b> How do I do <i>(something)</i> in a Metamod plugin?</b>
darope@0
    69
</a><p> <blockquote>
darope@0
    70
Generally speaking, a Metamod plugin works very much like an Half-Life Game
darope@0
    71
Mod, since all it's doing is making the same calls to the same SDK that the
darope@0
    72
Game Mod does.  So, the question typically isn't "how do I do this in
darope@0
    73
Metamod?" but instead "how do I do this in an Half-Life Mod?", and is best
darope@0
    74
asked in a HL SDK Programming forum/mailinglist (see <a href="links.html">related links</a> 
darope@0
    75
and especially <a href="http://planethalflife.com/botman/MOD_FAQ.shtml">Botman's MOD FAQ</a>).  
darope@0
    76
Once you figure out how it would normally be done in a Game Mod, figuring
darope@0
    77
out how to do it in Metamod is relatively straightforward.  
darope@0
    78
<p>
darope@0
    79
However, if you have questions on how to convert a piece of code from HLmod
darope@0
    80
to Metamod plugin, then I can provide some pointers, or you can ask on the
darope@0
    81
<a href="http://groups.yahoo.com/group/metamod/">Metamod mailing list</a>.
darope@0
    82
And of course, if you have questions about things in the code specific to
darope@0
    83
Metamod (ie things mentioned in the <a href="coding.html">Metamod Coding
darope@0
    84
docs</a>) feel free to ask me or on the mailing list.
darope@0
    85
</blockquote>
darope@0
    86
darope@0
    87
darope@0
    88
<p><a name=examples>
darope@0
    89
<b> Is there a tutorial or example of how to write a Metamod plugin?</b>
darope@0
    90
</a><p> <blockquote>
darope@0
    91
The sourcecode includes a couple of plugins that can be used as examples.
darope@0
    92
The "stub" plugin is the bare basics of what a plugin needs.  The "trace"
darope@0
    93
plugin provides an example of hooking _every_ SDK function.  The "wdmisc"
darope@0
    94
plugin provides a couple of basic useful features.  You can also look at
darope@0
    95
several of the other plugins out there for more examples.
darope@0
    96
<p>
darope@0
    97
Note that the example plugins in the Metamod sourcecode show how to use
darope@0
    98
Metamod to interface with Half-Life code, but they mostly assume you
darope@0
    99
already know how to write Half-Life code.  If you need examples or info on
darope@0
   100
how to write Half-Life code itself, you'll need to go look through the HL
darope@0
   101
SDK programming websites (see <a href="links.html">related links</a>
darope@0
   102
and <a href="http://planethalflife.com/botman/MOD_FAQ.shtml">Botman's MOD FAQ</a>).  
darope@0
   103
</blockquote>
darope@0
   104
darope@0
   105
darope@0
   106
<p><a name=pluginlink>
darope@0
   107
<b> I have (or know of) a Metamod plugin not listed on the webpage.</b>
darope@0
   108
</a><p> <blockquote>
darope@0
   109
Send me the information about the plugin (name, author, description, URL),
darope@0
   110
and I'd be happy to provide a link from the webpage.
darope@0
   111
</blockquote>
darope@0
   112
darope@0
   113
darope@0
   114
<p><a name=msvc>
darope@0
   115
<b> I'm having trouble compiling under MSVC.</b>
darope@0
   116
</a><p> <blockquote>
darope@0
   117
Please note that I do not use MSVC, so I can't help a lot with using that
darope@0
   118
compiler.  I do all my development under linux, using gcc for linux
darope@0
   119
binaries and <a href="http://www.mingw.org/">mingw32</a> for windows
darope@0
   120
binaries.  The sourcecode does include an MSVC project file for Metamod, as
darope@0
   121
well as a project file for the stub plugin, both mostly as examples.  They
darope@0
   122
<i>should</i> work, and indeed did work the last time I dug up MSVC to test
darope@0
   123
them.  That said, there are a few folks on the <a href="http://groups.yahoo.com/group/metamod/">Metamod mailing list</a> that
darope@0
   124
do use MSVC, so you might find some assistance there.
darope@0
   125
</blockquote>
darope@0
   126
darope@0
   127
darope@0
   128
<p><a name=gpl>
darope@0
   129
<b> If I create a Metamod plugin, does it have to be open source?</b>
darope@0
   130
</a><p> <blockquote>
darope@0
   131
Generally speaking, yes.  The way the GPL is interpreted, plugins of a GPL
darope@0
   132
program need to be also GPL.  See also the FAQ entry on the GNU site about
darope@0
   133
<a href="http://www.gnu.org/licenses/gpl-faq.html#GPLAndPlugins">plugins of a GPL program</a>.
darope@0
   134
</blockquote>
darope@0
   135
darope@0
   136
darope@250
   137
<p><a name=hl2>
darope@250
   138
<b> Does Metamod work with Half-Life 2 (Source engine)?</b>
darope@250
   139
</a><p> <blockquote>
darope@250
   140
HL2 includes its own <a href="http://www.valve-erc.com/srcsdk/Code/ServerPlugins.html">
darope@250
   141
built-in functionality</a> for loading and managing server plugins.
darope@250
   142
<p>
darope@250
   143
Also, see <a href="http://www.sourcemm.net/">SourceMM (aka Metamod:Source)</a>, 
darope@250
   144
which is a seperate project that was derived from Metamod but was written new from
darope@250
   145
scratch.
darope@250
   146
</blockquote>
darope@250
   147
darope@250
   148
darope@250
   149
darope@0
   150
<p><a name=otherengines>
darope@0
   151
<b> How about a port of Metamod to other engines like Q3, Unreal, etc?</b>
darope@0
   152
</a><p> <blockquote>
darope@0
   153
I haven't looked into it myself, but several folks on the AdminMod team
darope@0
   154
(from which Metamod was derived) had looked at porting to other games like
darope@0
   155
Q3 and UT, and determined that those engines either didn't provide the
darope@0
   156
necessary API hooks, or that they already provided a suitable method for  
darope@0
   157
extending functionality.  So, I wouldn't expect to see a version of Metamod
darope@0
   158
for those.  Perhaps for some other future engines, although I believe most
darope@0
   159
modern engines are now providing their own method for extensions or
darope@0
   160
plugins, so that a third-party solution like Metamod wouldn't be necessary.
darope@0
   161
</blockquote>
darope@0
   162
darope@0
   163
<p>
darope@0
   164
<hr>
darope@0
   165
darope@0
   166
</body>
darope@0
   167
</HTML>