update_tool/README.txt
author David Anderson <dvander@alliedmods.net>
Thu Sep 27 19:28:05 2007 +0000 (2007-09-27)
branchsourcemm-1.6.0
changeset 356 bbcf8dcb2aa7
parent 347 e82968c21606
permissions -rw-r--r--
removed unnecessary api call
     1 This is the README file for sourcemm_update_tool.
     2 
     3 This tool will automatically correct gameinfo.txt when your server gets updated, and Valve's updater overwrites Metamod:Source's changes.  This tool is experimental, and is thus a separate download for now.
     4 
     5 1.  INSTALLATION
     6 
     7  a.  Extract the entire package to your mod folder.  The structure should look like:
     8 
     9 	<mod>/addons/metamod/bin/sourcemm_update_tool.dll
    10 	<mod>/addons/metamod/bin/sourcemm_update_tool_i486.so
    11 	<mod>/addons/metamod/README.txt
    12 	<mod>/addons/sourcemm_update_tool.vdf
    13 	<mod>/sourcemm_updater.conf
    14 
    15  b.  Open <mod>/sourcemm_updater.conf with your favorite text editor.  Change the
    16      "cstrike" folder to match your mod folder.  
    17 
    18 2.  CONFIGURATION
    19 
    20    The sourcemm_updater.conf file has two configuration options.  
    21 
    22    mmpath     - Set this to the path Metamod:Source is located in.
    23                 This defaults to addons/metamod/bin
    24    restart    - Set this to how the server should be restarted when 
    25                 gameinfo.txt is patched.  There are three options:
    26 
    27                 quit  - Execute "quit" in the console.  Currently does not work.
    28                 never - Do not restart.
    29                 error - Generate an error message.  Because of a bug in SourceDS,
    30                         this will generate a crash dump on Windows, but the server
    31                         will successfully quit.
    32 
    33 3.  USAGE
    34 
    35    You do not need to do anything to use the updater tool.  When your server starts,
    36  it silently checks to see if Metamod:Source is loaded.  If not, it will make sure
    37  gameinfo.txt is correctly set.  Then, depending on how it's configured, it will 
    38  kill the server.  Most game server provides have auto-restart functionality on their
    39  servers; if not, you will need to manually restart the server.
    40 
    41    The update tool unloads itself immediately after the server starts, so it will not
    42  use any resources, and will not display when you type 'plugin_print'.  
    43 
    44 4.  TROUBLESHOOTING
    45 
    46    This tool is currently experimental.  There are two possible problems.  For 
    47    any issue you encounter, you should post a report here:
    48 
    49    http://bugs.alliedmods.net/index.php?project=4
    50 
    51   a.  The updater tool does not patch gameinfo.txt
    52 
    53       Verify that the tool is loading.  You can do this by opening up the 
    54       sourcemm_update_tool.vdf file and copying its file path.  Then, enter
    55       the following command in your server console:
    56 
    57        plugin_load <path>
    58 
    59       Example:
    60 
    61        plugin_load cstrike\addons\metamod\bin\sourcemm_update_tool
    62 
    63       If you get the following reply:
    64 
    65        Failed to load plugin "cstrike\addons\sourcemm_update_tool"
    66        Unable to load plugin "cstrike\addons\sourcemm_update_tool"
    67 
    68       Then the tool is working, and you should post a bug report.  If instead, 
    69       you get:
    70 
    71        Unable to load plugin "cstrike\addons\sourcemm_update_tool"
    72        Unable to load plugin "cstrike\addons\sourcemm_update_tool"
    73 
    74       Then the tool is not loading properly, and the path you are trying to use
    75       is not correct.
    76 
    77   b.  The server always dies, and you can't start it at all
    78 
    79       The updater tool is either crashing or not repairing Metamod:Source 
    80       correctly.  First, try changing the 'restart' line in sourcemm_updater.conf
    81       to the following line:
    82 
    83 	restart = never
    84 
    85       If that does not fix the problem, remove the .vdf file so the updater tool
    86       will not be loaded.  
    87 
    88       In either case, you should post a bug report containing your mod name and
    89       your gameinfo.txt as an attachment.
    90