feat: add extended help message

also format other messages nicely

Author: RebeccaStevens

README.md

@@ -31,6 +31,7 @@ The core commands are also avalibale in a guest code version. e.g.
 ### Other Commands
 
 - `code quiet` - Toggle quiet mode. In this mode less messages will be displayed and your auto-code will be hidden.
+- `code help` - Shows a detailed help message.
 
 ## Console Commands
 

src/AutoCode.cs

@@ -7,6 +7,7 @@
 using System;
 using System.Collections.Generic;
 using System.Globalization;
+using System.Linq;
 using UnityEngine;
 
 namespace Oxide.Plugins
@@ -166,7 +167,8 @@ protected override void LoadDefaultMessages()
       lang.RegisterMessages(new Dictionary<string, string>
       {
         { "Help", "Usage:\n{0}" },
-        { "Description", "Automatically set the code on code locks you place.\n\nCode: {0}\nGuest Code: {1}\nQuiet Mode: {2}" },
+        { "Description", "Automatically set the code on code locks you place." },
+        { "Info", "Code: {0}\nGuest Code: {1}\nQuiet Mode: {2}" },
         { "NoPermission", "You don't have permission." },
         { "CodeAutoLocked", "Code lock placed with code {0}." },
         { "CodeAutoLockedWithGuest", "Code lock placed with code {0} and guest code {1}." },
@@ -185,10 +187,21 @@ protected override void LoadDefaultMessages()
         { "ErrorMoreThanOnePlayerFound", "Error: More than one player found." },
         { "ResettingAllLockOuts", "Resetting lock outs for all players." },
         { "ResettingLockOut", "Resetting lock outs for {0}." },
-        { "QuietModeEnable", "Quiet mode now enabled.\nLess messages will be shown and your auto-code will be hidden." },
+        { "QuietModeEnable", "Quiet mode now enabled." },
         { "QuietModeDisable", "Quiet mode now disabled." },
         { "Enabled", "Enabled" },
-        { "Disabled", "Disabled" }
+        { "Disabled", "Disabled" },
+        { "HelpExtendedCoreCommands", "Core Commands:" },
+        { "HelpExtendedOtherCommands", "Other Commands:" },
+        { "HelpExtendedInfo", "Show your settings:\n{0}" },
+        { "HelpExtendedSetCode", "Set your auto-code to 1234:\n{0}" },
+        { "HelpExtendedPickCode", "Open the code lock interface to set your auto-code:\n{0}" },
+        { "HelpExtendedRandomCode", "Set your auto-code to a randomly generated code:\n{0}" },
+        { "HelpExtendedRemoveCode", "Remove your set auto-code:\n{0}" },
+        { "HelpExtendedCoreGuestCommands", "Each core command is also avalibale in a guest code version. e.g.\n{0}" },
+        { "HelpExtendedQuietMode", "Toggles on/off quiet mode:\n{0}" },
+        { "HelpExtendedQuietModeDetails", "Less messages will be shown and your auto-code will be hidden." },
+        { "HelpExtendedHelp", "Displays this help message:\n{0}" },
       }, this);
     }
 
@@ -314,7 +327,7 @@ public void SetCode(BasePlayer player, string code, bool guest = false, bool qui
             ? lang.GetMessage(guest ? "GuestCodeUpdatedHidden" : "CodeUpdatedHidden", this, player.UserIDString)
             : string.Format(
                 lang.GetMessage(guest ? "GuestCodeUpdated" : "CodeUpdated", this, player.UserIDString),
-                code
+                Formatter.Value(code)
               )
         );
       }
@@ -465,10 +478,24 @@ public void ToggleQuietMode(BasePlayer player, bool quiet = false)
 
       if (!quiet)
       {
-        Message(
-          player,
-          lang.GetMessage(settings.quietMode ? "QuietModeEnable" : "QuietModeDisable", this, player.UserIDString)
-        );
+        if (settings.quietMode)
+        {
+          Message(
+            player,
+            string.Format(
+              "{0}\n" + Formatter.SmallLineGap + "{1}",
+              lang.GetMessage("QuietModeEnable", this, player.UserIDString),
+              lang.GetMessage("HelpExtendedQuietModeDetails", this, player.UserIDString)
+            )
+          );
+        }
+        else
+        {
+          Message(
+            player,
+            lang.GetMessage("QuietModeDisable", this, player.UserIDString)
+          );
+        }
       }
     }
 
