[Dragokas]

Description:

By default, SourceMod reloads plugin on map change only (in case its file modification time is changed).
This plugin does the same every 2 seconds (adjustable).

*New features:

- Notify in chat about reloading, loading, unloading.
- Show plugin load status in chat
- Can load newly added plugins (you must set it in ConVars!!!)
- Can reload plugin even if the previous time it is failed
- Can reload translation files cache (when some plugin is changed)
- Scan in subfolders (recursively)
- Ensure plugin is really loaded in case it was fault due to attempt to reload it in middle-time of file uploading
- ConVars allowing to select delay (shorter, to track changes faster - for dev., or vice versa, longer delay to decrease CPU load - for production server)
- Ability to show part of error log in chat when plugin failed to load
- More optimized.

Commands:

PHP Code:

// Forcibly check plugin files for newly updated and reload if any
sm_pluginsreload 


Settings (ConVars):

Located at: cfg/sourcemod/sm_autoreload.cfg

PHP Code:

// Enable this plugin? (1 - Yes, 0 - No)
sm_autoreload_enable "1"

// * Delay between updates (in sec.). Set 0 to disable timer at all.
sm_autoreload_delay "2.0"

// ** Do we need to check for new plugin files appearing? (1 - Yes, 0 - No).
sm_autoreload_track_new "0"

// Where to show info about the reloaded plugin? (0 - Nowhere, 1 - Server, 2 - Chat, 4 - Console. Sum them to combine several options)
sm_autoreload_show_info "3"

// How many lines of error log to display when the plugin is failed to load? (0 - to disable)
sm_autoreload_error_lines "4"

// Display chat message to admins only defined by these admin flags (leave empty - to display for all users)
sm_autoreload_msg_flag "" 


*Notice 1: I would suggest setting like 5.0 - 10.0 sec. delay for production server where you don't need so quick plugin check.
**Notice 2: track new files cause more disk operations since the entire folder has re-read each time. Leave disabled to improve performance.

Forwards:

Spoiler

See details in scripting/include/autoreload.inc
See examples in scripting/include/test_forwards.sp

List:

PHP Code:

/**
 * Called once, before and after all other forwards raised during single update cycle
 *
 * @param pre            1 - plugins update sequence is started
 *                        0 - plugins update sequence is ended
 *    -
 * @noreturn
 */
forward void AP_OnPluginUpdate(int pre);

/**
 * Called before and after each single plugin is loaded
 *
 * @param path            path of the plugin operated, relative to /plugins/ folder
 * @param pre            1 - plugin is about to load (you can block plugin loading in this call)
 *                        0 - plugin loading is finished, with any status (see the "status" value in this call)
 * @param status        See the "PluginStatusEx" enum. Only "Plugin_Running" value should be considered as successful.
 *    -
 * @return                Plugin_Stop (or any non-zero value) - to block plugin from loading
 *                        Plugin_Continue - don't interfere with default behavior
 */
forward Action AP_OnPluginLoad(char[] path, int pre, int status);

/**
 * Called before and after each single plugin is reloaded
 *
 * @param path            path of the plugin operated, relative to /plugins/ folder
 * @param pre            1 - plugin is about to reload (you can block plugin reloading in this call)
 *                        0 - plugin reloading is finished, with any status (see the "status" value in this call)
 * @param status        See the "PluginStatusEx" enum. Only "Plugin_Running" value should be considered as successful.
 *    -
 * @return                Plugin_Stop (or any non-zero value) - to block plugin from loading
 *                        Plugin_Continue - don't interfere with default behavior
 */
forward Action AP_OnPluginReload(char[] path, int pre, int status);

/**
 * Called before and after each single plugin is unloaded
 *
 * @param path            path of the plugin operated, relative to /plugins/ folder
 * @param pre            1 - plugin is about to unload (you can prevent plugin unloading in this call)
 *                        0 - plugin is unloaded
 *    -
 * @return                Plugin_Stop (or any non-zero value) - to block plugin from loading
 *                        Plugin_Continue - don't interfere with default behavior
 */
forward Action AP_OnPluginUnload(char[] path, int pre);

/*
    Notice:
    
     - these forwards doesn't report about actions made by other plugins including sourcemod itself, like:
     
      > when you manually load/reload/unload plugin via console;
      > when SM load/reload/unload plugin between OnMapEnd and OnMapStart events (map transition).

*/


enum PluginStatusEx        // most constants are defined as "PluginStatus" enum in core.inc
{
    Plugin_Running        // successful load/reload operation
    Plugin_Paused        
    Plugin_Error        
    Plugin_Loaded        
    Plugin_Failed        
    Plugin_Created        
    Plugin_Uncompiled    
    Plugin_BadLoad        
    Plugin_Evicted        
    -1                    // for INVALID_HANDLE, like <DISABLED> plugins (also, it's a default value for "pre"-forwards)
} 


