﻿
========================================================================
Categorized Favorites Menu v0.1.17 (Dec 16, 2012)
========================================================================

This mod replaces the single favorites menu with several categorized
favorites menus, with subcategories. Use the mouse and mouse wheel, 
or WASD or the arrow keys to navigate. Ctrl+mouse wheel switches
between lists.

Menus can be configured in favoritesmenu.cfg. See this file for
details on how to customize the menus.
Use an editor like Notepad++, with an encoding of
UCS-2 Little Endian / UTF-16LE with BOM (particularly for translations).
ANSI / UTF-8 works for English language configs.

Requirements:

SKSE 1.4.13 is required for saving settings from the game (menu position,
equipset creation, etc) and for the auto-favorites mod. SKSE can be
downloaded from

    http://skse.silverlock.org/
    
The mod can be used without
SKSE, but you won't be able to create equipsets in-game or save the
position of the menu.

Recommended minimum resolution is 1024x768.

Features:

- Categorizes favorited items into separate lists.
- Each list can have sub-categories, for organizing your items further.
- Automatically add specific items to the favorites menu (eg potions).
- "Equip sets" for equipping different sets of favorited items
  (experimental). See "Equip sets" below.
- The menu and lists are configurable in favoritesmenu.cfg, with many
  configuration options, including:
  - Menu position on screen
  - Width and length of lists (individually configurable per list)
  - Layout of the lists
  - List text alignment (left or right alignment)
  - Font sizes and colors
  - Separate hotkey colors
  - Custom lists by item name

Keyboard shortcuts:

- 0 to 9 with item selected: Hotkey selected item.
- Ctrl + w/a/left/right: Moves the menu up/down/left/right 5 pixels.
  Hold ctrl+shift to move by 1 pixel.
- Ctrl + f: Create an equipset from the currently equipped items.
- Ctrl + delete: Delete the selected equipset.
- Mouse wheel: scroll list
- Alt + mouse wheel: scroll list faster
- Ctrl + mouse wheel: switch lists

Compatible with:

- SkyUI
- QD Inventory
- HeadBomb's Better Sorting Mod version 1.65+ (see compatibility section
  below)
- Xbox controller on PC: Some people have reported that it works fine,
  others that it doesn't. Try using left/right on the left stick to
  go between lists.
- English, Italian, German, French, Spanish, and Russian versions of
  Skyrim (see translations below).
- See the Compatibility section below for more details.


========================================================================
Equip sets
========================================================================

Equip sets allow you to specify a set of equipment to equip all at once.
This is an experimental feature, so it might not work perfectly.
Unfortunately, the game doesn't allow the favorites menu to write to a
file on disk, so equip sets have to be configured manually in the
config file. (This will hopefully be improved).

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. 

When you select an equip set, its items will get equipped. Any items
that are already equipped will not be unequipped, unless they're being
"overriden". That is, if I have Steel Armor, a Shield, and a Sword
equipped, and I select an equip set that has Flames and Frostbite,
the Steel Armor will still be equipped. If all the items of an equip
set are equipped in the correct places, then it will be displayed
with an equipped icon.

Equip sets can also have hotkeys. They can be assigned ctrl+0 through
ctrl+9. The modifier key to use can be configured in the config file
(eg, alt+1, shift+1). Hotkeys can be disabled if they interfer with
another mod. The favorites menu must be open for these hotkeys to work.


========================================================================
Custom Configuration Files
========================================================================

For customized configuration files that you might want to share,
I recommend posting the file to skyrim nexus as a new file. Add 
your link and/or screenshot to the files at the "Custom Configurations"
discussion topic:
http://www.thenexusforums.com/index.php?showtopic=512392.
If it's popular, I can link to the config here, or include them in
the distribution. Please include only your config file, not the SWF file
(favoritesmenu.swf), and clearly indicate that your file is a
configuration file.

