Home

This plugin supports the display of regions and subzones defined in the Residence plugin. The configuration is found in the config.yml file, found in the plugins/dynmap-residence directory. The default config.yml content is:

# dynmap-residence configuration
#
update:
  # Seconds between checks for Residence updates
  period: 300
  # Listen for update events from Residence, and do immediate updates (if true)
  onchange: true

layer:
  name: "Residence"
  # Make mobs layer hidden by default
  hidebydefault: false
  # ordering priority in layer menu (low goes before high - default is 0)
  layerprio: 1

# Set true to show 3D volumes for zones
use3dregions: false

# How deep to nest residence subzones
resdepth: 2

# Format for popup - substitute values for macros
infowindow: '<div class="infowindow"><span style="font-size:120%;">%regionname%</span><br /> Owner <span style="font-weight:bold;">%playerowners%</span><br />Flags<br /><span style="font-weight:bold;">%flags%</span></div>'

regionstyle:
  strokeColor: "#FF0000"
  strokeOpacity: 0.8
  strokeWeight: 3
  fillColor: "#FF0000"
  fillOpacity: 0.35

# Optional setting to limit which regions to show, by name - if commented out, all regions are shown
visibleregions: [ ]

# Optional setting to hide specific regions, by name
hiddenregions: [ ]

# Optional per-region overrides for regionstyle (any defined replace those in regionstyle)
custstyle:
  homebase:
    strokeColor: "#00FF00"
  homebase.sub1:
    strokeColor: "#007F00"

The settings for this plugin are defined below:

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

  • period : This specifies the number of seconds between checks of the Residence configuration.

  • onchange : If set to true, this enables listening for custom events from Residence, signalling configuration changes (enabling real-time updates). Default is true.

• resdepth : This is the number of layers of Residence zones processed. 1 is just top level residences, 2 adds the first layer of subzones, etc.

• use3dregions : If set to true, the regions will be presented with their vertical limits shown (as a cubiod or other volume). If set to false, the region is shown 2D at a position corresponding to average ground level (Y=64).

• infowindow : this setting controls the generation of the HTML within the popup window displayed with the region is clicked. Several substitution macros are supported, which will be resolved into appropriate data specific to the region being displayed:

  • %regionname% - the name of the region or region.subzone

  • %playerowners% - the names of the player that own the region

  • %flags% - the various attribute flags for the region

  • %flag.XXX% - substitutes just the value of an individual flag, where XXX can be any of the following: "use", "move", "build", "tp", "ignite", "container", "subzone", "destroy", "place", "bucket", "bank", "pvp", "damage", "monsters", "firespread", "tnt", "creeper", "flow", "healing", "animals", "lavaflow", "waterflow", "physics", "piston", "spread"

  • %isforrent%" - indicates if the residence is for rent (true) or not (false)

  • %isrented%" - indicates if the residence is rented (true) or not (false)

  • %rent%" - indicates the money cost for renting the residence

  • %rentdays%" - indicates number of days the residence can be rented for

  • %isforsale%" - indicates if the residence is for sale (true) or not (false)

  • %price%" - indicates the sale price of the residence

• regionstyle : this is a map of attributes used for describing the coloring of the outline and fill for the regions being presented. The attributes include:

  • strokeColor : this specified the color of the outline of the regions

  • strokeOpacity : this specifies how opaque the outline is (0.0 = transparent, 1.0 = solid)

  • strokeWeight : this specifies the thickness of the outline

  • fillColor : this specifies the color used to fill the interior of the region

  • fillOpacity : this specifies how opaque the fill color is (0.0 = transparent, 1.0 = solid)

  • y : this specifies the altitude (Y coordinate) of the outline for the residence (default is 64, standard sea level)

• visibleregions : this optional parameter, if defined, is used to provide a list of region names to be shown (any not on the list will not be shown). If the visibleregions attribute is not defined (the default), all regions will be shown. To tailor a subarea of a Residence, add a section named residencename.areaname (e.g. myresidence.lot123).

• hiddenregions : this optional parameter, if defined, is used to provide a list of region and subzone names to NOT be shown.

• custstyle : this optional parameter, if defined, allows the regionstyle attributes used for specific regions to be overridden. The sections under the custstyle correspond to the name of the region to be customized, and the attributes within that section are the style settings (strokeColor, strokeOpacity, strokeWeight, fillColor, fillOpacity, y) that will be used in place of the defaults from the regionstyle setting. To tailor a subarea of a Residence, add a section named residencename.areaname (e.g. myresidence.lot123).

• layer : This section controls display of the layer on the Dynmap maps, The attributes defined within the section include:

  • label : Name of the layer (controls what is shown on the layer selector).

  • hidebydefault : this optional parameter, if defined and set to true, changes the default visibility state for the map layer with the region information 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 1.