The main way to use this plugin is to set the values you want in your configuration file. After editing the configuration, you can reload it by running the command /wdl reload.

Note that ops and users with certain permissions can download regardless of the values in the configuration file.

The default configuration

This is the default configuration used, and also contains documentation on what each value means.

wdl:
  # Mode used for WDL-specific logging.  Valid options are 'none' (disables
  # WDL-specific log files), 'individual' (files dated as vanilla minecraft
  # does, per server-start and day), and 'combined' (only 1 log file, which
  # contains all of the data).  Regardless of this setting, the plugin logs
  # to the global server log.  Plugin-specific logs are found in the server
  # logs folder, subfolder 'WDL'.
  logMode: individual
  
  # Time that an accepted permission request lasts for in seconds.  This is
  # only counted after the request is accepted.  In a future update, you'll
  # be able to also specify a custom duration with each request, but that's
  # not currently possible.
  # 
  # Permission requests allow players to request permission to temporarilly
  # use the mod.  They still require a server moderator or administrator to
  # grant the player the permissions, but it simplifies the process because
  # the player can specify exactly what permissions they want. 
  # 
  # 3600 seconds = 1 hour.
  requestDuration: 3600
  
  # Whether the client can use features of WDL that are from newer versions
  # than this plugin is aware of (essentially, this provides a default that
  # is used with unrecognized features).
  canDoNewThings: true
  
  # Whether players are allowed to download the world in general.  If false
  # they aren't allowed (the mod is fully disabled).
  canDownloadInGeneral: true
  
  # The distance from a player that WDL can save chunks.  Use this to limit
  # the area a player can download.  If set to -1, the value for the server
  # in the server config ("view-distance") is used.  HOWEVER, this does not
  # apply when a player is allowed to cache chunks.  When the below setting
  # is set to true, this value is ignored!  (In which case the server value
  # ("view-distance") is used.)
  saveRadius: -1
  
  # Whether a player can cache chunks as they move.  In essence, this means
  # that if the value is true, the player can download the entire map while
  # moving about, but if false, the player will only save the nearby chunks
  # when they stop download.  This doesn't really stop a player from saving
  # the entire map (they could still combine the parts if they wanted), but
  # it will be far harder for a player to do so.  IMPORTANT: If this is set
  # to true, the saveRadius setting is IGNORED!
  canCacheChunks: true
  
  # Whether or not a player can save entities in the map.  This controls if
  # a player can save the location, appearance, inventory contents, and any
  # other information about an animal, monster, or other thing.
  canSaveEntities: true
  
  # Whether a player can save all tile entities as they move about the map.
  # Tile entities (officially, "Block Entities") store additional meta-data
  # for blocks, such as sign text, chest items, and banner patterns.  There
  # are two types that matter to WDL: Ones that have their data sent to the
  # client automatically (such as signs and banners) and ones that need the
  # player to manually open them (containers, such as chests).  For the 2nd
  # group, the setting "wdl.canSaveContainers" must also be true for saving
  # to be allowed. 
  canSaveTileEntities: true
  
  # Whether a player can save containers that require opening to save their
  # contents, such as chests.  For this setting to be meaningful, the value
  # of "wdl.canSaveTileEntities" must be true.  
  canSaveContainers: true
  
  # Whether entity tracking ranges should be sent to the player.  These are
  # obtained from spigot's settings if spigot is installed.  WDL needs this
  # data to correctly identify wheter an entity just went out of a player's
  # range or if it was killed.  If the value is set to false, or the server
  # doesn't use spigot, WDL uses Minecraft's default values.  (These ranges
  # are set in spigot.yml.  Look for entity-tracking-range in the per-world
  # settings.)  If the player cannot save entities, this data is ignored.
  sendEntityRanges: true

  # A message to show the player when they requesting permissions.  This is
  # only used in versions of WDL after 1.8d.  This can be used to state any
  # rules regarding requests.  If this message is blank (or unset), nothing
  # will be displayed, although the player will still be able make requests
  # normally.  If the player can already download, this should generally be
  # left unset, as it will create clutter.
  requestMessage: ""

  # Overrides for specific chunks can be created here.  There are various types of overrides.
  chunkOverrides:
  #Example below:
  #  example1:
  #    type: ChunkRange
  #    x1: 5
  #    y1: 7
  #    x2: 200
  #    y2: 126
  #  example2:
  #    type: BlockRange
  #    x1: 10
  #    y1: 4
  #    x2: 100
  #    y2: 126

  # Per-world configuration goes here.  If a value isn't specified in world
  # world configuration, it uses the default values above.  World names are
  # based off of the folder name.
  per-world: 
  # Example is below.
  #
  #  someMinigameWorld: 
  #    canDownloadInGeneral: false