Upstream/dynmap
1
0
Fork 0
mirror of https://github.com/webbukkit/dynmap.git synced 2025-02-20 14:01:48 +01:00
Code Issues Projects Releases Wiki Activity

Updated Component Configuration (markdown)

mikeprimm 2012-01-04 21:52:55 -08:00
parent d4d2b6208d
commit 45814fca7b
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Component-Configuration.md

@ -28,6 +28,7 @@ This component defines the primary interface for the web client via Dynmap's int
includehiddenplayers: false
hideifshadow: 15
hideifundercover: 15
hideifsneaking: false
The settings are defined as follows:
@ -53,6 +54,8 @@ The settings are defined as follows:
* _hideifundercover_ : if set to a value below 15, each player's position and health are hidden if the current position of the player is under cover. Due to a current Bukkit limitation (pending acceptance of a pull request we issued), any block will obstruct the view of the player (once updated, this will shift to be based on the relative shadow level of the location - corresponding to how much the location would be in shadow during full daylight).
* _hideifsneaking_ : if set to true, players that are sneaking will be hidden.
## JSON File Client Update Component
The alternative to using the internal web server is for all communications between Dynmap and the web client to be done via files served through an external web server. As this is done with files formatted using JSON (JavaScript Object Notation), this mode of operation is often referred to as "JSON File Mode". This mode allows the internal web server to be disabled, and is the alternative to using the Internal Client Update Component (only one of them may be enabled at a time). The component is defined by the following lines in the _components_ section:
@ -70,6 +73,7 @@ The alternative to using the internal web server is for all communications betwe
includehiddenplayers: false
hideifshadow: 15
hideifundercover: 15
hideifsneaking: false
The definitions of the attributes are the same as the corresponding attributes in the Internal Client Update Component. The additional attributes are as follows:
@ -90,6 +94,13 @@ This component, added in v0.22, provides built-in support for map markers, both
offlinelabel: "Offline"
offlineicon: offlineuser
offlinehidebydefault: true
offlineminzoom: 0
showspawnbeds: false
spawnbedlabel: "Spawn Beds"
spawnbedicon: "bed"
spawnbedhidebydefault: true
spawnbedminzoom: 0
spawnbedformat: "%name%'s bed"
The settings for the component include the following:
@ -111,6 +122,18 @@ The settings for the component include the following:
* _offlinehidebydefault_ : if defined and set true, offline marker layer is hidden by default. Default is 'true'.
* _offlineminzoom_ : if set to non-zero, this specifies the minimum zoom in level before offline player markers are displayed.
* _showspawnbeds_ : If defined and set to true, a marker layer is defined to show the positions of the online players' spawn beds (markers will be removed when players log off).
* _spawnbedlabel_ : Label for player spawn bed marker layer, if enabled. Default is "Spawn Beds".
* _spawnbedicon_ : Icon to use for any spawn bed markers. Default is 'bed' marker.
* _spawnbedhidebydefault_ : If true, spawn bed marker layer will be hidden, by default.
* _spawnbedminzoom_ : If set to non-zero, this specifies the minimum zoom in level before spawn bed markers are displayed.
# Server-Side Chat Components
These components control the server-side implementation of chat, including the sending of chat messages from the server to the client, as well as particulars of how chat messages from the client to the server are delivered to players on the server. Only one of these components should be defined at a time.