doc/html/release_notes.html
author bailopan
Tue Jul 12 22:43:16 2005 +0000 (2005-07-12)
branchB-work
changeset 132 eab0aebcdbf2
parent 0 d15304fcb7a7
child 144 8f8565e045a0
permissions -rw-r--r--
Updated documentation
     1 <!-- vi: set ts=4 sw=4 : -->
     2 <!-- vim: set tw=75 : -->
     3 
     4 <HTML>
     5 <head>
     6 <title>Metamod Release Notes</title>
     7 </head>
     8 <body>
     9 
    10 <h1>Release Notes
    11 </h1>
    12 
    13 <a name=major.1.18>
    14 <h2>Major changes with Metamod 1.18
    15 </h2></a>
    16 
    17 <ul>
    18 
    19 <p><li>New API version, with three new API functions for loading and
    20 unloading plugins from other plugins.
    21 
    22 <p><li>Console command "meta version" shows the plugin interface version.
    23 
    24 </ul>
    25 
    26 <hr>
    27 
    28 <a name=major.1.17>
    29 <h2>Major changes with Metamod 1.17
    30 </h2></a>
    31 
    32 <ul>
    33 
    34 <p><li> New cvar "<b><tt>metamod_version</tt></b>" that can be queried from
    35 client game browsers.
    36 
    37 <p><li> New console commands available to clients (much like the existing
    38 server console commands):
    39 
    40 	<p><ul>
    41 	<li> <b><tt>"meta version"</tt></b> prints out version information
    42 	(date, compile type, etc).
    43 	<li> <b><tt>"meta list"</tt></b> shows a list of the plugins running on 
    44 	the server (name, author, version, etc).
    45 	</ul>
    46 
    47 <p><li> New file <a
    48 href="metamod.html#config.ini"><tt><b>config.ini</b></tt></a> to provide a
    49 more reliable and flexible method of specifying configuration options.
    50 At the moment, the recognized options mirror those from <a
    51 href="metamod.html#localinfo">+localinfo</a>, ie:
    52 
    53 	<p>
    54 	<ul>
    55 	<li> <tt><b>debuglevel</b> <i>&lt;number&gt;</i></tt>
    56 	<li> <tt><b>gamedll</b> <i>&lt;path&gt;</i></tt>
    57 	<li> <tt><b>plugins_file</b> <i>&lt;path&gt;</i></tt>
    58 	<li> <tt><b>exec_cfg</b> <i>&lt;path&gt;</i></tt>
    59 	</ul>
    60 
    61 <p>Default path is "<tt>addons/metamod/config.ini</tt>" but can be
    62 overridden with "<tt>+localinfo mm_configfile</tt>".
    63 
    64 <p>Also, new console command <tt><b>"meta config"</b></tt> to display this
    65 information.
    66 
    67 <p><li> New console command <tt><b>"meta require"</b></tt> to force the
    68 server to exit if the specified plugin isn't loaded/running.  Intended for
    69 use in server.cfg or metaexec.cfg, to keep the server from starting up if
    70 desired plugins don't load.  For example:
    71 
    72 	<p>
    73 	<ul>
    74 	<li> <tt>meta require adminmod</tt>
    75 	<li> <tt>meta require 1</tt>
    76 	</ul>
    77 
    78 <p>The former requires that a plugin with the substring "adminmod" is found
    79 loaded and running.  The latter requires that the plugin in slot 1 is
    80 loaded and running.
    81 
    82 <p><li> If an override gamedll is specified and found to be invalid or
    83 missing, Metamod will now exit with an appropriate error message, rather
    84 than just falling back to the auto-detected gamedll.  This should provide
    85 more immediate and useful feedback, and help prevent some confusion.
    86 
    87 </ul>
    88 
    89 <p>
    90 <hr>
    91 
    92 <a name=compat.1.13>
    93 <h2>Incompatible changes with Metamod 1.13
    94 </h2></a>
    95 
    96 <ul>
    97 
    98 <li> Config file <tt><b>metagame.ini</b></tt> is no longer supported.  This
    99 file was deprecated in Metamod 1.08 (2001/06/16).  Use instead the "<a
   100 href="metamod.html#localinfo">+localinfo mm_gamedll</a>" option.
   101 
   102 </ul>
   103 
   104 
   105 <a name=major.1.13>
   106 <h2>Major changes with Metamod 1.13
   107 </h2></a>
   108 
   109 <ul>
   110 
   111 <li> New config file names and locations, per the <a
   112 href="http://www.unitedadmins.com/info_addon_dev_standards.aspx">Addon
   113 Development Standard</a> rev 1.00, developed on the <a
   114 href="http://list.valvesoftware.com/mailman/listinfo/hlds_apps">hlds_apps</a>
   115 list.  
   116 
   117 	<p> Default config file locations are now:
   118 	<ul>
   119 	<li> $gamedir/addons/metamod/plugins.ini
   120 	<li> $gamedir/addons/metamod/exec.cfg
   121 	</ul>
   122 
   123 	<p> Previous config file locations are also supported for backwards
   124 	compability:
   125 
   126 	<ul>
   127 	<li> $gamedir/metamod.ini
   128 	<li> $gamedir/metaexec.cfg
   129 	</ul>
   130 
   131 	<p> Note that the pathnames in plugins.ini are unchanged, and are still
   132 	relative to the gamedir.
   133 
   134 </ul>
   135 
   136 <p>
   137 <hr>
   138 
   139 </body>
   140 </HTML>