HelpText

Allows people to use /help to get help info from all plugins

Total Downloads: 16,468 - First Release: Oct 23, 2014 - Last Update: Feb 3, 2017

4.91892/5, 37 likes
  1. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    What exactly does your config look like? The plugin does allows you to send multiple messages.
     
  2. Aspiring

    Aspiring Naked Wanderer

    I've deleted it from my FTP, since I thought it wouldnt let me do it.
    Code (Text):
    {
      "Pages": {
        "default": {
          "*": [
            "custom helptext"
          ],
          "mypage": [
            "custom page helptext"
          ]
        }
      },
      "Settings": {
        "AllowHelpTextFromOtherPlugins": false,
        "BreakAfter": 10,
        "UseCustomHelpText": true
      },
      "VERSION": "2.0.5"
    }
    This is the vanilla version, if you could help a little with that.
     
  3. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    Code (Javascript):
    {
      "Pages": {
        "default": {
          "*": [
            "custom helptext",
            "more information"
          ],
          "mypage": [
            "custom page helptext",
            "another line added, yay!"
          ]
        }
      },
      "Settings": {
        "AllowHelpTextFromOtherPlugins": false,
        "BreakAfter": 10,
        "UseCustomHelpText": true
      },
      "VERSION": "2.0.5"
    }
     
  4. KingAlmond

    KingAlmond Naked Wanderer

    when i edit the config nothing changes in game...such as AllowHelpTextFromOtherPlugins", false doesn't turn it off....
     
  5. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    What exactly were you expecting to change? That setting is false by default as well. Did you reload the plugin after changing the config?
     
  6. KingAlmond

    KingAlmond Naked Wanderer

    It was true for me, so I changed it to false and it didn't change anything. I also tried to add my own help commands but they didn't work. I did try just to reload the plugin but nothing changed either. Are you suppose to edit the file through console?
     
  7. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    I don't know of any plugins that integrate this, so you likely wouldn't notice a change with that setting. The config file you can edit using Notepad or similar editor.
     
  8. KingAlmond

    KingAlmond Naked Wanderer

    I stopped the server, editted the files in notepad++, uploaded it to the ftp, started the server and nothing changed.

    I uploaded the file here
     
  9. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    You don't need to stop the server, and you shouldn't be edited the plugin directly. Instead, edit the config under oxide/config and then reload the plugin.
     
  10. KingAlmond

    KingAlmond Naked Wanderer

    ohhhh ok and then u type oxide.reload HelpText in rusty console?
     
  11. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    Yes, that'll work.
     
  12. Aspiring

    Aspiring Naked Wanderer

    Well this is my config now..
    Code (Text):
    {
      "Pages": {
        "default": {
          "*": [
            "/tpr name - Sends a teleportation request.",
            "/tpa name - Accepts the last teleportation request.",
            "/tpc name - Cancels the last teleportation request.",
            "/sethome 1~3 - Saves your current position as a home.",
            "/removehome 1~3 - Deletes your current position as a home.",
            "/home 1~3 - Teleports you to your home.",
            "/online - Shows a list of online players.",
            "/clan create tag - Creates a new clan.",
            "/clan join tag - Joins a clan you have been invited to.",
            "/clan leave - Leaves your current clan.",
            "/clan invite name - Invite a player to join your clan.",
            "/clan kick name - Kick a player from your clan.",
            "/clan disband - Completely delete your clan.",
            "/remove - Enables you to remove items you have placed.",
            "/help - Display this command list again."
          ]
          "mypage": [
            "Uh oh, looks like you took a wrong turn!"
          ]
        }
      },
      "Settings": {
        "AllowHelpTextFromOtherPlugins": false,
        "BreakAfter": 10,
        "UseCustomHelpText": true
      },
      "VERSION": "2.0.5"
    }
    And it wipes itself back to the default. Why is this happening?
     
    Last edited by a moderator: Feb 7, 2017
  13. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    That isn't valid JSON because you're missing a comma after the first ]. Test with JSONLint - The JSON Validator..
    Code (Text):
    {
        "Pages": {
            "default": {
                "*": [
                    "/tpr name - Sends a teleportation request.",
                    "/tpa name - Accepts the last teleportation request.",
                    "/tpc name - Cancels the last teleportation request.",
                    "/sethome 1~3 - Saves your current position as a home.",
                    "/removehome 1~3 - Deletes your current position as a home.",
                    "/home 1~3 - Teleports you to your home.",
                    "/online - Shows a list of online players.",
                    "/clan create tag - Creates a new clan.",
                    "/clan join tag - Joins a clan you have been invited to.",
                    "/clan leave - Leaves your current clan.",
                    "/clan invite name - Invite a player to join your clan.",
                    "/clan kick name - Kick a player from your clan.",
                    "/clan disband - Completely delete your clan.",
                    "/remove - Enables you to remove items you have placed.",
                    "/help - Display this command list again."
                ],
                "mypage": [
                    "Uh oh, looks like you took a wrong turn!"
                ]
            }
        },
        "Settings": {
            "AllowHelpTextFromOtherPlugins": false,
            "BreakAfter": 10,
            "UseCustomHelpText": true
        },
        "VERSION": "2.0.5"
    }
     
  14. GST Kapper

    GST Kapper Scavenger

    Code (Text):
    {
      "Pages": {
        "default": {
          "*": [
            "Press M to bring up your map",
            "'/remove' to toggle remove tool",
            "'/help' to see this message again"
          ],
        "admin": [
            "'/help admin' to view admin help menu",
            "'/help tasks' to view list of server issues needing admin attention"
        ]
        },
          "admin": {
            "admin": [
              "'/alias' to create custom chat commands for admins",
              "'/adm' to open admin GUI interface",
            ],
            "tasks": [
              "Set up '/rewards' with Kits, Commands, and Items",
              "Fix Arena PvP zone godmode glitches",

            ]
          }
      },
      "Settings": {
        "AllowHelpTextFromOtherPlugins": false,
        "BreakAfter": 20,
        "UseCustomHelpText": true
      },
      "VERSION": "2.0.5"
    }
    The above is my config, but when I run /help as an admin my admin messages don't show up..?

    '/help admin' works good, as does '/help tasks', I just want to add a line to '/help' to say "'/help admin' to view admin help menu" etc.. (if the player is in the admin group)
    --I got it, for anyone else this is what I did to fix.
    Code (Text):
    {
      "Pages": {
        "default": {
          "*": [
            "Press M to bring up your map"
          ]
        },
        "admin": {
          "*": [
            "'/help admin' to view admin help menu",
            "'/help tasks' to view list of server issues needing admin attention"
          ],
          "admin": [
            "'/alias' to create custom chat commands for admins"
          ],
          "tasks": [
            "Set up '/rewards' with Kits, Commands, and Items"
          ]
        }
      },
      "Settings": {
        "AllowHelpTextFromOtherPlugins": false,
        "BreakAfter": 20,
        "UseCustomHelpText": true
      },
      "VERSION": "2.0.5"
    }
     
    Last edited: Feb 15, 2017
  15. 2dles

    2dles Wood Hoarder

  16. ☺ Tanki ☺

    ☺ Tanki ☺ Wood Hoarder

    Hello, my config :
    Code (Text):
    {
    "Pages": {
      "default": {
          "*": [
          "Tape /home add <name> pour sauvegarder ta position actuelle (alias sethome)",
          "Tape /home list pour afficher toutes les positions sauvegardées. (alias listhomes)",
          "Tape /home remove <name> pour supprimer une position sauvegardée (alias removehome)",
          "Tape /home <name> pour te téléporter à la maison.",
          "Tape /tpr <player name> teleport request to the player.",
          "Tape /tpa Accepts an incoming teleport request.",
          "Tape /tpc Cancel teleport or request.",
          "Tape /town Teleports yourself to town.",
          "Tape /tpinfo Shows limits and cooldowns.",
          "Tape /tphelp Shows help."
        ]
      }
    },

    "Pages": {
      "default": {
          "tanki": [
          "tp <targetplayer> - Teleports yourself to the target player.",
          "tp <player> <targetplayer> - Teleports the player to the target player.",
          "tp <x> <y> <z> - Teleports you to the set of coordinates.",
          "tpl - Shows a list of saved locations.",
          "tpl <location name> - Teleports you to a saved location.",
          "tpsave <location name> - Saves your current position as the location name.",
          "tpremove <location name> - Removes the location from your saved list.",
          "tpb - Teleports you back to the place where you were before teleporting.",
          "home radius <radius> - Find all homes in radius.",
          "home delete <player name/id> <home name> - Remove a home from a player.",
          "home tp <player name|id> <name> - Teleports you to the home location with the name 'name' from the player.",
          "home homes <player name|id> - Shows you a list of all homes from the player.",
          "home wipe - Removes all homes.",
          "town set - Saves the current location as town.",
          "wipehomes - Removes all homes.",
          "Tape /global add <nom_de_la_note> [ton_message] pour ajouter une note qui pourra être consulter par les admins.",
          "Tape /global show <nom_de_la_note> pour afficher une note précise.",
          "Tape /global del <nom_de_la_note> pour supprimer une note.",
          "Tape /global clear pour supprimer toutes les notes"
        ]
      }
    },
      "Settings": {
        "AllowHelpTextFromOtherPlugins": false,
        "BreakAfter": 15,
        "UseCustomHelpText": true
      },
      "VERSION": "2.0.5"
    }
    /help return nothing but /help tanki work fine, why?
     
  17. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    Remove the extra code between the page names:
    Code (Text):
     },

    "Pages": {
     
  18. ☺ Tanki ☺

    ☺ Tanki ☺ Wood Hoarder

    Thanks, work fine!
     
  19. Adriok

    Adriok Wood Hoarder

    Is there a way to put it see the commands in different tabs?
     
  20. Wulf

    Wulf Community Admin Community Admin Oxide Developer

    You'd need a GUI plugin if you wanted that, which this doesn't offer. That'd only be possible in Rust too.