Titan Panel Setup Read Me First File
Titan Development Team: HonorGoG, TristTitan, Lothayer, JoeJanko, oXidFoX, Urnati, and StingerSoft.
--------------------------------------------------------------------------

1. Description

Titan Panel adds a fully configurable interface bar/control panel to your WoW UI.  Because so much of the code has been rewritten since version 3.1.1, we are providing this help file.  A comprehensive list of changes can be found in the TitanPanelChangeLog.txt file elsewhere in this package.


2. Installation

Place the contents of the zip file in your ..\Interface\Addons directory.

Important Note for Mac Users:  When a zip file contains folders, the auto-unzip function built into Mac OSX will create a new folder to place them in.  If you unzip directly to the Addons folder, this newly-created folder will prevent Titan from loading.  We recommend Mac users unzip to the desktop, open the Titan folder on the desktop, then select and drag the contents of it to your ..\Interface\Addons folder.


3. Setup

   - Verify WoW recognizes the addon.  After signing on to WoW, click the AddOns button on the Realm/Character Selection screen.  Titan Panel should be checked by default; if not, check it.  While there, check any unchecked addons, including Titan plugins, you want to display and uncheck any addons you don't want to display.
   
   - Display desired core functions and built-in plugins.  After you enter the game, right-click a blank area of the Titan Panel and hover the cursor over Titan Built-ins.  Core functions and built-ins that are displayed by default will be checked; click to check any others you want displayed.  You can also click any checked built-ins you want to disable.

   - Important Note Concerning Rider:  Beginning with Titan Panel version 3.2.1, Rider will no longer automatically equip riding gear by default.  You MUST select the riding gear you want Rider to equip from the Equip items option on Rider's right-click menu.
   

4. Customization

You have numerous ways to customize the panel.  One way is to change the settings of core functions, which appear, like some plugins, on the right side of the main bar.  The following are the core functions:

   - Auto-Hide (Push Pin icon).  Left-clicking this icon causes the bars to only appear when you move the cursor atop the bar.  Otherwise, the bars are hidden.  There is a separate push pin for the top and bottom bars.  The default setting is OFF.

   - Panel Control (aA icon).  Left-clicking this icon displays 5 slider bars with which you can control the scale of the fonts in tooltips (Tooltip Font), the transparency of Titan Panel tooltips (Tooltip Transparency), the scale of Blizzard's user interface (UI Scale), the scale of Titan Panel (Panel Scale), and the spacing of the left-side buttons on the panel (Button Spacing).  The default settings are:
     * Tooltip Font = 100%
     * Tooltip Transparency = 100%
     * UI Scale = 90%
     * Panel Scale = 100%
     * Button Spacing = 25%. 

   - Transparency Control (double-window icon).  Left-clicking this icon displays 2 slider bars with which you can control the transparency of the panel bars. 
     * Main Bar refers to the transparency of the default bar(s) (usually located at the top, though it can appear at the bottom if Display on Top option is unchecked).
     * Auxiliary Bar refers to the transparency of the bottom bar(s) (assuming you already have top bar(s)).
     * The default setting is 70% for both.

   - Volume Control (speaker icon).  Left-clicking this icon displays 6 slider bars with which you can control the volume levels of the following:  Master, Effects, Music, Ambience, Microphone, and Speaker.  The default setting are whatever you have previously selected in the WoW Interface.

Each core function, as well as each of the built-ins, gives you the option to disable it by right-clicking the icon and selecting Hide.

You may restore the defaults at any time by using slash commands. The slash command handler for Titan Panel is /titan or /titanpanel.  Two important slash commands are:

   - /titan reset or /titanpanel reset.  Restores all default settings by clearing the user preferences in the Saved Variables folder.

   - /titan help or /titanpanel help.  Displays in the chat window other slash handler commands for resetting individual settings.

A second way to customize Titan Panel is through plugins.  Titan Panel will display native plugins (written specifically for Titan Panel) as well as Data Broker plugins and launchers (also known as LibDataBroker or LDB).

   - Plugins are controlled by hovering the cursor over a Plugins Category on the right-click menu, such as General or Information, and clicking an unchecked plugin to display it or clicking a checked plugin to hide it.  When you display additional left-side plugins, Titan will add each one to the right of existing buttons, alternating between the 2 top or 2 bottom bars, if double bars are displayed. Newly-selected right-side plugins display on the top-most or bottom-most bar only, to the left of the existing buttons. When top and bottom bars are displayed, select the new plugin from the bar on which you want it to appear.  
   
   - Some plugins have Readme files, like this, to guide you on their uses; some have directions for use on the addon download site; some have slash commands; most have hint text in their tooltip.  Most native plugins include a right-click menu of display options, such as toggles for displaying the icon, label text, and colored text.  For Data Broker plugins and launchers, these options are displayed in a follow-on menu accessed by hovering the plugin/launcher name.

