PSPluginSelector » An AddOn for PlayerServers. 1.5

PSPluginSelector is an AddOn plugin for PlayerServers! It cannot be used without PlayerServers!



PlayerServers AddOn » PSPluginSelector

PluginSelector is an add on plugin for PlayerServers that allows servers creators to enable and disable specified plugins as they desire, instead of just selecting whole templates. The PluginSelector add-on should be installed in a PlayerServer template, and will allow the creator of that server to select plugins— that you have specified in the config— to enable or disable on their server, in a nice GUI, without any new commands to learn!

PSPluginSelector is an AddOn plugin for PlayerServers! It cannot be used without PlayerServers!
​

Features »

• Reads available plugins in the configured directory automatically and populates the config for easy editing.
• Customizable icon name, multi-line lore, material, durability, and more.
• Specify plugin dependencies to have them install when needed.
• Hide plugins from list so they only can be installed as dependencies.
• Enable/disable certain plugins in the config.
• Customizable messages.
• Hooks existing /myserver command, so no extra steps for players to learn.

​

Screenshot »

• Added PluginSelector icon to PlayerServers /myserver »
• PluginSelector Menu »

Requirements »

• PlayerServers (1.7+)

Installation »

PSPluginSelector is a bukkit plugin that should go on players' servers (generated by PlayerServers), thus it needs to be included (and be fully setup) in a PlayerServers template. The plugin's that you want to be included in the PSPluginSelector GUI need to be in their own separate directory for storing available plugins.

Because you need to set it up in a template (which is copied to MAKE a server, but is not ITESELF normally a server that runs), it's not as straightforward as just loading the plugin and editing the config. There are two paths you can go down to get the config setup, follow them step by step and it should work. The default config.yml can be found on the plugin page for you to read the config comments, or to copy into the template for option 2. When the plugin is properly setup, it will appear in the GUI.​

Option 1 » Auto-generate plugins list:
This is a little roundabout, but lets you auto-load a plugin list to edit, instead of manually entering all plugins.​

1. Put PSPluginSelector.jar in a PlayerServers template.
2. Create a player server from that template to generate the plugin folder and config in your player server.
3. Navigate to your player server plugins folder (/playerservers/configured/folder/servers/YOUR-UUID-HERE/plugins)
4. Edit the "plugins-folder" config setting and reload or restart the server to auto-scan the plugins folder.
   • The plugins-folder setting should NOT be a server OR template plugins folder.
5. Copy/move the generated PSPluginSelector folder back to the template folder (or multiple template folders), and edit plugin names, descriptions, enabled/disabled status, etc in the config.yml.
   • Each template can have different plugins enabled/disabled/hidden, but each template must have ALL plugins listed OR auto-scan-plugins set to false, or else plugins may be added from the plugins folder & usable when not wanted.
6. Done!

----------------
Option 2 » Manually Specify plugin list:
This will require you to create a plugin folder and copy the config.yml manually, but doesn't require creating a server to generate the config.​

1. Put PSPluginSelector.jar in a PlayerServers template.
2. Create folder named 'PSPluginSelector' in the templates plugin folder.
3. Create a file in the 'PSPluginSelector' folder named config.yml, and copy the default config.yml (found below) into it.
4. Modify the config.yml to your needs. Duplicate the example plugin config for each plugin you want to add, and be sure to set auto-scan-plugins to false if you don't want all/newly added plugins in the plugins-folder to be automatically added.
   • The plugins-folder setting should NOT be a server OR template plugins folder.
5. Done!

Setup Suggestions »

• Symlink this plugin's config.yml or config folder to templates' plugins folder, so you can edit one file and update all servers, instead of having it be copied to each server and require individual updating with new plugins.

​

Commands »
Only the server creator and OPs can use these commands.

• /plugin » With no args, will just open the plugin install GUI.
• /plugin list » Lists all available & visible plugins and their install status.
• /plugin install [plugin] » Opens the install GUI or toggles the install status of the specified plugin.

Configuration »

Spoiler: Default config with comments

Code (Text):

