Skip to content

Serilum/Compact-Help-Command

Repository files navigation

Compact Help Command

Download

You can download Compact Help Command on CurseForge and Modrinth:

  CurseForge:   https://curseforge.com/minecraft/mc-mods/compact-help-command
  Modrinth:      https://modrinth.com/mod/compact-help-command

Issue Tracker

To keep a better overview of all mods, the issue tracker is located in a separate repository.
  For issues, ideas, suggestions or anything else, please follow this link:

    -> Issue Tracker

Pull Requests

Because of the way mod loader files are bundled into one jar, some extra information is needed to do a PR.
  A wiki page entry about it is available here:

    -> Pull Request Information

Mod Description

Requires the library mod Collective. 

   This mod is part of The Vanilla Experience.

Compact Help Command is a mod which fixes the issue of the in-game /help command not doing what it's supposed to do. Without the mod, the output is a long list of all white text and not sorted alphabetically. When users try to use the command with more mods installed, the list might even be longer than the maximum amount of text which can be shown. The result is loss of information.

With the mod, the long list of commands is sorted and split into pages. Via /help <page> you can go through all commands, which are also more easily readable via different text colours. Those colours and the amount of commands shown per page can be changed in the config. See below for example images.

Also works for the specific information via /help <command>.


Configurable: ( how do I configure? )
addVerticalBarSpacing (default = true): When enabled, adds a space in front and behind a vertical bar in the subcommands.
amountCommandsPerPage (default = 8, min 1, max 50): The message which will be sent to players when they use the /vote command.


The possible colour code values in the next config lines are; 0: black, 1: dark_blue, 2: dark_green, 3: dark_aqua, 4: dark_red, 5: dark_purple, 6: gold, 7: gray, 8: dark_gray, 9: blue, 10: green, 11: aqua, 12: red, 13: light_purple, 14: yellow, 15: white.
commandColour (default = 2, min 0, max 15): The colour of the command in /help.
subcommandColour (default = 7, min 0, max 15): The colour of the subcommand in /help.


Examples
The problematic /help command before the mod:

 


What the mod changes the /help command in to:







The specific /help <command>:




------------------

You may freely use this mod in any modpack, as long as the download remains hosted within the CurseForge or Modrinth ecosystem.

Serilum.com contains an overview and more information on all mods available.

Comments are disabled as I'm unable to keep track of all the separate pages on each mod.
For issues, ideas, suggestions or anything else there is the Github repo. Thanks!