Difference between revisions of "Gamedata Updating (SourceMod)"

From AlliedModders Wiki
Jump to: navigation, search
m
(Configuration)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
We now have a gamedata auto-updating feature in SourceMod (for gamedata files only). When your server starts, SourceMod will contact AlliedModders to check for gamedata file updates. AlliedModders will send back new files if they are available.
+
SourceMod has an automatic updating feature for gamedata files. When your server starts, SourceMod will contact AlliedModders to check for gamedata updates. AlliedModders will send back new files if they are available.
  
As part of this effort, if your server crashes on load, gamedata files will become locked, and no "hacky" functionality will be available. The motivation behind this is to give your server time to update safely in case plugins are trying to run functions that are doomed to crash.  
+
This feature has been available since SourceMod 1.1.  However the updating mechanism was rewritten in 1.2, and servers running 1.1 will no longer receive updates. This documentation applies only to SourceMod 1.2 and higher.
 
 
=Users=
 
  
 
==Configuration==
 
==Configuration==
  
core.cfg has four new settings to control the autoupdaters functionality
+
<tt>core.cfg</tt> has four new settings to control the autoupdaters functionality
  
 
*DisableAutoUpdate
 
*DisableAutoUpdate
Line 15: Line 13:
 
**Enables or disables automatic restarting of SourceMod after a gamedata update.
 
**Enables or disables automatic restarting of SourceMod after a gamedata update.
 
**The default value is "no". A value of "yes" will make SourceMod reload itself and refresh the map.
 
**The default value is "no". A value of "yes" will make SourceMod reload itself and refresh the map.
*AutoUpdateServer
+
*AutoUpdateURL
**Sets the server to connect to for automatic gamedata updates.
+
**Sets the URL to connect to for automatic updates.
**Default is "smupdate.alliedmods.net"
+
**Default is "http://update.sourcemod.net/update/"
*AutoUpdatePort
 
**Sets the port to connect to on the AutoUpdateServer server
 
**Default is 6500
 
 
 
==Details==
 
 
 
Gamedata files are only replaced if their contents are recognized.  For example, if you make custom changes to your files, they will not be replaced even if a newer version is available.  For this reason it is recommended that you submit any changes upstream through the [https://bugs.alliedmods.net/ bug tracker].
 
 
 
Gamedata files from snapshots are not tracked.  Only gamedata files from official releases will be automatically updated.  This means if you are using a snapshot, your files may not receive updates.
 
  
 +
==Custom Files==
  
=Developers=
+
Gamedata files from the default SourceMod distribution can be overwritten even if there are custom changes.  To make protected custom changes, use the <tt>custom</tt> folder under the gamedata directory.  All files under this directory are parsed (in an undefined order) after the main files are loaded.  They will never be overwritten.
  
See tools/gamedata_md5 and tools/daemon for the code that analyzes and handles update requests for gamedata files.  Please report any bugs [https://bugs.alliedmods.net/ at the usual place].
 
  
 
[[Category:SourceMod Documentation]]
 
[[Category:SourceMod Documentation]]

Latest revision as of 11:29, 27 August 2013

SourceMod has an automatic updating feature for gamedata files. When your server starts, SourceMod will contact AlliedModders to check for gamedata updates. AlliedModders will send back new files if they are available.

This feature has been available since SourceMod 1.1. However the updating mechanism was rewritten in 1.2, and servers running 1.1 will no longer receive updates. This documentation applies only to SourceMod 1.2 and higher.

Configuration

core.cfg has four new settings to control the autoupdaters functionality

  • DisableAutoUpdate
    • Enables or Disables SourceMod's automatic gamedata updating.
    • The default value is "no". A value of "yes" will block the Auto Updater.
  • ForceRestartAfterUpdate
    • Enables or disables automatic restarting of SourceMod after a gamedata update.
    • The default value is "no". A value of "yes" will make SourceMod reload itself and refresh the map.
  • AutoUpdateURL

Custom Files

Gamedata files from the default SourceMod distribution can be overwritten even if there are custom changes. To make protected custom changes, use the custom folder under the gamedata directory. All files under this directory are parsed (in an undefined order) after the main files are loaded. They will never be overwritten.