Updating Examples to markdown with more explanation

Author: HerrMagiic

CustomCommands/Interfaces/IPluginUtilities.cs

@@ -5,34 +5,51 @@ namespace CustomCommands.Interfaces;
 
 public interface IPluginUtilities
 {
+    /// <summary>
+    /// Splits the commands string into an array of strings.
+    /// </summary>
+    /// <param name="commands"></param>
+    /// <returns></returns>
     string[] GettingCommandsFromString(string commands);
+
+    /// <summary>
+    /// Adds the css_ prefix to each alias.
+    /// This will help cs# tell this command belongs to the framework.
+    /// </summary>
+    /// <param name="input"></param>
+    /// <returns></returns>
     string[] AddCSSTagsToAliases(string[] input);
+
     /// <summary>
     /// Splits a string by comma, semicolon, or whitespace characters.
     /// </summary>
     /// <param name="str">The string to be split.</param>
     /// <returns>An array of strings containing the split substrings.</returns>
     string[] SplitStringByCommaOrSemicolon(string str);
+
     /// <summary>
     /// Executes the server commands from the command object
     /// </summary>
     /// <param name="cmd"></param>
     /// <param name="player"></param>
     void ExecuteServerCommands(Commands cmd, CCSPlayerController player);
+
     /// <summary>
     /// Issue the specified command to the specified client (mimics that client typing the command at the console).
     /// Note: Only works for some commands, marked with the FCVAR_CLIENT_CAN_EXECUTE flag (not many).
     /// </summary>
     /// <param name="cmd"></param>
     /// <param name="player"></param>
     void ExecuteClientCommands(Commands cmd, CCSPlayerController player);
+
     /// <summary>
     /// Issue the specified command directly from the server (mimics the server executing the command with the given player context).
     /// <remarks>Works with server commands like `kill`, `explode`, `noclip`, etc. </remarks>
     /// </summary>
     /// <param name="cmd"></param>
     /// <param name="player"></param>
     void ExecuteClientCommandsFromServer(Commands cmd, CCSPlayerController player);
+    
     /// <summary>
     /// Checks if the player has the required permissions to execute the command
     /// </summary>

CustomCommands/Services/PluginUtilities.cs

@@ -33,12 +33,6 @@ public string[] GettingCommandsFromString(string commands)
         return splitCommands;
     }
 
-    /// <summary>
-    /// Adds the css_ prefix to each alias.
-    /// This will help cs# tell this command belongs to the framework.
-    /// </summary>
-    /// <param name="input"></param>
-    /// <returns></returns>
     public string[] AddCSSTagsToAliases(string[] input)
     {
         for (int i = 0; i < input.Length; i++)
@@ -49,11 +43,6 @@ public string[] AddCSSTagsToAliases(string[] input)
         return input;
     }
 