plugins-folder: '/path/to/plugins/folder/'     # The folder where you store all your plugins and their config folders. MUST be an ABSOLUTE PATH (/home/user/pluginsfolder), and NOT a server plugins folder, but it's own separate plugin storage folder. CAN be a template's plugin folder IF you want ALL the plugins in the selector installed by default and ALL the plugins to be removable.
reload-after-changes: false          # If true, servers will reload after plugins are installed/uninstalled to make changes without restarting. NOT RECOMMENDED!
max-enabled-plugins: -1          # If set above 0, limits the maximum number of plugins that a player can install from the selector. (NOT a TOTAL maximum, JUST from the selector)
selector-gui-icon: COMMAND                     # The bukkit Material for the /myservers icon to add.
selector-gui-icon-durability: 0                # The durability (block type) of the added /myservers icon
selector-gui-icon-name: '&e&o&lClick to select plugins'      # The name of the icon added in /myservers
selector-gui-icon-lore: '&e&oHere you can enable/disable||&e&oplugins you want.'       # The lore of the icon added in /myservers (|| = newline)
auto-scan-plugins: true                        # Enable/disable (true/false) auto scan and add plugins in plugins-folder.
plugin-copied-msg: '&a&l%plugin-name% installed!'   # The message to send when a plugin is installed.
plugin-removed-msg: '&c&l%plugin-name% removed!'    # The message to send when a plugin is removed.
plugins:
  Essentials:                                  # Plugin .jar name (minus .jar)
    enabled: 'true'                            # Enabled/disabled: true/false
    config-folder: Essentials                  # Config folder to copy IF you want to include one.
    icon-material: IRON_HOE                    # Material to use for the icon.
    description: '&6&lTHE Essentials!'         # Description to use for the icon.
    hidden: 'false'                            # Hide this icon in the GUI (so plugin can still be a dependency, but not selected itself).
    name: '&e&oEssentials'                     # Name of the icon in the GUI
    icon-durability: '0'                       # Durability of the icon in the GUI
    depends: ''                                # Plugin Dependencies, separated by commas (,)
  WorldGuard:
    enabled: 'true'
    config-folder: WorldGuard
    icon-material: BEDROCK
    description: '&6&oA protection plugin||&e&oTry /wg help'
    hidden: 'false'
    name: WorldGuard
    icon-durability: '0'
    depends: 'WorldEdit'
  WorldEdit:
    enabled: 'true'
    config-folder: WorldEdit
    icon-material: WOOD_AXE
    description: '&6&oChange your world!||&e&oTry //help'
    hidden: 'false'
    name: WorldEdit
    icon-durability: '0'
    depends: 'AsyncWorldEdit'
  AsyncWorldEdit:
    enabled: 'true'
    config-folder: AsyncWorldEdit
    icon-material: WOOD_AXE
    description: 'A plugin'
    hidden: 'true'
    name: AsyncWorldEdit
    icon-durability: '0'
    depends: 'WorldEdit, AsyncWorldEditInjector'
  AsyncWorldEditInjector:
    enabled: 'true'
    config-folder: AsyncWorldEditInjector
    icon-material: COMMAND
    description: 'A plugin'
    hidden: 'true'
    name: AsyncWorldEditInjector
    icon-durability: '0'
    depends: 'WorldEdit, AsyncWorldEdit'

Spoiler: Default config with NO comments (to copy/paste)

Code (Text):

plugins-folder: '/path/to/plugins/folder/'
reload-after-changes: false
max-enabled-plugins: -1
selector-gui-icon: COMMAND
selector-gui-icon-durability: 0
selector-gui-icon-name: '&e&o&lClick to select plugins'
selector-gui-icon-lore: '&e&oHere you can enable/disable||&e&oplugins you want.'
auto-scan-plugins: true
plugin-copied-msg: '&a&l%plugin-name% installed!'
plugin-removed-msg: '&c&l%plugin-name% removed!'
plugins:
  Essentials:
    enabled: 'true'
    config-folder: Essentials
    icon-material: IRON_HOE
    description: '&6&lTHE Essentials!'
    hidden: 'false'
    name: '&e&oEssentials'
    icon-durability: '0'
    depends: ''

Source »

Source (as an example of the PS API usage) can be found on BitBucket.

PSPluginSelector is an AddOn plugin for PlayerServers! It cannot be used without PlayerServers!​