RPHelper

RPHelper
RPHelper is a Spigot plugin that allows players to select between multiple resource packs with a pleasant GUI.

Installing
This plugin is designed for 1.15.2, older versions support is not guaranteed. To install RPHelper, you need to simply put it into your /plugins/ folder. RPHelper depends on PluginApi, you need to have it installed too.

Note: you shouldn't use vanilla server.properties entries: resource-pack-sha1 and resource-pack.

Gallery:

Permissions:

• rphelper.admin — allows executing some privileged commands. Also, guarantees access to all the resource packs;
• rphelper.user — allows interacting with the resourcepack manager;
• rphelper.resourcepack.<name> — allows selecting and download resource pack ;

Commands

• rp — opens the GUI:
  • reload — reloads the settings;
  • flush — resets the resource pack settings of all the players (rphelper.admin);
  • gui [<page>] — opens the GUI, page can be selected optionally (rphelper.user);
  • info <resource pack name> — returns the information (URL and hash) about a certain resource pack (rphelper.user + rphelper.resourcepack.<resource pack name>);
  • list — returns the list of all resource packs on the server, available to sender or not (rphelper.user);
  • receive — tries to download selected resource pack (rphelper.user);
  • reset [<kick>] — tries to reset your resource pack, if “kick” added as argument, you get kicked from the server (rphelper.user);
  • select <resource pack name> — selects a resource pack with a certain name for you and tries to send it (rphelper.user + rphelper.resourcepack.<resource pack name>).

Configuration
RPHelper can be configured using JSON configuration in /plugins/RPHelper directory.

Properties:

• object messages — various messages sent or shown by the plugin:
  • object command — messages that are sent as a result of command executing:
    • string clickToGo — shown when a player hovers on a link;
    • string clickToCopy — shown when a player hovers on a copyable message;
    • string description — the description of the root command;
    • string flushed — sent when all the resource packs data gets flushed;
    • string noPermission — sent when a player has no access to a certain subcommand;
    • string noSuchResourcePack — sent when a player tries to access an unavailable resource pack;
    • string nullHash — the placeholder of resource pack's hash if it is undefined;
    • string permissionAvailable — the flag of available permission;
    • string permissionNotAvailable — the flag of unavailable permission;
    • string playerOnly — sent when a player-only command is called not by a player;
    • string reset — sent when a player resets his resource-pack;
    • string resetKick — sent when a player resets his resource-pack and gets kicked by the plugin;
    • object resourcePack — the resource pack info message:
      • string header — the header of resource pack description. There is an available placeholder: %name% — the name of the resource pack;
      • string permissionRubric — the caption of permission value,
      • string permission — the permission value. Available placeholders: %permission% — the permission value, %available% — the state if this permission available to sender (takes either permissionAvailable or permissionNotAvailable value).
  • object permission — messages that describe the permissions of the plugin:
    • string admin — describes rphelper.admin permission,
    • string user — describes rphelper.user permission,
    • string resourcePack — describes rphelper.resourcepack.* permission;
  • object gui — phrases that are displayed in the GUI:
    • string close — the button for closing the GUI,
    • string current — the label of the current resource pack,
    • string lmbToReset — the lore of the button to reset the resource pack,
    • string nextPage — the label of the button to go to the next page,
    • string rmbToResetAndLeave — the lore of the button to reset the resource pack (leaving action description),
    • string lmbToSelect — the label of resource pack button describing the selection of resource pack,
    • string packPrefix — the prefix of resource pack name in the GUI list,
    • string previousPage — the label of the button to go to the previous page,
    • string resetPack — the label of the resource pack resetting button,
    • string returnTo — the hover label of chat message in the chat that allows returning to the GUI,
    • string returnToGui — the chat message in the chat that allows returning to the GUI,
    • string rmbToGetInfo — the label of the button describing the getting info message of resource pack,
    • string shiftLmbToFlush — admin-only Shift+LMB action of the resetting button,
    • string title — the title of GUI;
  • string tryAgain — the try again hover message;
  • string loadFailure — the resource pack load message;
  • string clickToTryAgain — shown when a resource pack failed to download;
  • string success — sent when a player successfully receives a resource pack of the plugin;
• array of objects resourcePacks — stores available resource packs:
  • string name — the name of the resource pack. Must be unique;
  • string url — the URL to download this resource pack;
  • string hashString — the hex encoded SHA1 checksum of this resource pack;
  • string guiIcon — the material that represents this resource pack in the GUI.

Licensing
This project is licensed under the MIT license.