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