Skip to content

Home

Jump to bottom Edit New page
Aiq0 edited this page Aug 8, 2022 · 12 revisions

This plugin supports the display of regions defined in the WorldGuard plugin. Both cuboid and polygon regions are supported. The configuration is found in the config.yml file, found in the plugins/Dynmap-WorldGuard directory. The default config.yml content is:

# Dynmap-WorldGuard configuration
#
update:
  # Seconds between checks for WorldGuard updates
  period: 300

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

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

# 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"
  unownedStrokeColor: "#00FF00"
  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)
# Also support wildcard match - wildcard character is '|' (pipe)
custstyle:
  homebase:
    strokeColor: "#00FF00"
  "wildcard|match":
    strokeColor: "#007F7F"

# Optional per-owner overrides for regionstyle (if region has given owner, style overrides those in regionstyle)
ownerstyle:
  kingoftheworld:
    strokeColor: "#00FF00"

# Maximum child depth (1=just top level, 2=top + children of top, etc)
maxdepth: 16

The settings for this plugin are defined below:

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

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

  • 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 players that own the region

    • %groupowners% - the names of the groups that own the region

    • %playermembers% - the names of the players that are members of the region

    • %groupmembers% - the names of the groups that are members of the region

    • %priority% - the priority of the region

    • %parent% - the name of the parent region of the group, if any

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

    • unownedStrokeColor : this specified the color of the outline of the regions that have no owners

    • 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. As of 0.15, the name can include "world-id/region-id" format (in case region ID isn't unique across worlds). Value is a string list, which can either be formatted as '[ "region1", "region2", "region3" ]', or as a multi-line list of string:

visibleregions:
  - region1
  - region2
  - region3
  • hiddenregions : this optional parameter, if defined, is used to provide a list of region names to NOT be shown. As of 0.15, the name can include "world-id/region-id" format (in case region ID isn't unique across worlds). Value is a string list, which can either be formatted as '[ "hiddenregion1", "hiddenregion2" ]', or as a multi-line list of string:
hiddenregions:
  - hiddenregion1
  - hiddenregion2

  • 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) that will be used in place of the defaults from the regionstyle setting. As of 0.12, if the name of the region contains a '|' (pipe), the '|' is treated as a wildcard and any region name starting with the string before the pipe and ending with the string after the pipe will match and receive the style. Wildcard matches are checked after non-wildcard matches, so non-wildcard matches have higher priority. As of 0.15, the name can include "world-id/region-id" format (in case region ID isn't unique across worlds).

  • ownerstyle : this optional parameter, if defined, allows the regionstyle attributes used for specific regions to be overridden, based on matching the owning user or group IDs. The sections under the ownerstyle correspond to the name of a user ID or group ID - any region having the given ID among its owners will match, 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.

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

  • maxdepth : This allows the maximum depth of the children regions to be set. If set to 1, only regions with no parent are shown. If 2, regions with no parent, or which have a parent that has no parent are included.

Add a custom footer
Add a custom sidebar
Clone this wiki locally