Please also do not post this mod to another website. Please
link to the mod page here at skyrimnexus, as this page will
have the most up-to-date information and versions.


========================================================================
Installation
========================================================================

Copy favoritesmenu.swf and favoritesmenu.cfg to the
"<game directory>\Data\Interface" folder. For Steam, this is typically
"C:\Program Files\Steam\steamapps\common\skyrim\Data\Interface"


========================================================================
Uninstallation
========================================================================

Delete favoritesmenu.swf and favoritesmenu.cfg from the game folder.


========================================================================
Compatibility
========================================================================

This mod was developed and tested with Skyrim version 1.3.10.0 from
Steam. This mod has not been tested with the Xbox, PlayStation, or
non-Steam PC versions of Skyrim.

This mod should work with the xbox controller on PC, though I haven't
personally tested it. Should also be compatible with SkyUI and
QD Inventory.

Unfortunately, the game doesn't give the favorites menu any information
about favorited items -- just its name, hotkey, and some index values.
So, the mod has to resort to keyword matching. This means that (for now)
the default configuration will not work with mods that change item/spell
names. It also means the default configuration will work with only the
English version of Skyrim. See "Translations" below. You can add/modify
any miscategorized items, or translate item names by editing the
favoritesmenu.cfg file. Patches welcome!

For HeadBomb's Better Sorting mod, see "Compatible with" above.
However, the following users have created config files that are or were
compatible with Better Sorting:
http://www.skyrimnexus.com/downloads/file.php?id=5241 by Niss
http://www.skyrimnexus.com/downloads/file.php?id=5405 by clsShadow


========================================================================
Translations
========================================================================

The following links are to translations of the config file.
These translations are the work of other modders and users.
To translate the config file, make sure you save the file using
UTF-16 encoding (the config file for v0.1.5+ is in UTF-16LE).
Please include only the config file, not the SWF file
(favoritesmenu.swf).

Italiano:
http://www.skyrimnexus.com/downloads/file.php?id=4935

Deutsch:
http://www.skyrimnexus.com/downloads/file.php?id=4941
http://www.skyrimnexus.com/downloads/file.php?id=4948

Français:
http://www.skyrimnexus.com/downloads/file.php?id=5072

Español:
http://www.skyrimnexus.com/downloads/file.php?id=5140

Russian:
http://www.skyrimnexus.com/downloads/file.php?id=5613
http://www.skyrimnexus.com/downloads/file.php?id=5468

Polish:
http://www.skyrimnexus.com/downloads/file.php?id=5725


========================================================================
Credits
========================================================================

Bethesda for creating Skyrim, and skyrimnexus for creating this forum.


========================================================================
Links
========================================================================

Categorized Favorites Menu on skyrimnexus:
http://www.skyrimnexus.com/downloads/file.php?id=4862

Discussions and posts for different config files:
http://www.thenexusforums.com/index.php?showtopic=512392

Auto-favorites mod on skyrimnexus:
http://skyrim.nexusmods.com/downloads/file.php?id=7364


========================================================================
Version History
========================================================================

v0.1.17 (Dec 16, 2012)

- Updated for Skyrim 1.8.151.0 / SKSE 1.6.5

v0.1.16 (Oct 21, 2012)

- Updated for Skyrim 1.8.145.0 / SKSE 1.6.2

v0.1.15 (Jun 6, 2012)

- Updated for Skyrim 1.6.89 / SKSE 1.5.9

v0.1.14 (Apr 1, 2012)

- Updated for Skyrim 1.5.26 / SKSE 1.4.15

v0.1.13 (Mar 24, 2012)

- Updated for Skyrim 1.5.24 / SKSE 1.4.14

v0.1.12.1 (Mar 16, 2012)

- Corrected spelling of "bradonbane" in config file.

v0.1.12 (Mar 3, 2012)

- SKSE plugin CFM_extensions and auto-favorites updated for
  Skyrim 1.4.27 / SKSE 1.4.13

