-- instructions - Installation instructions for the Chat System
--    (component of Chat System)
-- Created by: Patrick Ferland
-- Created on: 06/11/2008
 
-- Revision History
    -- 06/11/2008 P.Ferland - New script
    
--[[

To install a Chat System:

1.  Place a single instance of the chat_system (11302:4) template anywhere in your world.
    The Chat System is a "GM-visible" object, so only Superusers can see it!

2.  Shift-click the chat_system "teeth" icon to configure.

DEFAULT CONFIGURATION

chat_profanity
    Globally Filter Profanity (0/1, default 1)
        If 1, chat is profanity-filtered at a global level
    Allow override (0/1, default 1)
        If 1, users can use the /profanity command to toggle filter on/off

chat_skins
    Allow player change (0/1, default 1)
        If 1, players can use /chatskin to select new skins
    Chat System Skin Size (min/normal/max, default normal)
        Default skin size (if players cannot override)
    Enable minimized (0/1, default 1)
        If 1, users can select the "min" size
    Chat System Skin (default mpdefault)
        Default skin (if players cannot override)
    Enable normal (0/1, default 1)
        If 1, users can select the "normal" size
    Enable maximized (0/1, default 1)
        If 1, users can select the "maximized" size

chat_history
    Web password (default blank)
        Password to be provided in querystring to view, if enabled
    Enable history (0/1, default 1)
        If 1, history is maintained
    Require web password (0/1, default 1)
        If 1, password is checked when viewing web history
    Lines per channel (0-5000, default 500)
        Amount of history to maintain
    Allow web view (0/1, default 0)
        If 1, history can be viewed via web

chat_push_to_talk
    Use enter key (0/1, default 1)
        If 1, enter key focuses chat input

chat_channel_colors
    Color World channel (0/1, default 1)
        If 1, world channel is colored
    Color for Spatial (default #808080)
        Web-style color for "spatial" channel
    Color for World (default #9F6060)
        Web-style color for "world" channel
    Color User channel (0/1, default 1)
        If 1, user private channel is colored
    Allow channel color (0/1, default 1)
        If 1, channel colors are enabled
    Color Spatial channel (0/1, default 0)
        If 1, spatial channel is colored
    Color Place channel (0/1, default 1)
        If 1, place channel is colored
    Color for Place (default #9F9F60)
        Web-style color for "place" channel
    Color for User (default #9F609F)
        Web-style color for "user" channel

chat_system
    Allow user font size (0/1, default 1)
        If 1, user can use /fontsize to change text size
    Maximum length (100-1000, default 300)
        Maximum length of commands that can be sent to chat
    Spatial Radius (postive numeric, default 4.5)
        Distance (in tiles) that spatial chat can be "heard"
    Debug channels (0/1, default 0)
        Prepends chat channel name to all messages for debugging purposes
    Announce when users enter/exit sptial (0/1, default 0)
        Send "- xxxx has entered/left" emote to spatial (ignores distance)
    Default font size (8-18, default 12)
        Default size of font (if user cannot change)

chat_tells
    Sound (stylesheet ID, default 11302:3)
        Sound to play when receiving a tell
    Allow tells (0/1)
        If 1, private /tell messaging is enabled
    Play sound (0/1)
        If 1, a sound is played when a /tell is received

]]--