misticos
Shows server info and help with the ability to run popular commands

Supported Games

With this plugin you can easily (no, it's hard for a newbie) add a help, info menu to your server. You can setup everything you can see in GUI of this plugin.

WARNING (or FAQ)

  • This plugin MUST be edited first (in configuration) to function the way you want.
  • Links require Image Library to function.

Configuration

Default Configuration

{
  "Tabs": [
    {
      "Technical Name": "tab1",
      "Permission": "infomenu.view",
      "Elements": [
        {
          "Permission": "infomenu.view",
          "Commands": [
            {
              "Command": "menu",
              "Arguments": [
                "open",
                "tab1"
              ]
            }
          ],
          "UI": {
            "Background Color": {
              "Transparency": 1.0,
              "Color": "#aaaaaa",
              "Link": "",
              "Sprite": "Assets/Content/UI/UI.Background.Tile.psd",
              "Material": "Assets/Icons/IconMaterial.mat"
            },
            "Background Position": {
              "Anchors": {
                "Anchor Min X": 0.0,
                "Anchor Min Y": 0.0,
                "Anchor Max X": 1.0,
                "Anchor Max Y": 1.0
              },
              "Offsets": {
                "Offset Min X": -50,
                "Offset Min Y": -50,
                "Offset Max X": 50,
                "Offset Max Y": 50
              }
            },
            "Text": "Text",
            "Text Anchor": "MiddleCenter",
            "Text Placeholder API": false
          }
        }
      ]
    }
  ],
  "Static Elements": [
    {
      "Permission": "infomenu.view",
      "Commands": [
        {
          "Command": "menu",
          "Arguments": [
            "open",
            "tab1"
          ]
        }
      ],
      "UI": {
        "Background Color": {
          "Transparency": 1.0,
          "Color": "#aaaaaa",
          "Link": "",
          "Sprite": "Assets/Content/UI/UI.Background.Tile.psd",
          "Material": "Assets/Icons/IconMaterial.mat"
        },
        "Background Position": {
          "Anchors": {
            "Anchor Min X": 0.0,
            "Anchor Min Y": 0.0,
            "Anchor Max X": 1.0,
            "Anchor Max Y": 1.0
          },
          "Offsets": {
            "Offset Min X": -50,
            "Offset Min Y": -50,
            "Offset Max X": 50,
            "Offset Max Y": 50
          }
        },
        "Text": "Text",
        "Text Anchor": "MiddleCenter",
        "Text Placeholder API": false
      }
    }
  ],
  "Default Tab": "tab1",
  "Commands": [
    "menu",
    "info",
    "help"
  ],
  "Menu UI": {
    "Menu Position": {
      "Anchors": {
        "Anchor Min X": 0.5,
        "Anchor Min Y": 0.5,
        "Anchor Max X": 0.5,
        "Anchor Max Y": 0.5
      },
      "Offsets": {
        "Offset Min X": -400,
        "Offset Min Y": -300,
        "Offset Max X": 400,
        "Offset Max Y": 300
      }
    },
    "Menu Background Color": {
      "Transparency": 1.0,
      "Color": "#aaaaaa",
      "Link": "",
      "Sprite": "Assets/Content/UI/UI.Background.Tile.psd",
      "Material": "Assets/Icons/IconMaterial.mat"
    },
    "Menu Color": {
      "Transparency": 1.0,
      "Color": "#aaaaaa",
      "Link": "",
      "Sprite": "Assets/Content/UI/UI.Background.Tile.psd",
      "Material": "Assets/Icons/IconMaterial.mat"
    },
    "Menu Title Background Position": {
      "Anchors": {
        "Anchor Min X": 0.0,
        "Anchor Min Y": 0.0,
        "Anchor Max X": 1.0,
        "Anchor Max Y": 1.0
      },
      "Offsets": {
        "Offset Min X": -50,
        "Offset Min Y": -50,
        "Offset Max X": 50,
        "Offset Max Y": 50
      }
    },
    "Menu Title Background Color": {
      "Transparency": 1.0,
      "Color": "#aaaaaa",
      "Link": "",
      "Sprite": "Assets/Content/UI/UI.Background.Tile.psd",
      "Material": "Assets/Icons/IconMaterial.mat"
    },
    "Menu Title Text": "<size=3em>Info Menu</size>",
    "Menu Title Text Anchor": "MiddleCenter",
    "Menu Title Placeholder API": false
  }
}

How To

Tabs

Tabs is a list of tabs.

Technical Name is a techncial name for a tab. It's specified in the command if you want to open a tab.

Elements

Elements is a list of elements on the tab.

Commands is a list of commands to run when you press on this element.

Command is a console command to execute.

Arguments is a list of arguments. (Not limited to just strings)WARNING! Please, note that for using chat commands or text there should be only one argument.

Static Elements

Static Elements is a list of static elements that are visible on EVERY tab.

Default Tab

Default Tab is this plugin's default tab (if you don't specify one in the command).

Commands

Commands is a list of commands that can be used to open this plugin's menu.

Menu UI

Menu UI are settings for general menu UI.

What is UI and how to setup it?

Consider reading this guide: CLICK ME.

Permissions

  • infomenu.recacheui - Permission for the recache command usage.

Commands

  • infomenu.recacheui - Start UI recache to update images and links.
  • menu (aka info or help) - Menu usage. Can be changed in configuration. Arguments: open <Tab> to open a specific tab and close to close UI.

Localization

English

{
  "Invalid Syntax": "Invalid command syntax. Usage:\nopen <Tab> - Open a tab\nclose - Close UI",
  "Only Players": "This command is available only for players.",
  "No Tab": "Sorry, we couldn't find this tab. Report it to admins.",
  "No Recache Permission": "You don't have enough permissions (infomenu.recacheui).",
  "Recached": "All UI was successfully recached.",
  "Initial Caching": "Please, wait. UI is caching. It can take up to 10 seconds and it will be opened automatically."
}

Donate

Click me

MIT License

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.