> For the complete documentation index, see [llms.txt](https://hcdocs.voidem.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hcdocs.voidem.com/configuration.md).

# Configuration

The config.yml file has everything you need to customize the plugin.

```json
# Welcome to the HelpCommand config.yml
# You can edit values here for the plugin

######################################
# Support
######################################
# Documentation: https://hcdocs.voidem.com/
# Discord server: https://support.voidem.com/
# Discord user: voidem
# Spigot user: VoidemLIVE
# GitHub repository: https://github.com/VoidemLIVE/Help-Command-Plugin
######################################
# Plugin config
######################################

######################################
# Main Help Command
######################################

######################################
# Text format
######################################
# Controls the syntax every message in this file is written in.
#
# MINIMESSAGE - MiniMessage tags
# LEGACY      - the older "&a" colour codes, plus previous custom formatting.
#
#
# MiniMessage reference: https://docs.advntr.dev/minimessage/format.html
format: MINIMESSAGE

help:
  1:
    - "<dark_purple>----------"
    - "<bold><aqua>Server<light_purple>Name"
    - "<aqua>Page 1: Navigation"
    - "<dark_purple>----------"
    - "<aqua>/warp <gray><bold>- </bold><light_purple>Teleport to predefined locations"
    - "<aqua>/home <gray><bold>- </bold><light_purple>Teleport to your set home location"
    - "<aqua>/tpa <gray><bold>- </bold><light_purple>Request to teleport to another player"
    - "<aqua>/tpahere <gray><bold>- </bold><light_purple>Request another player to teleport to you"
    - "<dark_purple>----------"
  2:
    - "<dark_purple>----------"
    - "<bold><aqua>Server<light_purple>Name"
    - "<aqua>Page 2: Utility"
    - "<dark_purple>----------"
    - "<aqua>/heal <gray><bold>- </bold><light_purple>Restore your health"
    - "<aqua>/feed <gray><bold>- </bold><light_purple>Satisfy your hunger"
    - "<aqua>/repair <gray><bold>- </bold><light_purple>Repair your equipped items"
    - "<aqua>/vote <gray><bold>- </bold><light_purple>Vote for the server"
    - "<dark_purple>----------"
  3:
    - "<dark_purple>----------"
    - "<bold><aqua>Server<light_purple>Name"
    - "<aqua>Page 3: Interaction"
    - "<dark_purple>----------"
    - "<aqua>/msg <gray><bold>- </bold><light_purple>Send a private message to another player"
    - "<aqua>/mute <gray><bold>- </bold><light_purple>Mute a player in the chat"
    - "<aqua>/unmute <gray><bold>- </bold><light_purple>Unmute a previously muted player"
    - "<aqua>/report <gray><bold>- </bold><light_purple>Report a player for misconduct"
    - "<dark_purple>----------"
  4:
    - "<dark_purple>----------"
    - "<bold><aqua>Server<light_purple>Name"
    - "<aqua>Page 4: Management"
    - "<dark_purple>----------"
    - "<aqua>/ban <gray><bold>- </bold><light_purple>Ban a player from the server"
    - "<aqua>/kick <gray><bold>- </bold><light_purple>Kick a player from the server"
    - "<aqua>/mutechat <gray><bold>- </bold><light_purple>Mute the global chat"
    - "<aqua>/clearinventory <gray><bold>- </bold><light_purple>Clear your inventory"
    - "<dark_purple>----------"
  5:
    - "<dark_purple>----------"
    - "<bold><aqua>Server<light_purple>Name"
    - "<aqua>Page 5: Fun Commands"
    - "<dark_purple>----------"
    - "<aqua>/summon <gray><bold>- </bold><light_purple>Summon a mob"
    - "<aqua>/lightning <gray><bold>- </bold><light_purple>Strike lightning at a location"
    - "<aqua>/tpall <gray><bold>- </bold><light_purple>Teleport all players to your location"
    - "<aqua>/fly <gray><bold>- </bold><light_purple>Toggle flying mode"
    - "<dark_purple>----------"
  6:
    - "<dark_purple>----------"
    - "<bold><aqua>Server<light_purple>Name"
    - "<aqua>Page 6: Miscellaneous"
    - "<dark_purple>----------"
    - "<aqua>/stats <gray><bold>- </bold><light_purple>Display your player statistics"
    - "<aqua>/afk <gray><bold>- </bold><light_purple>Set yourself as away from keyboard"
    - "<aqua>/rules <gray><bold>- </bold><light_purple>Display server rules"
    - "<aqua>/reportbug <gray><bold>- </bold><light_purple>Report a bug to the server administrators"
    - "<dark_purple>----------"


# It is recommended not to delete these pages and to just use the pagesEnabled list to control which pages are to be available

pagesEnabled: [1,2,3,4,5,6] # sets the pages that can be accessed
#aliases: ["helpnav", "helputil", "helpinteract", "helpmanage", "helpfun", "helpmisc"] # sets the aliases for the help command. REQUIRES FULL SERVER RELOAD/RESTART
######################################
# Enabled Commands
######################################

# Please make sure that this value below is either true or false
helpcmd: true
######################################
# Language
######################################
reload: '<green>HelpCommand reloading' # sets message for /hc reload
disabled: '<red>This command is disabled' # sets message for if a command is disabled
noargument: '<red>Please use an argument' # sets message for /hc if no arguments are provided
playersOnly: 'Only players can use this command' # sets message for when a command is run from the console
pageNA: '<red>This page does not exist!' # sets message for if a page doesn't exist

# The plugin makes the arrows clickable for you, so there is no need to add a <click>
# tag yourself -- though any you do add will still work.
pagePrompt:
  enabled: true
  page: '<gold>Page <yellow>$[pageNum]'
  arrowBack: '<green>[<< <dark_green>$[prevNum]<green>]'
  arrowForward: '<green>[<dark_green>$[nextNum]<green> >>]'
######################################

```