Upstream
/
dynmap
mirror of https://github.com/webbukkit/dynmap.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Component Configuration (markdown)

mikeprimm 2011-10-23 11:09:09 -07:00
parent f9f1a66ad7
commit 2c1c6f9ab5
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Component-Configuration.md

@ -24,6 +24,8 @@ This component defines the primary interface for the web client via Dynmap's int
hidewebchatip: false
trustclientname: false
includehiddenplayers: false
hideifshadow: 15
hideifundercover: 15
The settings are defined as follows:
@ -41,6 +43,10 @@ The settings are defined as follows:
* _includehiddenplayers_ : if set to true, players that are hidden (via the /dynmap hide command) will be reported to the UI as online, but with their position, health, and messages still hidden. They will appear in the player list.
* _hideifshadow_ : if set to a value below 15, each player's position and health are hidden if the light level of the current location of the player is at or below the given value (0=total darkness, 4=under sky at night, 15=full daylight).
* _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).
## 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:
@ -53,6 +59,8 @@ The alternative to using the internal web server is for all communications betwe
webchat-interval: 5
hidewebchatip: false
includehiddenplayers: false
hideifshadow: 15
hideifundercover: 15
The definitions of the attributes are the same as the corresponding attributes in the Internal Client Update Component. The additional attributes are as follows: