Difference between revisions of "Upgrading SourceMod"
(New page: When upgrading SourceMod, backwards compatibility is guaranteed except in rare cases. To completely upgrade, you should: *If you are upgrading to a stable release (not a nightly build), ...) |
m |
||
| Line 13: | Line 13: | ||
It is not necessary to upgrade any third party plugins, unless in rare cases where SourceMod was not able to maintain backwards compatibility. If a plugin stops working due to a SourceMod upgrade, file a bug report and the development team will assess the situation. | It is not necessary to upgrade any third party plugins, unless in rare cases where SourceMod was not able to maintain backwards compatibility. If a plugin stops working due to a SourceMod upgrade, file a bug report and the development team will assess the situation. | ||
| + | |||
| + | On the other hand, third party extensions may be broken across nightly builds. Although it is unusual to do so, breaking changes are sometimes made to the C++ API. This is almost always limited to API which was not yet documented or was not used by third party authors yet. | ||
'''Note:''' It is extremely important to update all <tt>gamedata</tt> files, as those specify how SourceMod interacts with mod-specific properties. | '''Note:''' It is extremely important to update all <tt>gamedata</tt> files, as those specify how SourceMod interacts with mod-specific properties. | ||
Revision as of 02:53, 14 November 2007
When upgrading SourceMod, backwards compatibility is guaranteed except in rare cases. To completely upgrade, you should:
- If you are upgrading to a stable release (not a nightly build), check its release notes for any specific instructions.
- Upgrade all .so/.dll binaries in the following folders:
- sourcemod/bin
- sourcemod/extensions
- sourcemod/extensions/auto.1.ep1
- sourcemod/extensions/auto.2.ep1
- sourcemod/extensions/auto.2.ep2
- Upgrade all of the .txt files in the sourcemod/gamedata folder.
- Upgrade all of the .txt files in the sourcemod/translations folder.
- Upgrade all of the default .smx binaries in the sourcemod/plugins folder.
It is not necessary to upgrade any third party plugins, unless in rare cases where SourceMod was not able to maintain backwards compatibility. If a plugin stops working due to a SourceMod upgrade, file a bug report and the development team will assess the situation.
On the other hand, third party extensions may be broken across nightly builds. Although it is unusual to do so, breaking changes are sometimes made to the C++ API. This is almost always limited to API which was not yet documented or was not used by third party authors yet.
Note: It is extremely important to update all gamedata files, as those specify how SourceMod interacts with mod-specific properties.
Note: If you update your base SourceMod plugins, you must update your translation files (and vice versa). If you absolutely don't want to update your SourceMod base plugins, you should at least update the core.phrases.txt translation file.
