Update README.md (#153)

Also adds default values to unmanaged core config

README.md

@@ -63,6 +63,10 @@ public class HelloWorldPlugin : BasePlugin
 
     public override string ModuleVersion => "0.0.1";
 
+    public override string ModuleAuthor => "roflmuffin";
+
+    public override string ModuleDescription => "Simple hello world plugin";
+
     public override void Load(bool hotReload)
     {
         Logger.LogInformation("Plugin loaded successfully!");

configs/addons/counterstrikesharp/configs/core.example.json

@@ -1,5 +1,6 @@
 {
     "PublicChatTrigger": [ "!" ],
     "SilentChatTrigger": [ "/" ],
-    "FollowCS2ServerGuidelines": true
+    "FollowCS2ServerGuidelines": true,
+    "PluginHotReloadEnabled": true
 }

docs/src/content/docs/guides/hello-world-plugin.md

@@ -68,19 +68,20 @@ Now build your project using your ide or the `dotnet build` command. You should
 
 ### Installing your Plugin
 
-Locate the `plugins` folder in your CS2 dedicated server (`/game/csgo/addons/counterstrikesharp/plugins`) and create a new folder with the exact same name as your output .dll file. In this example it would be `HelloWorldPlugin.dll`, so I will make a new folder called `HelloWorldPlugin`. Inside of this folder, copy and paste all of the `.dll` files _except_ the `CounterStrikeSharp.API.dll` file. Once completed, the folder should look as follows:
+Locate the `plugins` folder in your CS2 dedicated server (`/game/csgo/addons/counterstrikesharp/plugins`) and create a new folder with the exact same name as your output .dll file. In this example it would be `HelloWorldPlugin.dll`, so I will make a new folder called `HelloWorldPlugin`. Inside of this folder, copy and paste the: `HelloWorldPlugin.deps.json`, `HelloWorldPlugin.dll`, and `HelloWorldPlugin.pdb` files. Once completed, the folder should look as follows:
 
 ```shell
 .
-└── SamplePlugin
-    ├── McMaster.NETCore.Plugins.dll
-    ├── Microsoft.DotNet.PlatformAbstractions.dll
-    ├── Microsoft.Extensions.DependencyModel.dll
-    ├── SamplePlugin.deps.json
-    ├── SamplePlugin.dll
-    └── SamplePlugin.pdb
+└── HelloWorldPlugin
+    ├── HelloWorldPlugin.deps.json
+    ├── HelloWorldPlugin.dll
+    └── HelloWorldPlugin.pdb
 ```
 
+:::caution
+If you have installed external nuget packages for your plugin, you may need to include their respective `.dll`s. For example, if you utilize the `Stateless` C# library, include `stateless.dll` in your `HelloWorld` plugin directory.
+:::
+
 :::note
 Note that some of these dependencies may change depending on the version of CounterStrikeSharp being used.
 :::

docs/src/content/docs/index.mdx

@@ -25,6 +25,10 @@ public class HelloWorldPlugin : BasePlugin
 
     public override string ModuleVersion => "0.0.1";
 
+    public override string ModuleAuthor => "roflmuffin";
+
+    public override string ModuleDescription => "Simple hello world plugin";
+
     public override void Load(bool hotReload)
     {
         Logger.LogInformation("Plugin loaded successfully!");

docs/src/content/docs/reference/core-configuration.md

@@ -23,4 +23,8 @@ receive a ban.
 
 :::note
 Disable this option at your own risk.
-:::
+:::
+
+## PluginHotReloadEnabled
+
+When enabled, plugins are automatically reloaded when their .dll file is updated.

managed/CounterStrikeSharp.API/Core/CoreConfig.cs

@@ -43,6 +43,9 @@ namespace CounterStrikeSharp.API.Core
 
         [JsonPropertyName("FollowCS2ServerGuidelines")]
         public bool FollowCS2ServerGuidelines { get; set; } = true;
+        
+        [JsonPropertyName("PluginHotReloadEnabled")]
+        public bool PluginHotReloadEnabled { get; set; } = true;
     }
 
     /// <summary>
@@ -80,6 +83,11 @@ namespace CounterStrikeSharp.API.Core
         /// </para>
         /// </summary>
         public static bool FollowCS2ServerGuidelines => _coreConfig.FollowCS2ServerGuidelines;
+
+        /// <summary>
+        /// When enabled, plugins are automatically reloaded when their .dll file is updated.
+        /// </summary>
+        public static bool PluginHotReloadEnabled => _coreConfig.PluginHotReloadEnabled;
     }
 
     public partial class CoreConfig : IStartupService

managed/CounterStrikeSharp.API/Core/Plugin/PluginContext.cs

@@ -64,23 +64,26 @@ namespace CounterStrikeSharp.API.Core.Plugin
                     config.IsUnloadable = true;
                 });
 
-            _fileWatcher = new FileSystemWatcher
+            if (CoreConfig.PluginHotReloadEnabled)
             {
-                Path = Path.GetDirectoryName(path)
-            };
-
-            _fileWatcher.Deleted += async (s, e) =>
-            {
-                if (e.FullPath == path)
+                _fileWatcher = new FileSystemWatcher
                 {
-                    _logger.LogInformation("Plugin {Name} has been deleted, unloading...", Plugin.ModuleName);
-                    Unload(true);
-                }
-            };
+                    Path = Path.GetDirectoryName(path)
+                };
 
-            _fileWatcher.Filter = "*.dll";
-            _fileWatcher.EnableRaisingEvents = true;
-            Loader.Reloaded += async (s, e) => await OnReloadedAsync(s, e);
+                _fileWatcher.Deleted += async (s, e) =>
+                {
+                    if (e.FullPath == path)
+                    {
+                        _logger.LogInformation("Plugin {Name} has been deleted, unloading...", Plugin.ModuleName);
+                        Unload(true);
+                    }
+                };
+
+                _fileWatcher.Filter = "*.dll";
+                _fileWatcher.EnableRaisingEvents = true;
+                Loader.Reloaded += async (s, e) => await OnReloadedAsync(s, e);
+            }
         }
 
         private Task OnReloadedAsync(object sender, PluginReloadedEventArgs eventargs)

src/core/coreconfig.cpp

@@ -47,9 +47,10 @@ bool CCoreConfig::Init(char* conf_error, int conf_error_size)
     m_json = json::parse(ifs);
 
     try {
-        PublicChatTrigger = m_json["PublicChatTrigger"];
-        SilentChatTrigger = m_json["SilentChatTrigger"];
-        FollowCS2ServerGuidelines = m_json["FollowCS2ServerGuidelines"];
+        PublicChatTrigger = m_json.value("PublicChatTrigger", PublicChatTrigger);
+        SilentChatTrigger = m_json.value("SilentChatTrigger", SilentChatTrigger);
+        FollowCS2ServerGuidelines = m_json.value("FollowCS2ServerGuidelines", FollowCS2ServerGuidelines);
+        PluginHotReloadEnabled = m_json.value("PluginHotReloadEnabled", PluginHotReloadEnabled);
     } catch (const std::exception& ex) {
         V_snprintf(conf_error, conf_error_size, "Failed to parse CoreConfig file: %s", ex.what());
         return false;

src/core/coreconfig.h

@@ -28,6 +28,7 @@ class CCoreConfig
     std::vector<std::string> PublicChatTrigger = { std::string("!") };
     std::vector<std::string> SilentChatTrigger = { std::string("/") };
     bool FollowCS2ServerGuidelines = true;
+    bool PluginHotReloadEnabled = true;
 
     using json = nlohmann::json;
     CCoreConfig(const std::string& path);