update_tool/README.txt
branchsourcemm-1.6.0
changeset 428 40a9d2f61121
parent 370 4dc28ab1c722
child 429 cadecde4b802
     1.1 --- a/update_tool/README.txt	Thu Oct 04 19:46:28 2007 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,90 +0,0 @@
     1.4 -This is the README file for sourcemm_update_tool.
     1.5 -
     1.6 -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.
     1.7 -
     1.8 -1.  INSTALLATION
     1.9 -
    1.10 - a.  Extract the entire package to your mod folder.  The structure should look like:
    1.11 -
    1.12 -	<mod>/addons/metamod/bin/sourcemm_update_tool.dll
    1.13 -	<mod>/addons/metamod/bin/sourcemm_update_tool_i486.so
    1.14 -	<mod>/addons/metamod/README.txt
    1.15 -	<mod>/addons/sourcemm_update_tool.vdf
    1.16 -	<mod>/sourcemm_updater.conf
    1.17 -
    1.18 - b.  Open <mod>/sourcemm_updater.conf with your favorite text editor.  Change the
    1.19 -     "cstrike" folder to match your mod folder.  
    1.20 -
    1.21 -2.  CONFIGURATION
    1.22 -
    1.23 -   The sourcemm_updater.conf file has two configuration options.  
    1.24 -
    1.25 -   mmpath     - Set this to the path Metamod:Source is located in.
    1.26 -                This defaults to addons/metamod/bin
    1.27 -   restart    - Set this to how the server should be restarted when 
    1.28 -                gameinfo.txt is patched.  There are three options:
    1.29 -
    1.30 -                quit  - Execute "quit" in the console.  Currently does not work.
    1.31 -                never - Do not restart.
    1.32 -                error - Generate an error message.  Because of a bug in SourceDS,
    1.33 -                        this will generate a crash dump on Windows, but the server
    1.34 -                        will successfully quit.
    1.35 -
    1.36 -3.  USAGE
    1.37 -
    1.38 -   You do not need to do anything to use the updater tool.  When your server starts,
    1.39 - it silently checks to see if Metamod:Source is loaded.  If not, it will make sure
    1.40 - gameinfo.txt is correctly set.  Then, depending on how it's configured, it will 
    1.41 - kill the server.  Most game server provides have auto-restart functionality on their
    1.42 - servers; if not, you will need to manually restart the server.
    1.43 -
    1.44 -   The update tool unloads itself immediately after the server starts, so it will not
    1.45 - use any resources, and will not display when you type 'plugin_print'.  
    1.46 -
    1.47 -4.  TROUBLESHOOTING
    1.48 -
    1.49 -   This tool is currently experimental.  There are two possible problems.  For 
    1.50 -   any issue you encounter, you should post a report here:
    1.51 -
    1.52 -   http://bugs.alliedmods.net/index.php?project=4
    1.53 -
    1.54 -  a.  The updater tool does not patch gameinfo.txt
    1.55 -
    1.56 -      Verify that the tool is loading.  You can do this by opening up the 
    1.57 -      sourcemm_update_tool.vdf file and copying its file path.  Then, enter
    1.58 -      the following command in your server console:
    1.59 -
    1.60 -       plugin_load <path>
    1.61 -
    1.62 -      Example:
    1.63 -
    1.64 -       plugin_load cstrike\addons\metamod\bin\sourcemm_update_tool
    1.65 -
    1.66 -      If you get the following reply:
    1.67 -
    1.68 -       Failed to load plugin "cstrike\addons\sourcemm_update_tool"
    1.69 -       Unable to load plugin "cstrike\addons\sourcemm_update_tool"
    1.70 -
    1.71 -      Then the tool is working, and you should post a bug report.  If instead, 
    1.72 -      you get:
    1.73 -
    1.74 -       Unable to load plugin "cstrike\addons\sourcemm_update_tool"
    1.75 -       Unable to load plugin "cstrike\addons\sourcemm_update_tool"
    1.76 -
    1.77 -      Then the tool is not loading properly, and the path you are trying to use
    1.78 -      is not correct.
    1.79 -
    1.80 -  b.  The server always dies, and you can't start it at all
    1.81 -
    1.82 -      The updater tool is either crashing or not repairing Metamod:Source 
    1.83 -      correctly.  First, try changing the 'restart' line in sourcemm_updater.conf
    1.84 -      to the following line:
    1.85 -
    1.86 -	restart = never
    1.87 -
    1.88 -      If that does not fix the problem, remove the .vdf file so the updater tool
    1.89 -      will not be loaded.  
    1.90 -
    1.91 -      In either case, you should post a bug report containing your mod name and
    1.92 -      your gameinfo.txt as an attachment.
    1.93 -      
    1.94 \ No newline at end of file