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