using System.Linq; namespace StardewModdingAPI.Framework.Commands { /// The 'help' SMAPI console command. internal class HelpCommand : IInternalCommand { /********* ** Fields *********/ /// Manages console commands. private readonly CommandManager CommandManager; /********* ** Accessors *********/ /// The command name, which the user must type to trigger it. public string Name { get; } = "help"; /// The human-readable documentation shown when the player runs the built-in 'help' command. public string Description { get; } = "Lists command documentation.\n\nUsage: help\nLists all available commands.\n\nUsage: help \n- cmd: The name of a command whose documentation to display."; /********* ** Public methods *********/ /// Construct an instance. /// Manages console commands. public HelpCommand(CommandManager commandManager) { this.CommandManager = commandManager; } /// Handle the console command when it's entered by the user. /// The command arguments. /// Writes messages to the console. public void HandleCommand(string[] args, IMonitor monitor) { if (args.Any()) { Command result = this.CommandManager.Get(args[0]); if (result == null) monitor.Log("There's no command with that name. Type 'help' by itself for more info.", LogLevel.Error); else monitor.Log($"{result.Name}: {result.Documentation}{(result.Mod != null ? $"\n(Added by {result.Mod.DisplayName}.)" : "")}", LogLevel.Info); } else { string message = "\n\n" + "Need help with a SMAPI or mod issue?\n" + "------------------------------------\n" + "See https://smapi.io/help for the best places to ask.\n\n\n" + "How commands work\n" + "-----------------\n" + "Just enter a command directly to run it, just like you did for this help command. Commands may take optional arguments\n" + "which change what they do; for example, type 'help help' to see help about the help command. When playing in split-screen\n" + "mode, you can add screen=X to send the command to a specific screen instance.\n\n\n" + "Valid commands\n" + "--------------\n" + "The following commands are registered. For more info about a command, type 'help command_name'.\n\n"; IGrouping[] groups = (from command in this.CommandManager.GetAll() orderby command.Mod?.DisplayName, command.Name group command.Name by command.Mod?.DisplayName).ToArray(); foreach (var group in groups) { string modName = group.Key ?? "SMAPI"; string[] commandNames = group.ToArray(); message += $"{modName}:\n {string.Join("\n ", commandNames)}\n\n"; } monitor.Log(message, LogLevel.Info); } } } }