Using:

Place smx in "plugins" folder.

Credits:

- Timiditas - author of idea and original plugin
- SilverShot - testing, give me some ideas and forcing me find solutions ^^
- Marttt - reload translation cache suggestion

Full changelog:

1.16 (19-Mar-2025)
- Fixed case with whitespace characters in plugin file name cannot be reloaded (thanks to SuperArtyK).

1.15 (06-Oct-2022)
- Walkaround rare SM bug #1839, when SM reports incorrect plugin state, causing incorrect decision about "load" or "reload".
- Updated against warnings in SM 1.11, and futute 1.12, 1.13.

1.14 (27-Nov-2021)
- Potential fix for rare crash, caused by file system error.
- Improved DEBUG version in attempt to track the rare case with server crash caused by false positive time stamp change detection for all plugins at once.

1.13 (01-July-2021)
- Added command "sm_pluginsreload" - to force checking plugin files for newly updated (by SilverShot request).
- Added new allowed value "0" for "sm_autoreload_delay" ConVar - to disable checking plugins update by timer at all.

1.12 (09-May-2021)
- Little safe check to prevent error if < 4 character length filename for some reason is located at plugins folder.

1.11 (16-Apr-2021)
- Added TIMER_FLAG_NO_MAPCHANGE to prevent accidentally plugin double reload on map change.
- Added forwards (thanks to Silvers for request):

* AP_OnPluginUpdate - called when plugin list update sequence is about to start (or ended) - see the "started" argument to determine.

> This happens when 1 or more plugins are to be planned for loading/reloading/unloading.
> Example: when 10 plugins are changed simultaneously, this forward is called 2 times: 1 - very first before all other forward, then 2 - it is called as last, after all other forwards.

* AP_OnPluginLoad - called before and after plugin is loaded (no matter successfully or not - see the "pre" and "status" arguments for details).

> This happens when plugin wasn't loaded yet, or its previous loading failed.

* AP_OnPluginReload - called before and after plugin is reloaded (no matter successfully or not - see the "pre" and "status" arguments for details).

> This happens when plugin is already loaded at the moment.

* AP_OnPluginUnload

> This happens when plugin is removed, moved or renamed from its initial location.

* Notice 1: You can prevent plugins from load/reload/unload by returning Plugin_Stop in forward (it is only applicable for actions done directly by this plugin).
* Notice 2: these forwards doesn't report about actions made by other plugins including sourcemod itself, like:

> when you manually load/reload/unload plugin via console;
> when SM load/reload/unload plugin between OnMapEnd and OnMapStart events.

1.10 (05-Oct-2020)
- Fixed: not hooked dynamic change of "sm_autoreload_error_lines" ConVar.

1.9 (02-Apr-2020)
- Fixed Windows support. Reloader incorreclty selected load action type, because FindPluginByFile() can't normalize linux path separator (thanks to CrazyGhostRider for report).
- Plugin list is being updated now with newly added plugins on each map start (even if sm_autoreload_track_new == 0).
- Plugin reloading is blocked between map end and map start (for safe).

1.8 (22-Mar-2020)
- Attempt to indirectly recognize <Disabled> plugins to prevent both load / reload commands executing for each modified plugin (affected rcon double-msg only).
- Added reloading of translation files cache; can be triggered by any of plugins reload (Marttt suggestion).
- Added ability to display reload message to admins only: new ConVar "sm_autoreload_msg_flag" (e.g., useful to not distract the players).
- Added ability to disable reloader: new ConVar "sm_autoreload_enable" (e.g. useful when some plugin can surely crash the server due to "hot" reload).

1.7 (18-Mar-2020)
- Some non-essential message cleaning

