The Hotkey List
The hotkey list contains favorited items that are also hotkeyed, and 
sorts them by their hotkey. If the hotkey list is disabled, then its 
items will appear in their respective keyword categories. There should 
be at most one hotkey list. Hotkeyed equipsets do not appear in the 
hotkey list. Hotkeyed items can appear in both the hotkey list and their 
"regular" list by setting repeat_hotkeyed_items to true. 

Keyword Lists
The game gives only the item's name, hotkey, and item index to the 
favorites menu, not anything like the item's type (if another modder has 
found a better way, do tell). So, a keyword list categorizes items by 
their name. Each keyword list below tries to match an item by its set of 
keywords (case insensitive). 

The mod attemps a kind of whole word matching: the match must be 
surrounded by spaces, or must appear at the begining of the item's name 
and be followed by a space, or must appear at the end of item's text and 
be preceeded by a space. If a keyword in a keyword list is surrouned by 
quotes, then that keyword must match the item name exactly. For example, 
a list like: 

    keywords = frostbite,fireball

will match "Staff of Fireball", "Staff of Frostbite", as well as the 
spells "Frostbite" and "Fireball". You can surround a keyword with 
quotes to force the keyword to match the entire item's name. For 
example, this list will match only the spells "Frostbite" and "Fireball" 
(and not "Staff of Frostbite" or "Staff of Fireball"): 

    keywords = "frostbite","fireball"

A keyword list can also have an "excludes" list of keywords: any item 
whose name matches the any of the keywords in the "excludes" will not be 
added to the list. The same rule about quotes above applies. 

The keyword lists are checked in the order they appear in the config. If 
a keyword list is disabled, then its items will appear in the 'other' 
list. You can add or remove keyword lists or modify a keyword list's 
keywords to create custom lists (or add missing items, or for use with 
other mods that change the names of items). 

A keyword list can have sublists. A sublist further categorizes items in 
a list into different sections, eg, for potions: a Magicka section, a 
Stamina section, and a Health section. If a list has sublists, an 
"Other" list is added automatically. If a sublist is empty, its section 
header does not appear in the parent list. Items are first categorized 
into a list, and then the list's sublists are applied. So, a sublist's 
keywords and excludes apply only to the parent list's matched items and 
not any other list. A sublist's keywords are added to its parent list's 
keywords if "include_sublist_keywords = true" is specified, so you don't 
need to list keywords in the parent list and the sublist. The quotes 
rule above applies to sublist keyword lists and exclude lists. 

The Other List
The other list contains all the items that weren't matched by any other 
list. If the other list is disabled, then items that don't match another 
category won't appear in the favorites menu (though they'll still be 
favorited). There should be at most one 'other' list. 

