Skip to content

Home

Jump to bottom Edit New page
mikeprimm edited this page Mar 13, 2012 · 2 revisions

This plugin supports the display of claims defined in the GriefPrevention plugin. Both administrator and player-owned claims are supported. The configuration is found in the config.yml file, found in the plugins/Dynmap-GriefPrevention directory. The default config.yml content is:

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

layer:
  name: "GriefPrevention"
  # Make mobs layer hidden by default
  hidebydefault: false
  # ordering priority in layer menu (low goes before high - default is 0)
  layerprio: 0
  # (optional) set minimum zoom level before layer is visible (0 = defalt, always visible)
  minzoom: 0

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

# Format for popup - substitute values for macros
# 
infowindow: '<div class=\"infowindow\">Claim Owner: <span style=\"font-weight:bold;\">%owner%</span><br/>Permission Trust: <span style=\"font-weight:bold;\">%managers%</span><br/>Trust: <span style=\"font-weight:bold;\">%builders%</span><br/>Container Trust: <span style=\"font-weight:bold;\">%containers%</span><br/>Access Trust: <span style=\"font-weight:bold;\">%accessors%</span></div>'

adminclaiminfowindow: '<div class=\"infowindow\"><span style=\"font-weight:bold;\">Administrator Claim</span><br/>Permission Trust: <span style=\"font-weight:bold;\">%managers%</span><br/>Trust: <span style=\"font-weight:bold;\">%builders%</span><br/>Container Trust: <span style=\"font-weight:bold;\">%containers%</span><br/>Access Trust: <span style=\"font-weight:bold;\">%accessors%</span></div>'


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

# Optional list for defining the claims to be shown.  If list is non-empty, only claims matching one of the list strings are shown:
# Values can include '<username>' (claims owned by given user), 'world:<worldid>' (all claims on a specific world),
# '<worldid>/<username>' (claims owned by a given user on a given world).  Administrator claims are owned by 'administrator'.
visibleregions: [ ]

# Optional list for restricting the claims shown.  If list is non-empty, any claims matching one of the list strings are not shown:
# Values can include '<username>' (claims owned by given user), 'world:<worldid>' (all claims on a specific world),
# '<worldid>/<username>' (claims owned by a given user on a given world).  Administrator claims are owned by 'administrator'.
hiddenregions: [ ]

# Optional per-owner overrides for regionstyle (Administrator claims are owned by 'administrator')
ownerstyle:
  administrator:
    strokeColor: "#0000FF"
    fillColor: "#0000FF"

The settings for this plugin are defined below:

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

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

  • use3dregions : If set to true, the claims will be presented with their vertical limits shown. 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 when a player-owned claim is clicked. Several substitution macros are supported, which will be resolved into appropriate data specific to the region being displayed:

    • %owner% - the name of the player owning the claim ('administrator' for administrator claims)

    • %area% - the size of the claim, in blocks

    • %builders% - the names of the players that are allowed to build on the claim (/Trust)

    • %managers% - the names of the players that are allowed to manage permissions on the claim (/PermissionTrust)

    • %accessors% - the names of the players that are allowed access to the claim (/AccessTrust)

    • %containers% - the names of the players that are allowed container access in the claim (/ContainerTrust)

  • adminclaiminfowindow : this setting controls the generation of the HTML within the popup window displayed when an administrator defined claim is clicked. The supported substitution macros are the same as the infowindow parameter, above.

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

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

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

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

  • visibleregions : this optional parameter, if defined, is used to select which claims are to be made visible on the map. The elements of the list can be user names (e.g. "myuser"), to show all the claims owned by a given user; "world:", to show all claims on a specific world; "/" to show all claims by a given user on a given world. If the visibleregions attribute is not defined (the default), all claims will be shown. Value is a string list, which can either be formatted as '[ "user1", "user2", "user3" ]', or as a multi-line list of string:

visibleregions:
  - user1
  - user2
  - user3

  • hiddenregions : this optional parameter, if defined, is used to provide a list of region names to NOT be shown. The format and meaning of the fields are the same as the visibleregions field - but matching claims will NOT be shown.

  • ownerstyle : this optional parameter, if defined, allows the regionstyle attributes used for specific claims to be overridden, based on matching the owning user. The sections under the ownerstyle correspond to the name of a user - any claim owned by the given user ID 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. Note: administrator defined claims have an owner of 'administrator'.

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

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