1.6 (17-Mar-2020)
- Code is simplified, changed timing logic.
- Plugin load status is now always displayed (it's checked with 0.5 sec. delay after actual re-loading).
- Status description is simplified.
- Plugin change is now detected by file size as well.
- "sm_autoreload_delay" ConVar safe minimum is defined as 1.0 sec.
- Disabled load/reload selection logic based on plugin status, since FindPluginByFile returns 0 even if plugin is loaded but disabled. Now, reload + load is always executed together.
- Added ability to display in chat part of error log when plugin is failed to load (you can disable or adjust number of lines in "sm_autoreload_error_lines" ConVar).
- Added an option to display info in console only, see "sm_autoreload_show_info" description.

1.5 (16-Mar-2020)
- Better file uploading finish detection, so no more twice spam in error log (thanks to SilverShot).
- Some message misprints corrected.

1.4 (13-Mar-2020)
- Added better plugin deletion detection
- ArrayLists are replaced by StringMap (for optimization)
- some code and messages optimizaion.

1.3 (12-Mar-2020)
- Added one more plugin reload attempt in case it was previously reloaded at the same moment as file uploading progress is not finished
- Added displaying the status of reloaded plugin (if first attempt is failed).
- Added recurse scanning into subdirectories
- Added ability to track new files (activate it in "sm_autoreload_track_new" ConVar). By default, disabled to save performance.
- Added displaying info in chat (can be disabled by "sm_autoreload_show_info" ConVar).

Notice: you can also unload plugin by deleting the file or renaming extension e.g. into "plugin.smx.bak", or by moving it in "disabled" folder.

1.2 (22-Nov-2019)
- Converted to a new syntax and methodmaps
- Added ConVar "sm_autoreload_delay"
- Some code optimizations

1.1
- Added command "sm plugins load" in case plugin is not loaded last time due to startup error

1.0
- Original version by Timiditas: https://forums.alliedmods.net/showthread.php?t=106320

// TODO:
- Integrity check.
- Adding dynamically loaded/unloaded plugins to tracking list. Also, need help in issue #1482.


Donate

Donates are very appreciated and welcomed for further inspiration, make me happy, and make next updates came out more often:
- Patreon (Paypal)
- BitCoin
- Ю.Money

[lugui]

good, that will save me one or two seconds on each reaload when I testing my plugins... I gess it will add up to a few minutes =P

[Silvers]

At last can add new plugins without having to refresh the plugins list (albeit I use sm_refresh but still typing in console when Im not in-game using the keybind I set).

Thanks!

[Alienmario]

Thanks!

[Dragokas]

Updated.

1.6 (17-Mar-2020) - Code is simplified, changed timing logic. - Plugin load status is now always displayed (it's checked with 0.5 sec. delay after actual re-loading). - Status description is simplified. - Plugin change is now detected by file size as well. - "sm_autoreload_delay" ConVar safe minimum is defined as 1.0 sec. - Disabled load/reload selection logic based on plugin status, since FindPluginByFile returns 0 even if plugin is loaded but disabled. Now, reload + load is always executed together. - Added ability to display in chat part of error log when plugin is failed to load (you can disable or adjust number of lines in "sm_autoreload_error_lines" ConVar). - Added an option to display info in console only, see "sm_autoreload_show_info" description. 1.5 (16-Mar-2020) - Better file uploading finish detection, so no more twice spam in error log (thanks to SilverShot). - Some message misprints corrected.

[Marttt]

I don't know if it will be a good addition, but I'm used to run the "sm_reload_translations" together with the "sm plugins refresh", to reload the translations file (because some times I have to update both .smx and .phrases file),

So maybe you can include that in the plugin and make a cvar (maybe not necessary) allowing it to reload the translations file (at the end) if some plugin is updated.

IMO is just a suggestion to improve it.

Thanks for you effort. Nice plugin as always.

[Dragokas]

Thanks for suggestion, Marttt! Very useful.

Updated.

1.8 (22-Mar-2020) - Attempt to indirectly recognize <Disabled> plugins to prevent both load / reload commands executing for each modified plugin (affected rcon double-msg only). - Added reloading of translation files cache; can be triggered by any of plugins reload (Marttt suggestion). - Added ability to display reload message to admins only: new ConVar "sm_autoreload_msg_flag" (e.g., useful to not distract the players). - Added ability to disable reloader: new ConVar "sm_autoreload_enable" (e.g. useful when some plugin can surely crash the server due to "hot" reload). 1.7 (18-Mar-2020) - Some non-essential message cleaning

[CrazyGhostRider]

You have a mistake. Instead of reloading the updated plugin, the "Loading" of the plugin occurs.

[Dragokas]

Can you show server logs?

[CrazyGhostRider]

I replace the file speclist.smx

[AutoReload] test/speclist.smx has changed timestamp. Reloading...
[SM] Plugin test\speclist.smx is already loaded.
sm plugins reload test/speclist
[SM] Plugin Spectator List reloaded successfully.


sm_autoreload_delay = 2.0
sm_autoreload_track_new = 1
sm_autoreload_error_lines = 4



P.S. Another error with chat messages if you delete a file. And then add the file again
test/speclist2.smx plugin is deleted. Unloading...
test/speclist2.smx plugin reloaded. Status: NOT Loaded

But in the server console it writes like this:
[AutoReload] test/speclist2.smx plugin is deleted. Unloading...
[SM] Plugin Spectator List unloaded successfully.
[AutoReload] test/speclist2.smx has changed timestamp. Reloading...
[SM] Loaded plugin test\speclist2.smx successfully.