- Minor updates to the config guide for clarity

- Added the following items to the weapons list: chillrend,
  bragonbane, blackblade, blackbow, dawnbreaker, keening, razor,
  sanguine rose, skull of corruption, staff of magnus, volendrung,
  wabbajack, and wuuthrad

- Added the dragon priest masks to the apparel list (Hevnoraak,
  Konahrik, Krosis, Morokei, Nahkriin, Otar, Rahgot, Vokun, Volsung)
  
v0.1.11.2 (Feb 3, 2012)

- Removed auto-favorites SKSE plugin until it's fully compatible with
  Skyrim 1.4.21

v0.1.11.1 (Feb 2, 2012)

- SKSE plugin CFM_extensions and auto-favorites updated for
  Skyrim 1.4.21 / SKSE 1.4.10

v0.1.11 (Feb 2, 2012)

- SKSE plugin CFM_extensions and auto-favorites updated for
  Skyrim 1.4.21 / SKSE 1.4.8

v0.1.10 (Jan 29, 2012)

- Auto-favorites mod bundled. Available for only Skyrim 1.3.10 and
  SKSE 1.4.3 at this time. See auto_favorites-README.txt. Auto-favorited
  items will appear with a "(A)" to distinguish it from regularly-
  favorited items, configurable with "auto_favorite_prefix".

- Equipset creation key configurable with "equipset_create_key". This
  is a Flash key code.

- Added a "Resistance" sublist to the potions list.

v0.1.9.3 (Feb 2, 2012)

- Updated SKSE plugin CFM_extensions.dll (again) for SKSE 1.4.8 /
  Skyrim 1.4.21

v0.1.9.2 (Jan 31, 2012)

- Updated SKSE plugin CFM_extensions.dll for SKSE 1.4.8 / Skyrim 1.4.21

v0.1.9.1 (Jan 28, 2012)

- Updated SKSE plugin CFM_extensions.dll for SKSE 1.4.7 / Skyrim 1.4.20

v0.1.9 (Jan 26, 2012)

- Removed the runtime check from CFM_extensions.dll for version 1.4.
  The runtime check wasn't actually needed.


v0.1.8.2 (Jan 22, 2012)

- Turned off debug messages, which was accidentally left on in v0.1.8.1

- Fixed glitch with saving unequip options when creating an equipset.

v0.1.8.1 (Jan 22, 2012)

- Fixed equipset hotkeys which broke in v0.1.8.

v0.1.8 (Jan 22, 2012)

- The menu can be positioned in the game. This requires SKSE to save the
  new settings. To move the menu, use:

    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.
  
  The new position is saved in a file called
  favoritesmenu_overrides.cfg. Any setting in that file will override
  the corresponding setting in the [config] section of
  favoritesmenu.cfg (these settings are saved in a separate file to
  avoid encoding conflicts). You can adjust settings in that file, but
  any comments you write in the file will be removed the next time the
  file is generated.
  
  The game captures the "key held" event for some keys, which is why
  you have to use left/right and w/s. You can use up/down and a/d, but
  you'll have to keep tapping the keys.

- Equipset can now be created in game. This requires SKSE. Equip the set
  of equipement that you want in the equipset, and press ctrl+f (f for
  favorite) and a dialog will prompt you for the equipset's name and
  settings (the dialog is admittedly crude).

  Equipsets are saved to a file called "favoritesmenu_equipsets.cfg"
  In some cases you may still have to edit 

- Equipset can be deleted in game. Select the equipset you want to
  delete and press ctrl+delete.

- Equipsets are no longer read from the favoritesmenu.cfg. They are now
  read from favoritesmenu_equipsets.cfg. Move your equipsets from
  favoritesmenu.cft to favoritesmenu_equipsets.cfg.
  
  If favoritesmenu_equipsets.cfg isn't found or is empty, then any
  equipsets from favoritesmenu.cfg are used, but if you create any
  equipsets in-game, then favoritesmenu_equipsets.cfg will be created
  and the equipsets in favoritesmenu.cfg will be ignored.