@@ -820,6 +847,7 @@ private class Commands
       public string RemoveCode = "remove";
       public string SetCode = "set";
       public string QuietMode = "quiet";
+      public string Help = "help";
 
       public Commands(AutoCode plugin)
       {
@@ -975,6 +1003,13 @@ private void HandleUse(BasePlayer player, string label, string[] args)
           argsRemainingCount--;
         }
 
+        // Help.
+        if (operation == Help)
+        {
+          plugin.Message(player, GetHelpExtended(player, label));
+          return;
+        }
+
         // Pick code.
         if (operation == PickCode)
         {
@@ -1096,12 +1131,13 @@ private void ShowInfo(BasePlayer player, string label, string[] args)
         plugin.Message(
           player,
           string.Format(
-            "{0}\n\n{1}",
+            "{0}\n" + Formatter.SmallLineGap + "{1}\n" + Formatter.SmallLineGap + "{2}",
+            Formatter.H2(plugin.lang.GetMessage("Description", plugin, player.UserIDString)),
             string.Format(
-              plugin.lang.GetMessage("Description", plugin, player.UserIDString),
-              code ?? plugin.lang.GetMessage("NotSet", plugin, player.UserIDString),
-              guestCode ?? plugin.lang.GetMessage("NotSet", plugin, player.UserIDString),
-              plugin.lang.GetMessage(quietMode ? "Enabled" : "Disabled", plugin, player.UserIDString)
+              plugin.lang.GetMessage("Info", plugin, player.UserIDString),
+              code != null ? Formatter.Value(code) : Formatter.NoValue(plugin.lang.GetMessage("NotSet", plugin, player.UserIDString)),
+              guestCode != null ? Formatter.Value(guestCode) : Formatter.NoValue(plugin.lang.GetMessage("NotSet", plugin, player.UserIDString)),
+              quietMode ? Formatter.Value(plugin.lang.GetMessage("Enabled", plugin, player.UserIDString)) : Formatter.NoValue(plugin.lang.GetMessage("Disabled", plugin, player.UserIDString))
             ),
             GetHelp(player, label)
           )
@@ -1138,27 +1174,87 @@ public string GetHelp(BasePlayer player, string label)
       /// </summary>
       /// <returns></returns>
       private string GetUsage(string label)
+      {
+        return Formatter.Command(
+          string.Format(
+            "{0} [<{1}>]",
+            label,
+            string.Join("|", new string[] {
+              string.Format(
+                "[{0}] <{1}>",
+                Guest,
+                string.Join("|", new string[] {
+                  string.Format(
+                    "[{0}] {1}",
+                    SetCode,
+                    "1234"
+                  ),
+                  PickCode,
+                  RandomCode,
+                  RemoveCode
+                })
+              ),
+              QuietMode,
+              Help
+            })
+          )
+        );
+      }
+
+      /// <summary>
+      /// Display an extended help messsage to the player.
+      /// </summary>
+      public string GetHelpExtended(BasePlayer player, string label)
       {
         return string.Format(
-          "{0} <{1}>",
-          label,
-          string.Join("|", new string[] {
-            string.Format(
-              "[{0}] <{1}>",
-              Guest,
-              string.Join("|", new string[] {
+          "{0}",
+          string.Join(
+            "\n" + Formatter.SmallLineGap,
+            string.Join(
+              "\n" + Formatter.SmallLineGap,
+              Formatter.H2(plugin.lang.GetMessage("HelpExtendedCoreCommands", plugin, player.UserIDString)),
+              Formatter.UL(
+                string.Format(
+                  plugin.lang.GetMessage("HelpExtendedInfo", plugin, player.UserIDString),
+                  Formatter.Indent(Formatter.Command(string.Format("{0}", label)))
+                ),
                 string.Format(
-                  "[{0}] {1}",
-                  SetCode,
-                  "1234"
+                  plugin.lang.GetMessage("HelpExtendedSetCode", plugin, player.UserIDString),
+                  Formatter.Indent(Formatter.Command(string.Format("{0} {1}", label, "1234")))
                 ),
-                PickCode,
-                RandomCode,
-                RemoveCode
-              })
+                string.Format(
+                  plugin.lang.GetMessage("HelpExtendedPickCode", plugin, player.UserIDString),
+                  Formatter.Indent(Formatter.Command(string.Format("{0} {1}", label, PickCode)))
+                ),
+                string.Format(
+                  plugin.lang.GetMessage("HelpExtendedRandomCode", plugin, player.UserIDString),
+                  Formatter.Indent(Formatter.Command(string.Format("{0} {1}", label, RandomCode)))
+                ),
+                string.Format(
+                  plugin.lang.GetMessage("HelpExtendedRemoveCode", plugin, player.UserIDString),
+                  Formatter.Indent(Formatter.Command(string.Format("{0} {1}", label, RemoveCode)))
+                )
+              ),
+              string.Format(
+                plugin.lang.GetMessage("HelpExtendedCoreGuestCommands", plugin, player.UserIDString),
+                Formatter.Indent(Formatter.Command(string.Format("{0} {1} {2}", label, Guest, "5678")))
+              )
             ),
-            QuietMode
-          })
+            string.Join(
+              "\n" + Formatter.SmallLineGap,
+              Formatter.H2(plugin.lang.GetMessage("HelpExtendedOtherCommands", plugin, player.UserIDString)),
+              Formatter.UL(
+                string.Format(
+                  plugin.lang.GetMessage("HelpExtendedQuietMode", plugin, player.UserIDString),
+                  Formatter.Indent(Formatter.Command(string.Format("{0} {1}", label, QuietMode)))
+                ),
+                string.Format(
+                  plugin.lang.GetMessage("HelpExtendedHelp", plugin, player.UserIDString),
+                  Formatter.Indent(Formatter.Command(string.Format("{0} {1}", label, Help)))
+                )
+              )
+            )
+          )
         );
       }
     }
@@ -1183,6 +1279,83 @@ public static bool ShouldHideCode(BasePlayer player, Data.Structure.PlayerSettin
       }
     }
 
+    /// <summary>
+    /// Text formatting functions for in-game chat.
+    /// </summary>
+    private static class Formatter
+    {
+      /// <summary>
+      /// A line break in a very small font.
+      /// </summary>
+      public const string SmallestLineGap = "<size=6>\n</size>";
+
+      /// <summary>
+      /// A line break in a small font.
+      /// </summary>
+      public const string SmallLineGap = "<size=9>\n</size>";
+
+      /// <summary>
+      /// Format the given text as a header level 1.
+      /// </summary>
+      public static string H1(string text)
+      {
+        return string.Format("<size=20>{0}</size>", text);
+      }
+
+      /// <summary>
+      /// Format the given text as a header level 2.
+      /// </summary>
+      public static string H2(string text)
+      {
+        return string.Format("<size=16>{0}</size>", text);
+      }
+
+      /// <summary>
+      /// Small text.
+      /// </summary>
+      public static string Small(string text)
+      {
+        return string.Format("<size=12>{0}</size>", text);
+      }
+
+      /// <summary>
+      /// Format the items as an unordered list.
+      /// </summary>
+      public static string UL(params string[] items)
+      {
+        return string.Join(
+          "\n" + SmallestLineGap,
+          items.Select(item => string.Format(" - {0}", item))
+        );
+      }
+
+      /// <summary>
+      /// Indent the given text.
+      /// </summary>
+      public static string Indent(string text)
+      {
+        return string.Format("    {0}", text);
+      }
+
+      /// <summary>
+      /// Format the given text as a command.
+      /// </summary>
+      public static string Command(string text)
+      {
+        return string.Format("<color=#e0e0e0>{0}</color>", text);
+      }
+
+      public static string Value(string text)
+      {
+        return string.Format("<color=#bfff75>{0}</color>", text);
+      }
+
+      public static string NoValue(string text)
+      {
+        return string.Format("<color=#ff7771>{0}</color>", text);
+      }
+    }
+
     /// <summary>
     /// The data stored for temp code locks.
     /// </summary>