Updated Component Configuration (markdown)

mikeprimm 2011-10-01 15:45:18 -07:00
parent 7b808827bf
commit 5904c0aea8
1 changed files with 4 additions and 0 deletions

@ -23,6 +23,7 @@ This component defines the primary interface for the web client via Dynmap's int
webchat-interval: 5
hidewebchatip: false
trustclientname: false
includehiddenplayers: false
The settings are defined as follows:
@ -38,6 +39,8 @@ The settings are defined as follows:
* _trustclientname_ : if set to true, this causes the hostname/IP reported by the web client (which may be falsified) to be reported as the sender's address (versus using the address seen by the web server).
* _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.
## 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:
@ -49,6 +52,7 @@ The alternative to using the internal web server is for all communications betwe
allowwebchat: false
webchat-interval: 5
hidewebchatip: false
includehiddenplayers: 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: