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 settings for this plugin are defined below:

• 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

• 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)

• 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.

• customstyle : this optional parameter, if defined, allows the regionstyle attributes used for specific regions to be overridden. The sections under the customstyle 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) 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.

• customstyle : This works as in WorldGuard. To tailor a subarea of a Residence, add a section named residencename.areaname (e.g. myresidence.lot123).