Calytic
Allows players to use /help to get custom help and help info from plugins

Supported Games

Adds flexible /help command that may...

  • display custom messages, with sub-pages OR
  • display generic messages specified by plugin authors using the API

Commands

/help - Displays help information for compatible plugins

Configuration

{
  "Pages": {
    "default": {
      "*": [
        "custom helptext",
        "custom helptext"
      ]
    }
  },
  "Settings": {
    "AllowHelpTextFromOtherPlugins": true,
    "BreakAfter": 10,
    "UseCustomHelpText": false
  },
  "VERSION": "2.0.5"
}
  • UseCustomHelpText(default false)Shows your custom messages.

  • AllowHelpTextFromOtherPlugin(default true)Adds generic help messages from plugin API detailed below.

Default Help Page

The default page for players is Pages > default > "*"

"Pages": {
  "default": {
    "*": [
      "custom helptext"
    ]
  }
}

The above example will output "custom helptext" when a player runs the command /help.

Custom Help Pages

"Pages": {
  "default": {
    ...
    "mypage": [
      "my custom helptext page"
    ]
  }
}

The above example will output "my custom helptext page" when a player runs the command /help mypage.

Group Help Pages

"Pages": {
  ...
  "admin": {
    "*": [
      "admin eyes only"
    ]
  }
}

The above example will add additional helptext for admins provided they are in the "admin" group and type /help.

Developer API

Rust Example

private void SendHelpText(BasePlayer player)
{
     player.ChatMessage("normal helptext");
}

Hurtworld Example

private void SendHelpText(PlayerSession player)
{
     hurt.SendChatMessage(player, "", "normal helptext");
}

Admin Only Example for Rust

private void SendHelpText(BasePlayer player)
{
     if (player.IsAdmin())
     {
          player.ChatMessage("admin helptext");
     }
     player.ChatMessage("normal helptext");
}

MIT License


Copyright (c) 2019 Calytic


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.