Equipsets
Equipsets allow you to specify a set of equipment (anything that can be 
favorited: spells, shouts, powers, armor, weapons, potions, etc) that is 
equipped when it is clicked. For example, you could have an "Archery" 
equip set that equips a bow, a specific type of arrow, and archery 
enhancing apparel. Or an "Alchemy" equip set that puts on all your 
alchemy enhancing equipment. Or sets for fire / ice / lightening magic. 
An item must be in the favorites menu to be used in an equipset (thought 
it doesn't have to be displayed on a list). 

Equipsets can be created in-game by equipping the equipment you want in 
the equipset, then pressing ctrl+f. You'll be prommpted to enter an 
equipset name, a hotkey, any unequip options (see below), and a dropdown 
of the selected equipment (informational only). Equipsets are saved to 
"favoritesmenu_eqiupsets.cfg". 

Equipsets can be deleted in game by selecting the list you want to 
delete and then pressing ctrl+delete. 

An example equipset:

    [equipset]
    name = Hand to Hand Combat
    hotkey = 3
    equipment = Ancient Nord Sword, right
    equipment = Shield
    equipment = Steel Plate Armor

Hotkey should be a number 0 through 9. "equipment" can be specified 
mulitple times. It should be the name of an item. Surround the item name 
with quotes to force an exact match, eg for the spell "Frostbite", so it 
doesn't match "Staff of Frostbite". If the item can be equipped to a 
specific hand or both, the name should be followed by a comma (or 
whatever list_delimiter is set to), followed by either "left", "right", 
or "dual". Note that some items like shields always go into the left 
hand, so if you specify another item to the left hand, one may override 
the other. Similarly for two handed items. 

Unequipping: An equipset can specify that any items not in the equip set 
be unequipped, or that the left, right, or both hands be unequipped. To 
specify that all other items be unequipped, set "unequip_others = true". 
To unequip hands, set "unequip_hands = " to either "left", "right", or 
"both". Note that there is currently a small glitch in unequipping 
two-handed weapons: When you unequip a two-handed weapon, the game will 
usually try to re-equip wahtever you had equipped before you equipped 
the two-handed weapon. The mod cannot currently effectively unequip 
whatever the game tries to reequip for you. 

Layout
The [layout] section lets you specify the order of the lists independtly 
of the order that they appear in the config file. It also allows you to 
set the height of each row. Items are still matched against the lists in 
the order that they appear in the config file. If this section isn't 
specified, then the order of the lists is the order that they appear in 
the config file (pre 0.1.7 behavior). Note that if a list is enabled and 
it doesn't appear in a row entry here, then the items matched by that 
list won't show up on the favorites menu. 

Spacer Lists
A "spacer" list exists only to put space between lists. This allows
extra long lists to flow into rows below them. The width of a spacer
list should be set to the width of the list above it.

Translations
To translate the config file, make sure you save the file using UTF-16 
encoding with unicode BOM. Please include only the config file, not the 
SWF file (favoritesmenu.swf). You should upload your translation to 
http://www.skyrimnexus.com/. The version number that you use should
include the version number of the mod that your translation is 
compatible with, for example "0.1.8.ITL.1" for "Italian version 1
for Categorized Favorites Menu version 0.1.8".

Misc
A comment can only appear on its own line in the config file, so you
can't do something like

	menu_base_y = -730   #this is a comment after a config line

Tip: This file is reloaded each time the favorites menu is opened.
So, you can set Skyrim to windowed mode, alt-tab out of the game,
modify+save this file, go back into the game, and simply reopen the
favorites menu to test your changes.

[config] Section Options

menu_base_x, menu_base_y
The x,y coordinate of the upper lefthand corner of the favorites menu. 
The lower lefthand corner of the screen is the origin, and the y axis is 
inverted. The default values of 7 for x and -730 for y work for
1024x768. The menu can be positioned in game: 

    Left:  ctrl + left arrow
    Right: ctrl + right arrow
    Up:    ctrl + w
    Down:  ctrl + s

Using ctrl moves the menu 5 pixels. Holding ctrl and shift moves the
menu 1 pixel. These settings are saved when you close the menu to a file
called "favoritesmenu_overrides.cfg" in the same directory as
favoritesmenu.cfg.
  
menu_cols
Number of columns of favorites lists. Deprecated in 0.1.7.

menu_cols = 4 works for 1024x768 resolution. If a [layout] section is 
specified, this is ignored. If a [layout] section isn't specified, the 
row height is set by the first list in the row. Spacers don't count when 
calculating colums; use the [layout] section instead. 

list_alignment
The left / right aligment of the lists, list titles, the equip icon,
and the selector icon. Either "right" or "left".

default_num_list_entries
The default number of entries per list. Each list can have a different
number of entries, set by "num_entries" in a [list] section.

default_list_width
The default width of each list in pixels. 24 pixels are added 
to this for the selector icon (the icon to the right of the list that 
follows the selected item), plus 20 pixels for the "equipped" icon. Each 
list can have a different width, set by "width" in a [list] section. 

default_list_entry_height
The default height of each list entry's text area in pixels. Each list
can have a different entry height, set by "entry_height" in a [list]
section.

default_list_entry_font_size
The default font size of the list entries. Each list can have a
different font size, set by "entry_font_size" in a [list] section.

background_alpha, background_red, background_green, background_blue
The transparency and color of the menu's background. Each of these is a
number fro 0 to 255. 70% transparency is 255 * 0.70 ~= 178. For the RGB
color, all 0's is black, all 255's is white. All 48's is a dark gray.

auto_favorite_prefix
Text that appears before an item that was automatically added to the
favorites menu by the auto-favorite mod to differentiate it from 
regularly-favorited items. Set this to nothing ("auto_favorite_prefix =")
to disable the prefix. Default is "(A)".

title_font_size
The font size of each list's title. Default is 24. Largest without
getting cut off is about 30.

hotkey_color
Color of the hotkey numbers (including equipset hotkeys). Use HTML color
codes. Default here is white. #FF0000 is red.

default_title_color
Default color of the title of each list. Each list can have a different
title color, set by "title_color" in a [list] section.

default_sublist_title_color
The default color of each sublist's title. Each sublist can have a
different color, set by "title_color" in a [sublist] section

sublist_other_title
Header of the "other" sublist. This is mostly for internationalization.
The color of the other list header is default_sublist_title_color. You
don't have to use quotes.

info_textfield_*
There is a small informational text field in the menu for displaying
information about equipsets, menu position, etc.

info_textfield_font_size: font size
info_textfield_font_color: font color, HTML color code
info_textfield_height: height in pixels
info_textfield_alignment: alignment of the text, "left" or "right
info_textfield_placement: placement of the field, "top" or "bottom"

repeat_hotkeyed_items
If true, then hotkeyed items will appear in both the hotkey list and in 
other lists. Note that this may cause a bug with restoring the selected 
item: if you select a hotkeyed item that appears twice, close the menu 
and reopen it, the selected item might be either of the repeated item. 

mouse_wheel_list_switch_modifier_key
The key code for the modifier key that when held down makes the
mouse wheel switch between lists. 17 is the control key (left or
right key). So, ctrl + mouse wheel switches between lists. These are
Flash key codes.

shift key = 16
ctrl key  = 17
alt key   = 18
disabled  = -1

equipset_hotkey_modifier_key
The hotkey modifier key to use with equipping equipsets. For example, 
ctrl+2 will equip equipset 2. The numbers to use are the same for 
mouse_wheel_list_switch_modifier_key. Setting this to -1 disables 
equipset hotkeyes, even if the equipsets have hotkeys defined. Hotkeys 
work only while the favorites menu is open. 

equipset_create_key
The keyboard shortcut key for creating equipsets, used with
equipset_hotkey_modifier_key. This is a Flash key code
The default value is 70, which is "f".

list_delimiter
The delimiter used to split all the lists in this config file. If a mod 
or custom item has a "," in its name, change this delimiter to something 
else, like the vertical bar "|", and do a replace-all in the config 
file. 

two_handed_weapons
A keyword list to identify items that are two handed. This is like a 
regular keyword list. 

Technical notes: 
When unequipping items, the game doesn't distinguish between items that 
are dual wielded and items that are two-handed. This complicates things 
because the mod, at the moment, can only tell the game "toggle the 
equipped state of this item for this hand". So, since the mod can't tell 
the difference between these kinds of items, if the mod says "unequip 
left and right" on a two-handed item, the item is unequipped, then 
equipped again. If the mod says "unequip left" or "unequip right" on a 
dual wielded item, then only one hand gets unequipped. 

shout_power_names
A keyword list of the names of all the shouts and powers.

Technical notes:
The game tells the favorites menu the equipped state of an item. An item 
can be "not equipped", "equipped", "equipped to left hand", "equipped to 
right hand", and "equipped to both hands". When unequipping both hands 
with the "unequip_hand" config option, the favorites menu can't tell the 
different between, say, a shield that's equipped to the left hand and a 
power that is equipped because they are both show as simply "equipped". 
Thus this list is needed. This is listed separately from the shouts / 
powers item [list] so that the shout/powers [list] can be removed 
without affecting unequipping. 

left_hand_equip_only
A keyword list of the items that are left-hand-equip only, like shields.

Technical notes:
This is again to support unequipping items. A shield for example doesn't 
show up as "equipped to left hand" to the favorites menu, but rather as 
simply "equipped", so the mod can't tell the difference between it or 
say a shout or a power which also show up as just "equipped". 

show_border
If true, a red border is drawn around the item mouse hit boxes. Mostly
for debugging layouts.


[layout] Section Options

row_vertical_spacing
Number of pixels between rows to space them out vertically.

row*
A list of list names to lay out, including spacer lists. The names
should be as they appear in "name =" field of the [list] section. You
can have row1, row2, row3, up to row9.

row*_height_list
Since lists can be of any height, and can take up multiple rows, the
height of a row has to be specified. Specify the name of a list to use
to determine the height of this row. The list specified here must be
enabled. Also don't specify a spacer list (they have no height). This
should be paired with a row:

	row1 = Hotkeyed, Potions, Shouts/Powers, Magic, Equip Sets
	row1_height_list = Hotkeyed
	row2 = Apparel, spacer1, Weapons, spacer2, Other
	row2_height_list = Apparel
	...


[list] Section Options

name
The name of the list. This is displayed above the list in the menu as
the menu's title. This name is also used in the [layout] section, and
for sublists to specify their parent lists with "parent_list".

type
The type of this list. One of "hotkey", "keyword", "other", "equipset"
and "spacer".

enabled
If set to false, then this list doesn't appear in the menu, and its
items will appear in other lists.

num_entries
The number of items to display in this list. A list can take up multiple
rows. Use a spacer below this list in the [layout] section to make room
for long lists.

keywords
The set of keywords that this list will use to match items. See
Keyword Lists above.

excludes
The set of keywords to use to exclude items from this list. See
Keyword Lists above.

include_sublist_keywords
If set to true, then the keywords of any sublists this list has will be
included in this list's keywords. This is useful to avoid having to
repeat lots of keywords in a config file (eg, the Magic list).

title_color
The color of this list's title. HTML color code.

width
The width of this list in pixels.

entry_height
The height of each of this list's entries in pixels.

entry_font_size
The font size of each of this list's entries. Use in conjunction with
entry_height.


[sublist] Section Options

name
The name of this sublist. This nameappears in this sublist's parent list
as a divider. A colon ":" is not automatically appended to the name,
it should be added manually if you want one.

enabled
If this list is not enabled, then its items will go into the "Other"
sublist.

parent_list
The name of a list that this sublist does under. This should be the name
of a list exactly as it appears in the "name = " field of a [list]
section.

keywords
The set of keywords that this sublist will use to match items. See
Keyword Lists above.

excludes
The set of keywords to use to exclude items from this sublist. See
Keyword Lists above.

title_color
The color of the this sublist's divider that will appear in the parent
list. See sublist_name above.

[equipset] Section Options

name
The name of this equipset, which will appear in the Equipset List in the
menu.

equipment
A keyword or keywords to use for an item. This field may be repeated.
It may also include an option for which hand the item should be equipped
to. For example, to dual wield the Flames magic, use

	equipment = Flames, dual

To equip Ice Spikes to the left hand, Frostbite to the right, and the
Ice Form shout, use

	equipment = Ice Spike, left
	equipment = "Frostbite", right
	equipment = Ice Form
	
Frostbite is in quotes so it doesn't match the weapon "Staff of
Frostbite"

See Equipsets above.

hotkey
The hotkey to use for this equipset. A number 0 to 9. Equipset hotkeys
are used with the equipset_hotkey_modifier_key option. The default
is ctrl. The favorites menu must be open for these to work.

unequip_others
If set to true, then anything not in this equipset will get unequipped
when this equipset is equipped. This includes shouts, powers, armor,
weapons, magic, etc.

unequip_hands
This can be set to "right", "left", or "both" to unequip the respective
hand when this equipset is equipped.

Note that there is currently a small glitch in unequipping two-handed 
weapons: When you unequip a two-handed weapon, the game will usually try 
to re-equip wahtever you had equipped before you equipped the two-handed 
weapon. The mod cannot currently effectively unequip whatever the game 
tries to reequip for you.