- SKSE is required to save settings (equipsets, menu position, etc). See
  above bullets.

- An HTML configuration guide is included in this version. Most comments
  from favoritesmenu.cfg have been removed and the file's fields are now
  documented in categorized_favorites_menu_config_guide.html. Removing
  the comments from the config file will also decrease menu opening
  time an imperceptible amount.

- If favoritesmenu.cfg can't be read for some reason, then a warning
  message is displayed. Previously, if the config file couldn't be read,
  then no UI components were created, and there was nothing for keyboard
  events to go to, so the menu couldn't be closed, forcing you to close
  the game to get out of the menu.

- Added an "unequip_hands" option to equip sets. This can be set to
  "left", "right", or "both", and anything in the corresponding hand(s)
  will get unequipped.
  
  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. 

- Added an "unequip_others" option to equip sets. Anything not in the
  equipment list of the equip set will get unequipped if this is set to
  true ("unequip_others = true"). This includes apparel, shouts, powers,
  weapons, arrows, magic, etc. See the above note about the two-handed
  weapon unequip glitch.

- "equipsets" no longer needs to be specificed for an equipset list.
  All equipsets go into the (single) equipset list.

- Added up/down indicators to the sides of lists to show when there
  are more items.

- The mouse wheel now scrolls lists instead of moving the selection
  up or down. Hold alt to scroll faster (2 items at a time instead of
  one).

- Included some more sample configs. See
  categorized_favorites_menu_sample_configs folder

- "other" sublists are now sorted alphabetically.

- Includes the Russian language encoding fix by V10:
  http://www.skyrimnexus.com/downloads/file.php?id=5613
  
  If "fix_russian = true" is set in the config file, then the game's
  Win1251 text is translated to UTF-8.

- Added "aversion" to potions list. "aversion" was added to the poisons
  sublist in v0.1.7, but not to its parent list. Added "Lightning Bolt"
  to weapons excludes lists so it's not matched with the "bolt" for
  arrows.

v0.1.7 (Jan 8, 2012)

- Each list can have a different length (number of items displayed) and
  a different width (in pixels). See the config file for how to
  configure this.

- Added "Equip Sets" and equip lists for creating sets of items to
  equip all at once. See the "Equip Sets" section above, and the
  config file.

- Lists can be left aligned or right alginged. Configurable with
  "list_alignment" in the config file. Selector icon, equip icons,
  and list title are also aligned.

- Changed the centering behavior of the lists. It now scrolls more like
  a text document. There is a slight bug in its behavior. When going
  from navigating with the mouse to the keyboard, the list can recenter
  itself, which may look odd. For example, scroll to the middle of a
  long list, then select the last displayed item with the mouse,
  then press W. The list will recenter on the selected item.

- Holding down control and scrolling with the mouse wheel switches
  between lists. Which modifier key to use can be configured with
  "mouse_wheel_list_switch_modifier_key".

- Added a [layout] section to make rearranging things easier. See the
  config file.

- Hotkeyed items can appear in the hotkey list and in other lists,
  configurable with "repeat_hotkeyed_items" in config file.

- Added a "spacer" list type, for creating space between lists, so that
  long lists can flow down into the rows below them.

- If any settings are missing from the [config] section, the default
  values from the included default config file are used. This is for
  backwards compatibility with earlier config files.

- If a keyword in a keyword list is surrounded by quotes, then that
  keyword must match the item name exactly. This is useful for
  equip sets.

- If "include_sublist_keyword = true" is set in a [list] section, then
  the list's sublist's keywords are added to the parent list, so that
  the keywords don't have to be duplicated in the [list] and [sublist]
  sections. A sublist's excludes are not added to the parent list.

- Added a separate archive that may solve the left/right click equip
  problem for some people. Thanks to villian123 at skryimnexus.