A third way to customize Titan Panel is through the Options menu, in the panel's right-click menu.  Here, you can:

   - Auto-hide.  This works like the Push Pin icon-- selecting it will hide the bar until you put the cursor over it.  You must select this separately for top and bottom bars.  The default setting is OFF.

   - Center text.  This centers left-side buttons on the bar.  The default setting is OFF (left-justified buttons).

   - Lock buttons.  This locks the buttons in place, keeping you from inadvertently moving them.  (See Moving Buttons/Icons, below.)  The default setting is OFF.

   - Show plugin versions.  This displays the version numbers of plugins (if coded to do so) next to the plugins' names on the panel's right-click menu.  The default setting is ON.

   - Reset Panel to Default (Reload UI).  This overrides any changes you have made and immediately reloads the UI.  If you report a problem with the panel, we may ask you to do this. The slash command /titan reset or /titanpanel reset will produce the same result.

   - Bars.  There are three settings that control where and how many bars are displayed - Display on Top, Display Both Bars, and Double Bar.

     * To display one top bar, select Display on Top only.  This is the default setting.
     * To display two top bars, invoke the right-click menu from the top bar and select Display on Top AND Double Bar.
     * To display two top bars and one bottom bar, invoke the right-click menu from the top bar and select all three settings.

     * To display one bottom bar, select no settings (all unchecked).
     * To display two bottom bars, invoke the right-click menu from the bottom bar and select Double Bar only.
     * To display two bottom bars and one top bar, invoke the right-click menu from the bottom bar and select all three settings.
     
     * To display one top and one bottom bar, select Display on Top AND Display Both Bars.

     * To display two top and two bottom bars, select all three settings from the top or bottom bar and then select Double Bar from the opposite bar. 

   - Show tooltips.  This displays a tooltip when you hover the cursor over a button/icon.  The default setting is ON.

   - Hide tooltips in combat.  This turns off tooltips in combat so you're not distracted while fighting.  The default setting is OFF.

   - Disable screen adjust.  Titan Panel adjusts the Blizzard UI automatically so Titan Panel fits without overlapping frames, such as the minimap.  This allows you to disable this automatic adjustment.  The default setting is OFF.  You may want to check this in conjunction with Auto-Hide, since that setting hides the panel except when the cursor is over it.
     Note:  Disabling screen adjust will have *NO EFFECT* on frames such as the combat log or your casting bar. Use the options described below to explicitly adjust those frames.
     
   - Disable minimap adjust. Explicitly disables the adjustment of the minimap. This is useful in cases you want to enable another addon to specifically handle that frame. The default setting is OFF.

   - Automatic log adjust.  This instructs Titan to pin/stick the chat log above your lowest action bar, so the chat log doesn't overlap the action bars (should only work on Blizzard default bars and not custom bars like those added/created by Bartender3 or Bongos2).  The default setting is OFF.
     Note:  Since this option has created a lot of confusion, we recommend that you keep this off, manually move the chat log, and lock it.

   - Move casting bar (Reload UI).  This tells Titan to move the casting/hearth bar up when using the bottom Titan bar(s), so the casting/hearth bar doesn't overlap the action bars. The UI will reload immediately after selecting this option. The default setting is OFF.

   - Append Broker plugin suffix in menu.  This option displays (LDB) next to the plugin/launcher name in the list of Plugins.

   - Force launchers to right-side.  By default, LDB launchers display as left-side buttons.  You can tell Titan to display them as right-side icons in one of two ways.  
     * First, select this command after you activate all launchers.  This makes all active launchers right-side icons. 
     * Second, select Right-Side Plugin from the menu that appears when you hover the launcher name in the list of plugins on Titan's right-click menu. This makes a single launcher a right-side icon.

A fourth way to customize Titan Panel is by changing skins.  Titan comes with a large selection of skins.  You can select a new skin from the Skin Settings option on Titan Panel's right-click menu.  Instructions for creating and/or adding custom skins can be found on the Titan Panel Google Code Wiki @ http://code.google.com/p/titanpanel/wiki/Titan_Custom_Skins.

Titan Panel saves the settings you select separately for each character on your account. The last option on the right-click menu, Load Settings, allow you to change the current character's settings to match those of another character.  Simply select a server and a character from Load Settings.  Functionality will be enchanced when it comes to profiles in due time.


5. Moving Buttons/Icons.

You can swap positions of any two left-side buttons by left-clicking one and dragging it atop another.  You can even swap between bars.  Holding down modifier keys (Ctrl, Shift, Alt) and attempting to move a plugin will not work, by design.

You can also swap positions of any two right-side icons by left-clicking and dragging, as above.  Again, you can swap between the top and bottom bars.  However, it is intended behavior *NOT* to be able to swap plugins with the Titan Clock or the Auxiliary Auto-Hide.

It is also intended *NOT* to be able to switch right-side icons with left-side buttons and vice versa.

Developer Note: Authors should be careful when creating/using right-side icon plugins. To make right-side icons moveable, insert a new entry in the TITAN_PANEL_NONMOVABLE_PLUGINS table containing the id of your plugin, e.g., tinsert(TITAN_PANEL_NONMOVABLE_PLUGINS, "MyAddonID"). You can do this on your OnLoad method, or any initializing method for that matter. This insures that, if a user attempts to switch a right-side button with a left-side icon, right-side and left-side plugins will not get combined inside a certain table in the saved variables profile.  Such behavior is "NOT* intended; this is a safeguard to ensure the profile won't get malformed.


6. Bug Reporting.

The best way to report a bug is to open an Issue at our Google Code site (http://code.google.com/p/titanpanel/issues/).  Please include as many details as possible.  We will post our troubleshooting results and recommendations there, so check back often.  Before opening the Issue, please Search All Issues to see if the bug has already been reported and fixed.  Also, check the download sites for information on the download page, the comment area and forums such as http://wowui.incgamers.com/?p=mod&m=1442 and http://www.curse.com/downloads/details/618/