Add documentation of the oxide core hooks

docs/guides/developers/attributes.md

@@ -0,0 +1,123 @@
+---
+title: Attributes
+after: webrequests
+---
+# Attributes
+## Commands
+
+Custom commands are easily implemented with minimal boilerplate for both in-game chat interfaces and conventional command-line interfaces.
+## Chat commands
+Chat commands are in-game commands entered via the game client's chat, prefixed by a forward slash (/).
+
+when using covalence
+```csharp
+[Command("test")]
+private void TestCommand(IPlayer player, string command, string[] args)
+{
+    player.Reply("Test successful!");
+}
+```
+when using Rustplugin
+```csharp
+[ChatCommand("test")]
+void cmdTest (BasePlayer player, string command, string [] args)
+{
+	Puts("Test successful!");
+}
+```
+## Console commands
+Console commands may be executed from the server console and in-game interfaces F1 (where applicable).
+
+when using covalence
+```csharp
+[Command("test")]
+private void TestCommand(IPlayer player, string command, string[] args)
+{
+    player.Reply("Test successful!");
+}
+```
+when using Rustplugin
+```csharp
+[ConsoleCommand("test")]
+private void cmdTest((ConsoleSystem.Arg arg))
+{
+    Puts("Test successful!");
+}
+```
+## Command permissions
+Easily restrict command usage to players who have a permission assigned to them.
+```csharp
+[Command("test"), Permission("epicstuff.use")]
+private void TestCommand(IPlayer player, string command, string[] args)
+{
+    player.Reply("Test successful!");
+}
+```
+## Info
+Information about the plugin. plugin name (with spaces between words), Developper or maintainer name, and a 3 digit version number.
+```csharp
+[Info("Plugin name", "Developper/Maintainer", "1.0.0")]
+```
+## Description
+A short description of what the plugin does
+```csharp
+[Description("A short description of the plugin")]
+```
+## PluginReference
+Reference to other plugin, when this plugin need to use functions from other plugins.
+
+```csharp
+[PluginReference] private Plugin Vanish, Backpacks;
+```
+Note: when a plugin is required by this plugin, this line should appear at the top. 
+```csharp
+//Requires: Backpacks
+```
+If required plugin is absent from plugin folder, this plugin will not start
+
+## OnlinePlayers
+Auto manage an Hashtable of online players. 
+
+see Bank and Trade plugin for usage example
+```csharp
+class OnlinePlayer
+{
+	public BasePlayer Player;
+	public OnlinePlayer (BasePlayer player)
+	{
+	}
+}
+
+[OnlinePlayers]
+Hash<BasePlayer, OnlinePlayer> onlinePlayers = new Hash<BasePlayer, OnlinePlayer> ();
+```
+## HookMethod
+Indicates that the specified method should be a handler for a hook
+```csharp
+[HookMethod("OnPlayerConnected")]
+private void base_OnPlayerConnected(BasePlayer player) => AddOnlinePlayer(player);
+```
+
+## AutoPatch
+Used with HarmonyPatch to automatically install the patch when plugin start, and uninstall it, when plugin terminate
+```csharp
+[AutoPatch]
+[HarmonyPatch(typeof(Planner), "DoPlace")]
+static class DoPlace_Process
+{
+	[HarmonyPrefix]
+	private static bool Prefix()
+	{
+		UnityEngine.Debug.Log($"[Harmony] Planner DoPlace ");
+		return true;
+	}
+}
+```
+Note: see harmony documentation for info about harmony patches
+
+## Reference
+Add the ablility to reference additionnal DLL files to be used by the plugin
+```csharp
+//Reference: System.Drawing
+```
+

docs/guides/developers/coroutines.md

@@ -0,0 +1,90 @@
+---
+title: Coroutines
+after: pooling
+---
+
+# Coroutines  ( Unity )
+
+Coroutines are usefull for tasks that run across multiple frames. Like waiting to HTTP transfers, 
+Remember that coroutines are not threads. coroutines operation execute on the main thread of the game.
+
+see [Unity documentation about coroutine](https://docs.unity3d.com/6000.1/Documentation/Manual/coroutines.html)
+
+Example of coroutine sending http message to Discord 
+
+```csharp
+	private class DiscordComponent : MonoBehaviour
+	{
+	private readonly Queue<object> _queue = new Queue<object>();
+	// URL generated in Discord
+	private string _url;
+	// coroutine busy status flag
+	private bool _busy = false;
+
+	public DiscordComponent Configure(string url)
+	{
+		if (url == null) throw new ArgumentNullException(nameof(url));
+		_url = url;
+		return this;
+	}
+
+	// Add a message to a queue
+	public DiscordComponent SendTextMessage(string message, params object[] args)
+	{                
+		message = args.Length > 0 ? string.Format(message, args) : message;
+		return AddQueue(new MessageRequest(message));
+	}
+
+	private DiscordComponent AddQueue(object request)
+	{
+		_queue.Enqueue(request);
+		if (!_busy)
+			StartCoroutine(ProcessQueue());
+		return this;
+	}
+
+	// Coroutine to process message queue
+	private IEnumerator ProcessQueue()
+	{
+		if (_busy) yield break;
+		_busy = true;
+		while (_queue.Count!=0)
+		{
+			var request = _queue.Dequeue();
+			yield return ProcessRequest(request);
+		}
+		_busy = false;
+	}
+
+	private IEnumerator ProcessRequest(object request)
+	{
+		// Code to send message to discord
+		byte[]  data = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(request));
+		UploadHandlerRaw uh = new UploadHandlerRaw(data) { contentType = "application/json" };
+		UnityWebRequest www = UnityWebRequest.PostWwwForm(_url, UnityWebRequest.kHttpVerbPOST);
+		www.uploadHandler = uh;
+		yield return www.SendWebRequest();
+
+		if (www.result == UnityWebRequest.Result.ConnectionError || 
+			www.result == UnityWebRequest.Result.ProtocolError)
+			print($"ERROR: {www.error} | {www.downloadHandler?.text}");
+
+		www.Dispose();
+
+		// Wait 2 second between message to avoid spamming Discord
+		yield return new WaitForSeconds(2.0f);
+	}            
+}
+
+private class MessageRequest
+{
+	[JsonProperty("content")]
+	public string Content { get; set; }
+
+	public MessageRequest(string content)
+	{
+		if (content == null) throw new ArgumentNullException(nameof(content));
+		Content = content;
+	}
+}
+```