- The list delimiter used to split the lists in the config file is
  configurable with "list_delimiter", in the case of mods that use
  a "," in item names. The keyword lists must be updated if the
  delimiter is changed.

- Fixed an issue with items with more than 35 charaters not getting the
  correct hotkey coloring.

- The name of the "other" sublist can be configured with
  "sublist_other_title" config option.

- Sublists don't automatically append a colon (":") to the end of its
  section head / divider / name.

- The color of the list's titles are configurable with
  "default_title_color". Each list's title is individually configurable
  with "title_color" in a [list] section. These are HTML color codes.

- The color of each sublist header / name is individually configurable
  with "title_color" in a [sublist] section. "divider_color" config
  option is renamed to "default_sublist_title_color". These are HTML
  color codes.

- Default config changes:
  - Added "poison" to the health potions sublist to exclude health
    poisons
  - Added "venom" and "aversion" to poisons sublist.
  - Added "shiv" to weapons list
  - Added "scroll of" to magic list
  - Added "damage,drain" to excludes of health and stamina sublists
  - "include_sublist_keyword = true" set for the Magic list, and its
    keywords (except for "scroll of") are removed.
  - Added "Arrows" sublist to Weapons list

- Significant code cleanup.

v0.1.6 (Jan 2, 2012)

- Sublists added. Each list can have a set of sublists that items
  are categorized into, eg in the potions list, "Magicka", "Stamina",
  "Health", and "Poisons" sections. See the config file for how to
  configure these.

- Fixed the issue with the list titles not picking up the right font.
  The titles should pick up "$EverywhereMediumFont" variable.
  The "title_font_name" configuration option is now obsolete.

- Hotkey colors are configurable with "hotkey_color" in the config file.

- Sublist divider / section header color is configurable with 
  "divider_color" in the config file.

- Renamed this readme file to "CategorizedFavoritesMenuREADME.txt".

v0.1.5 (Dec 31, 2011)

- Added an exclude list to keyword lists. An item will match a list
  only if the item's text matches a keyword in the keyword list and does
  not match a keyword in the exclude list. This fixes issues with spells
  like "Frostbite" and items like "Staff of Frostbite" being
  miscategorized, and other issues like the shout "Elemental Fury"
  being categorized under magic.

- Converted config file to unicode (UTF-16LE) to make translations
  easier.

v0.1.4 (Dec 29, 2011)

- With whole word matching in v0.1.2, "hammer" wouldn't match
  "warhammer", "axe" wouldn't match "battleaxe", and "sword" wouldn't
  match "greatsword". Added these to the default config.

v0.1.3 (Dec 29, 2011)

- Added background behind lists to increase readability. Configurable
  in favoritemenu.cfg with background_* settings.

- Title fonts configurable with title_font_name.

- Added "venom" to potions keyword list to match "Frostbite Venom",
  which was getting miscategorized as magic (from "Frostbite"). This
  should work so long as the potions list comes before the magic list.

- Minor adjustment to default menu base x and y (so there are 16 pixels
  on the left and bottom of the menu from the screen's edge on 1024x768)

- Renamed "Armor/Clothes" to "Apparel" for consistency.

v0.1.2 (Dec 29, 2011)

- Added greater and lesser powers to Shouts (now "Shouts/Powers") list.

- Added "poison" to Potions list.

- Now uses whole word matching instead of simple
  "anywhere in the item's name" matching. Eg, "Mammoth Cheese Bowl"
  now won't match the "bow" keyword in the Weapons list.

- Font size of each list's title is configurable in favoritesmenu.cfg
  with "title_font_size"

- Converted the line endings in favoritesmenu.cfg to windows style
  CR\LF (for editing in, eg, notepad).

v0.1.1 (Dec 29, 2011)

- Compatible with Nexus Mod Manager

v0.1 (Dec 29, 2011)

- Initial Release
