Configuring Per World Plugins Premium

Sep 13, 2018 at 9:24 PM
Configuring Per World Plugins Premium
  • PWPP can be confusing to configure at first, but once you figure it out you can understand just how useful it is.

    First off, make sure your world names don't have any spaces or special characters. this will cause PWPP to incorrectly generate the config. (You can use dashes and underscores, but please refrain from using anything else)

    Extra things to note:
    • Don't be afraid of making errors, when you start up the server if there is an error PWPP will save your old config to a file named 'previous_config.yml' in the plugin's config folder.

    Now, Here is a default configuration section of PWPP:
    Code (YAML):
    world:
     # Should Per World Plugins Premium be enabled for this world?
      enabled
    : false
      # Should Per World Plugins Premium use a blacklist or a whitelist?
      blacklist
    : true
      # Which plugins to whitelist or blacklist.
      # If you want to add more plugins for a world just copy and paste the format below.
      plugins
    :
       # The name of the plugin you want to manage (the name that appears in console). Capitalization doesn't matter.
        plugin_name
    :
         # Should Per World Plugins Premium use a blacklist or a whitelist for the events?
          blacklist
    : true
          # Events to either blacklist or whitelist.
          # If you whitelist the events Per World Plugins Premium will only disable those events.
          # If you blacklist the events Per World Plugins Premium will exempt those events and disable all others.
          events
    : [PlayerJoinEvent, PlayerQuitEvent, PlayerKickEvent]
    This is the configuration section for the world named 'world'. As you can see right now we don't have any plugins configured for it. To add a plugin to the list we simply just change plugin_name to the name of the plugin. You can find the name of the plugin by using /plugins or by looking at the plugin name when your server starts up.

    Now, here is an example with the configuration changed:
    Code (YAML):
    world:
     # Should Per World Plugins Premium be enabled for this world?
      enabled
    : true
      # Should Per World Plugins Premium use a blacklist or a whitelist?
      blacklist
    : true
      # Which plugins to whitelist or blacklist.
      # If you want to add more plugins for a world just copy and paste the format below.
      plugins
    :
       # The name of the plugin you want to manage (the name that appears in console). Capitalization doesn't matter.
        Multiverse-Core
    :
         # Should Per World Plugins Premium use a blacklist or a whitelist for the events?
          blacklist
    : false
          # Events to either blacklist or whitelist.
          # If you whitelist the events Per World Plugins Premium will only disable those events.
          # If you blacklist the events Per World Plugins Premium will exempt those events and disable all others.
          events
    : [PlayerJoinEvent, PlayerQuitEvent, PlayerKickEvent]
    In this example, we made a configuration for the plugin Multiverse-Core. We set blacklist to false, because we want to make a whitelist. A whitelist will only enable the selected events and disable all others. So based on this config you can see that in the world named 'world' the only events enabled are PlayerJoinEvent, PlayerQuitEvent, and PlayerKickEvent. I highly recommend having these events in all of your plugin events, because a lot of plugins do important things with these events.

    Finally, You know how to add one plugin to the configuration, but how do you do two, three, or seven? You just copy and paste the configuration from your previous plugin configuration. Here is an example:

    Code (YAML):
    world:
     # Should Per World Plugins Premium be enabled for this world?
      enabled
    : true
      # Should Per World Plugins Premium use a blacklist or a whitelist?
      blacklist
    : true
      # Which plugins to whitelist or blacklist.
      # If you want to add more plugins for a world just copy and paste the format below.
      plugins
    :
       # The name of the plugin you want to manage (the name that appears in console). Capitalization doesn't matter.
        Multiverse-Core
    :
         # Should Per World Plugins Premium use a blacklist or a whitelist for the events?
          blacklist
    : false
          # Events to either blacklist or whitelist.
          # If you whitelist the events Per World Plugins Premium will only disable those events.
          # If you blacklist the events Per World Plugins Premium will exempt those events and disable all others.
          events
    : [PlayerJoinEvent, PlayerQuitEvent, PlayerKickEvent]
        # The name of the plugin you want to manage (the name that appears in console). Capitalization doesn't matter.
        Multiverse-NetherPortals
    :
         # Should Per World Plugins Premium use a blacklist or a whitelist for the events?
          blacklist
    : false
          # Events to either blacklist or whitelist.
          # If you whitelist the events Per World Plugins Premium will only disable those events.
          # If you blacklist the events Per World Plugins Premium will exempt those events and disable all others.
          events
    : [PlayerJoinEvent, PlayerQuitEvent, PlayerKickEvent]
    Hopefully the configuration is less confusing for you now. If you still have any questions, please feel free to PM me or post in the discussion. I will make sure to respond as soon as I can to get PWPP setup for you.
  • Loading...
  • Loading...