Home

mikeprimm edited this page Dec 25, 2011 · 2 revisions
Clone this wiki locally

This plugin supports the display of /warp and /home locations defined in the Essentials plugin. The configuration is found in the config.yml file, found in the plugins/Dynmap-Essentials directory. The default config.yml content is:

# Dynmap-Essentials configuration
#
update:
  # Seconds between position updates
  period: 300.0
  
layer:
  homes:
    enable: true
    name: "Homes"
    # Make home layer hidden by default
    hidebydefault: false
    # ordering priority in layer menu (low goes before high - default is 0)
    layerprio: 20
    # (optional) set minimum zoom level when mob icons should be visible (0=default, any zoom)
    minzoom: 0
    # Default icon for home markers
    deficon: house
    # Label format - substitute %name% for player's name
    labelfmt: "%name%(home)"
    # (optional) List of visible homes (by user ID) - if non-empty, only these will be shown.
    # For homes other that the default for a user, the ID is '<userid>:<homeid>'
    # To show all homes on a given world, include "world:<worldname>" in the string list
    visiblemarkers: []
    # (optional) List of hidden homes (by user ID)
    # For homes other that the default for a user, the ID is '<userid>:<homeid>'
    # To hide all homes on a given world, include "world:<worldname>" in the string list
    hiddenmarkers: []
  warps:
    enable: true
    name: "Warps"
    # Make warp layer hidden by default
    hidebydefault: false
    # ordering priority in layer menu (low goes before high - default is 0)
    layerprio: 21
    # (optional) set minimum zoom level when mob icons should be visible (0=default, any zoom)
    minzoom: 0
    # Default icon for warp markers
    deficon: portal
    # Label format - substitute %name% for warp's name
    labelfmt: "[%name%]"
    # (optional) List of visible warps (by warp ID) - if non-empty, only these will be shown.
    # To show all warps on a given world, include "world:<worldname>" in the string list
    visiblemarkers: []
    # (optional) List of hidden warps (by warp ID)
    # To hide all warps on a given world, include "world:<worldname>" in the string list
    hiddenmarkers: []

The settings for this plugin are defined below:

  • update : The settings in this section control details of how and when updates from Essentials are processed. The following settings are defined:

    • period : This specifies the number of seconds between checks of the Essentials configuration.
  • layer : This section controls display of the layers on the Dynmap maps. When enabled, one layer is defined for /warp points (which is defined by the 'warps' section), and a second layer is defined for the /home points (which is defined by the 'homes' section). The attributes defined within each section include:

    • label : Name of the layer (controls what is shown on the layer selector). Default is 'Warps' for the /warp section, and 'Homes' for the /home section.

    • hidebydefault : this optional parameter, if defined and set to true, changes the default visibility state for the map layer with the markers to be hidden. The layer can still be made visible with the layer control on the web client UI.

    • layerprio : this optional parameter provides an ordering weight for the layer in the layer selection control, which orders from lowest to highest layerprio (and then alphabetically for equal priority layers). Default is 20 for /homes, 21 for /warps.

    • minzoom : this optional parameter provides the option to hide the contents of the layer when the zoom level is below a given value (0 = max zoom out, increasing by one for each step of zoom in). Default is zero (markers are visible for all zoom levels). Note: this feature requires Dynmap 0.28 or later.

    • deficon : this specified the name of the icon used for markers in this layer. For the /home layer, the default is 'house' (a house image); for the /warp layer, the default is 'portal' (a nether portal image).

    • labelfmt : this specifies a format string, used for constructing the labels for markers in the layer. The name of the marker (which is the player name, for the /home layer, and the warp name, for the /warp layer) is substituted for the '%name%' string. The default for the /home layer is '%name%(home)', and for the /warp layer is '[%name%]'. For homes other than the default, the %name% will be "player-name:home-id".

    • visiblemarkers : this allows the markers to be displayed to be limited. If any values are provided in this list, only markers matching one of the strings provided will be displayed. If the list is empty (the default), all markers are visible. To show all the markers on a given world, a string with the format "world:" can be included in the list. Homes other than the player's default home are formatted "player-name:home-id". The list should be formatted as follows:

         visiblemarkers:
          - marker1
          - marker2
          - world:myworld
          - player1:homesweethome
      
    • hiddenmarkers : this allows the set of markers displayed to specifically exclude certain markers - this is applied after the visiblemarkers restrictions are applied. To hide all the markers on a given world, a string with the format "world:" can be included in the list.