-    /// <summary>
-    /// Splits a string by comma, semicolon, or whitespace characters.
-    /// </summary>
-    /// <param name="str">The string to be split.</param>
-    /// <returns>An array of strings containing the split substrings.</returns>
     public string[] SplitStringByCommaOrSemicolon(string str)
     {
         return Regex.Split(str, ",|;|\\s")

CustomCommands/tests.md

@@ -7,3 +7,5 @@
 * [ ] check if newline in language files works
 * [ ] check if arguments still work
   * [ ] check if argument message appears when not giving enough arguments
+* [ ] Test Client commands
+* [ ] Test ClientServer Commands

Examples/CenterMessageWithColor.json Examples/CenterMessageWithColor.mdExamples/CenterMessageWithColor.json renamed to Examples/CenterMessageWithColor.md

@@ -1,10 +1,16 @@
+## Center Message with color:
+
+It is possible to add HTML to the center Message that means its possible to add any color to it. Here are some examples.
+
+
+```json
 [
     {
         "Title": "Center Message with color",
         "Description": "Center Message with color",
         "Command": "colorcenter",
         "CenterMessage": {
-            "Message": "<font color='#00ff00'>Cool color here</font>",
+            "Message": "`<font color='#00ff00'>`Cool color here`</font>`",
             "Time": 5 // Seconds
         },
         "PrintTo": 2
@@ -15,9 +21,10 @@
         "Description": "With html",
         "Command": "htmlcenter",
         "CenterMessage": {
-            "Message": "<div>Steam Group</div><br><div><font color='#00ff00'>https...</font></div>",
+            "Message": "`<div>`Steam Group`</div><br>``<div><font color='#00ff00'>`https...`</font></div>`",
             "Time": 5 // Seconds
         },
         "PrintTo": 2
     }
-]
+]
+```

Examples/ClientCommands.md

@@ -0,0 +1,53 @@
+## Execute Client Commands
+
+If you want to execute Commands for the client here are to different ways of doing it.
+
+#### Execute Client Command:
+
+This means you are simulating typing the command in the players console. Be aware this only works for commands that can be executed by the client.
+
+Example:
+
+```json
+[
+    {
+        "Title": "Open Buy menu",
+        "Description": "Opens the buy menu for the player",
+        "Command": "buy",
+        "Message": "Opening buy Menu...",
+        "PrintTo": 0,
+        "ClientCommands": [
+            "buymenu"
+        ]
+    }
+]
+```
+
+
+#### Execute Client Command from Server:
+
+Issue the specified command directly from the server (mimics the server executing the command with the given player context).
+
+Works with server commands like `kill`, `explode`, `noclip`, etc.
+
+Example:
+
+```json
+[
+    {
+        "Title": "Noclip",
+        "Description": "Noclips player",
+        "Command": "noclip",
+        "Message": "Noclip...",
+        "PrintTo": 0,
+        "ServerCommands": [
+            "noclip"
+        ]
+    }
+]
+```
+
+
+### Important!
+
+Its always recommended to Permission to the command so not every player can use the command and execute commands on your server

Examples/Colors.json Examples/Colors.mdExamples/Colors.json renamed to Examples/Colors.md

@@ -1,9 +1,24 @@
+## Colored Messages
+
+If you want to add Color to your chat message you need to use the color tags.
+
+Here are all color tags:
+
+### Colorlist
+
+![CS2Colors](../.github/img/ColorsCS2.png "CS2Colors")
+
+### Note
+
+If you want to add color to the Center Message check this out: [Color For CenterMessage](./CenterMessageWithColor.md)
+
+```json
 [
     {
         "Title": "Rainbow",
         "Description": "rainbow command",
         "Command": "rainbow",
-        "Message": "{RED}R{ORANGE}A{YELLOW}I{GREEN}N{BLUE}B{DARKBLUE}O{PURPLE}W", 
+        "Message": "{RED}R{ORANGE}A{YELLOW}I{GREEN}N{BLUE}B{DARKBLUE}O{PURPLE}W",
         "PrintTo": 0
     },
     {
@@ -13,4 +28,5 @@
         "Message": "{DEFAULT}1, {WHITE}2 \n{DARKRED}3, {RED}4, {LIGHTRED}5\n{GREEN}6, {LIME}7, {OLIVE}8\n{ORANGE}9, {GOLD}10, {YELLOW}11\n{BLUE}12, {DARKBLUE}13\n{LIGHTPURPLE}14 {PURPLE}15 \n,{GREY}18",
         "PrintTo": 0
     }
-]
+]
+```

Examples/CommandWithArguments.json Examples/CommandWithArguments.mdExamples/CommandWithArguments.json renamed to Examples/CommandWithArguments.md

@@ -1,3 +1,9 @@
+## Command with Arguments
+
+You can also create your own commands with arguments/numbers after it.
+
+
+```json
 [
     {
         "Title": "Arguments 1",
@@ -13,4 +19,5 @@
         "Message": "Help me with 2 argument", 
         "PrintTo": 0
     }
-]
+]
+```

Examples/Cooldown.json Examples/Cooldown.mdExamples/Cooldown.json renamed to Examples/Cooldown.md

@@ -1,3 +1,13 @@
+## Cooldown for commands
+
+Here are two ways to add a cooldown for a command.
+
+The simple command is just a cooldown for the current player who used the command
+
+In the Advanced command example you can add a "IsGlobal" flag so the whole server has a cooldown for this command not just the Player who uses it
+
+
+```json
 [
     //Simple cooldown command
     {
@@ -21,4 +31,5 @@
         "Message": "Cool cooldown message!",
         "PrintTo": 0
     }
-]
+]
+```

Examples/LanguageSupport.json Examples/LanguageSupport.mdExamples/LanguageSupport.json renamed to Examples/LanguageSupport.md

@@ -1,3 +1,11 @@
+## Language support for Commands
+
+If you have a server with players from all over the world you probably want a way to output the message into multiple languages.
+
+Here in the example you can see there is a {LANG} tag. The 'test' after the LANG= points to the language tag in CustomCommands/lang.
+
+
+```json
 [
     {
         "Title": "Sentance",
@@ -11,4 +19,5 @@
             "Time": 10
         }
     }
-]
+]
+```

…amples/MulitpleAliasesForOneCommand.json Examples/MulitpleAliasesForOneCommand.mdExamples/MulitpleAliasesForOneCommand.json renamed to Examples/MulitpleAliasesForOneCommand.md Examples/MulitpleAliasesForOneCommand.json renamed to Examples/MulitpleAliasesForOneCommand.md

@@ -1,3 +1,11 @@
+## Multiple Aliases for one Command
+
+Here is a way of creating aliases for a command.
+
+For example there are many ways a user would try to get the discord link. Using a "," or ";" solve the issue
+
+
+```json
 [
     {
         "Title": "Discord",
@@ -6,4 +14,5 @@
         "Message": "{PREFIX}Discord: https://discord.gg/Z9JfJ9Y57C",
         "PrintTo": 0
     }
-]
+]
+```