Updated Component Configuration (markdown)

mikeprimm 2012-02-21 22:55:53 -08:00
parent 57e2837a01
commit beb3d0e79d

@ -156,7 +156,7 @@ The settings for the component include:
* _allowchat_ : if enabled, this setting determines if chat messages on the server are to be sent to the web clients. If set to 'false', no chat messages are sent to the web clients.
## HeroChat Chat Component
## HeroChat Chat Component (Deprecated - not functional with HeroChat 5)
The HeroChat plugin implements channels and other behaviors that require special treatment. This component interfaces with HeroChat, and allows the selection of which HeroChat channels have their messages reported to the web clients, and which channel messages from the web clients are reported on. This component is configured via the following lines in the _components_ section:
@ -210,6 +210,7 @@ This implements the box for viewing chat messages received from players on the s
showplayerfaces: true
messagettl: 5
scrollback: 100
sendbutton: false
The settings for this component are as follows:
@ -219,6 +220,8 @@ The settings for this component are as follows:
* _scrollback_ : if defined, this specifies the number of messages to keep in the scrollable message list. If specified, messages will not age out (_messagettl_ is ignored) and will only be dropped as the number of messages exceeds the _scrollback_ count.
* _sendbutton_ : if defined and set to true, this causes a send button to appear on the web UI, allowing messages to be sent without requiring the pressing of the return key.
# Map Controls Components
These define additional map content, such as player markers, clocks, logos, etc. Any set of these components can be defined.