Nexus Description - schlangster/skyui GitHub Wiki

[center][img]http://www.skyrimnexus.com/downloads/images/3575-1-1323804616.png[/img][/center] [center][b]Team:[/b] snakster, Mardoxx, T3T [b]Contributors:[/b] ianpatt, behippo, Kratos, psychosteve, MisterPete, GreatClone, gibbed, PurpleLunchBox, Gopher, Indie

[b]Current Version: [color=#7cbeff]3.1[/color][/b] [b][color=#7cbeff]LAST UPDATE ON JANUARY 8th 2013[/color][/b] For a list of recent changes, click the version number on top of this page.

[/center]

[center][img]http://www.skyrimnexus.com/downloads/images/3575-1-1323885625.png[/img] The [url=http://skse.silverlock.org]Skyrim Script Extender (SKSE)[/url], Version 1.6.6 (or newer) is [b]REQUIRED[/b] to run SkyUI.

In case you have any problems or questions, please take a look at the [color=#7cbeff]Troubleshooting[/color] and [color=#7cbeff]FAQ[/color] sections at the bottom of this description page first. [/center]

[center][img]http://www.skyrimnexus.com/downloads/images/3575-2-1323876488.png[/img][/center] SkyUI is a mod that aims to improve Skyrim's User Interface by making it easier to use with mouse and keyboard, less wasteful of available screen space, and nicer to look at.

We do all that while keeping true to the style of the original UI, so new and old components are integrated seamlessly.

It is not our goal to re-create the complete interface from scratch. Instead we try to identify and change areas that need improvement, while leaving the things that are already good alone.

Further general objectives and design concepts are: [list] [*] Finding a good balance between 'dumbed down' and 'information overkill'.

[*] Easy installation and setup.

[*] Blending features in as well as possible - players shouldn't feel reminded that they're using a mod.

[*] Support for user customization. [/list]

Since improving the whole UI is a big undertaking, we only release single menus at a time as progress is made. The following sections give an overview of what's included so far, as well as what we plan to address next.

[center][img]http://www.skyrimnexus.com/downloads/images/3575-1-1323875765.png[/img][/center][img=center]http://skyrim.nexusmods.com/mods/images/3575-1-1356986436.png[/img] The player inventory has been changed from the original two-list-layout to a single, big panel.

Included features: [list] [*] Icons to replace the text-based category list.

[*] Colored icons for each item type.

[*] Configurable text size, so more entries can be displayed at once.

[*] Extra columns to include additional item information. Examples are weight and value in general, and damage or armor rating for specific categories.

[*] Sortable columns to order items by a specific stat. Multi-state columns to quickly single out equipped, stolen, enchanted or poisoned items.

[*] Additional status icons to flag stolen, enchanted and poisoned items.

[*] Full-text search through the inventory.

[*] Intuitive and efficient keyboard navigation, as well as support for gamepads.

[*] Configurable Itemcard and 3D Item positions to support multi-monitor resolutions.

[*] Columns can be shown or hidden on-the-fly with the Customize button next to the filter box.

[*] Button art is no longer static but matches the current control mapping. [/list]

[center][img]http://www.skyrimnexus.com/downloads/images/3575-2-1325977674.png[/img][/center][img=center]http://skyrim.nexusmods.com/mods/images/3575-1-1356980996.png[/img] The barter and container menus use a panel similar to the new player inventory, including all its features like sorting and searching.

Additional features: [list] [*] Two tabs to toggle between the player and vendor/container views.

[*] Carry weight is now displayed in the bottom bar when bartering.

[*] Tweaked menu controls for the container menu. No more accidental 'Take All' when you wanted to 'Store'. [/list]

[center][img]http://www.skyrimnexus.com/downloads/images/3575-1-1323877799.png[/img][/center][img=center]http://static.skyrim.nexusmods.com/mods/images/3575-1-1356981322.png[/img] The magic menu layout has been adapted to fit with the other new menus as well. The panel is now at the left side for a consistent look and feel.

Icons for each magic type make it easy to identify them in combined views, and new sorting options will prove especially useful for spellcasters: [list] [*] Organize spells by skill level, spell cost, duration or magnitude.

[*] Sort dragon shouts by level and recovery time.

[*] List active effects by source and remaining time. [/list]

[center][img]http://skyrim.nexusmods.com/mods/images/3575-2-1356963747.png[/img][/center][img=center]http://skyrim.nexusmods.com/mods/images/3575-1-1356963747.png[/img] The Mod Configuration Menu (MCM) for Skyrim is an in-game configuration panel that's part of SkyUI since version 3.0. The concept was adopted from the [url=http://newvegas.nexusmods.com/mods/42507]original MCM for Fallout: New Vegas[/url]. This panel was not just made for SkyUI options alone; other mods can add their configuration menus, too!

For a lot of mod authors, allowing customization is important and they spend considerable time making their mods as configurable as they can. But so far, presenting these options to the player in a user-friendly way has been difficult.

The MCM addresses this problem and provides several advantages for both players and mod authors: [list] [*] A 'Mod Configuration' option is accessible from the pause menu - there's no more need for immersion-breaking menu items or spells that clutter the player's inventory.

[*] Options can be presented with proper UI elements (sliders, sub-menus, checkboxes, color-pickers, button icons etc.).

[*] Scalability - each mod menu can have up to 128 sub-pages, each containing up to 128 options.

[*] Localization capabilities for all languages that are supported by the game.

[*] A simple, yet flexible API, extensive documentation and examples to enable easy and rapid development.

[*] Usable with mouse, keyboard and gamepad. [/list] If you are a mod author interested in using MCM, have a look at the [url=https://github.com/schlangster/skyui/wiki]documentation[/url].

[size=4]Mods with MCM support:[/size] The number of mods utilizing MCM is growing steadily! [url=http://skyrim.nexusmods.com/articles/884/]You can find a current list in this article[/url].

[center][img]http://www.skyrimnexus.com/downloads/images/3575-1-1325977672.png[/img][/center] Coming next. Or maybe after next.

[center][img]http://www.skyrimnexus.com/downloads/images/3575-1-1323876487.png[/img][/center] [b][color=#FF0000]IMPORTANT:[/color][/b] If you were using older versions of SkyUI (including 3.0-alpha), you must remove them before installing the new one. Letting NMM handle the updating works fine, too.

[b][size=4]Automatic Download with NMM[/size][/b] [list] [] Click the [color=#7cbeff]Download with manager[/color] button on top of the file. [] SkyUI will appear in in NMM's [color=#7cbeff]Mods[/color] list once it's downloaded. Double-click the [color=#7cbeff]SkyUI[/color] entry to [color=#7cbeff]Activate[/color] it. [/list]

[b][size=4]OR[/size][/b]

[b][size=4]Manual Download with NMM[/size][/b] [list] [] Start NMM and click on [color=#7cbeff]Mods[/color]. [] In the left icon bar, click on [color=#7cbeff]Add Mod From File[/color] and select the downloaded archive file. [*] SkyUI will now appear in the list. Double-click to [color=#7cbeff]Activate[/color] it. [/list]

[b][size=4]OR[/size][/b]

[b][size=4]Manual Installation[/size][/b] [list] [] Locate the [color=#7cbeff]Data/[/color] folder in your Skyrim [color=#7cbeff]installation directory[/color]. Typically it's found at [color=#7cbeff]Program Files/Steam/steamapps/common/skyrim/Data/[/color]. [] Extract the contents of the downloaded archive file to your [color=#7cbeff]Data/[/color] folder. [*] In the Skyrim Launcher, select [color=#7cbeff]Data Files[/color] and enable [color=#7cbeff]SkyUI.esp[/color]. [/list]

[center][img]http://skyrim.nexusmods.com/mods/images/3575-1-1357224163.png[/img][/center] Before uninstalling any files of SkyUI 3.0 or newer, it is recommended to make a clean save game with SkyUI deactivated. [list] [] Start the Skyrim Launcher and select [color=#7cbeff]Data Files[/color]. [] Search for [color=#7cbeff]SkyUI.esp[/color] and uncheck it. If you don't have this file, there's no need for a clean save and you can skip it. [] In-game, load your latest save, then save the game again. [] This new save game is now cleaned of SkyUI data. Repeat for any other saves you want to clean. [/list]

The uninstallation method depends on which SkyUI version you were using before and how you installed it. Any SkyUI version older than 3.0 has to be removed before upgrading.

For details, see the following instructions that match your current SkyUI version/installation method.

[b][size=4] NMM installation / Any SkyUI version[/size][/b] In NMM's mod list, search for the SkyUI entry and deactivate the mod.

[b][size=4] Manual installation / SkyUI 2.2 or older[/size][/b] If you installed the SkyUI files manually, you also have to remove them manually. View the contents of the SkyUI archive you are using, look for each file at its install location and remove it. If this fails, consider removing your interface folder and use Steam to revert it to its original state (see [color=#7cbeff]Troubleshooting[/color]).

[b][size=4] Manual installation / SkyUI 3.0 alpha versions[/size][/b] The 3.0 alpha packages contained loose script files requires by mod authors to create MCM config menus. You have to remove these files when using newer versions. [list] [] Locate the [color=#7cbeff]Scripts/[/color] folder in your Skyrim [color=#7cbeff]installation directory[/color]. Typically it's found at [color=#7cbeff]Program Files/Steam/steamapps/common/skyrim/Data/Scripts/[/color]. [] Delete any script files (.pex) that start with SKI, for example SKI_ConfigBase.pex, SKI_Main.pex, etc. [*] Delete [color=#7cbeff]SkyUI.esp[/color] and [color=#7cbeff]SkyUI.bsa[/color] from the data folder. [/list]

[b][size=4] Manual installation / SkyUI 3.0 or newer[/size][/b] [list] [] Locate the [color=#7cbeff]Data/[/color] folder in your Skyrim [color=#7cbeff]installation directory[/color]. Typically it's found at [color=#7cbeff]Program Files/Steam/steamapps/common/skyrim/Data/[/color]. [] Delete [color=#7cbeff]SkyUI.esp[/color] and [color=#7cbeff]SkyUI.bsa[/color] from the data folder. [/list]

[center][img]http://www.skyrimnexus.com/downloads/images/3575-2-1323877800.png[/img][/center] [b]Problem[/b]: There's an error message telling me about a problem with the Skyrim Script Extender (SKSE).

There are two things that can cause this: [b]1.[/b] You didn't install the Skyrim Script Extender (or you set it up incorrectly). Get it from [url=http://skse.silverlock.org]here[/url] and follow the included instructions.

[b]2.[/b] Everything was fine before, then Skyrim was patched to a new version and the message started appearing. This is because each new patch also requires an update of SKSE. So just you'll just have to wait until that is released, then get the new version and everything should be back to normal.

If you have problems installing or running SKSE, have a look at [url=http://www.youtube.com/watch?v=xTGnQIiNVqA]Gopher's video guide[/url].

[b]Problem[/b]: There's an error message telling me about a version mismatch for an interface file.

This most likely means that you didn't properly uninstall a SkyUI alpha version. Refer to the Uninstallation section and make sure you really removed everything, and then install the new version again.

[b]Problem[/b]: There's an error message telling me about a missing or incompatible interface file.

There are two things that can cause this: [b]1.[/b] You didn't uninstall an old version of SkyUI (2.2 or older) before upgrading. Refer to the Uninstallation section and make sure you really removed everything, and then install the new version again.

[b]2.[/b] There's another mod that overrides a particular menu file SkyUI is modifying. If this is the case, you might have to chose one of the two mods.

If you want another mod to be able to override certain menu files of SkyUI while keeping the rest, you can disable these warning messages individually in the SkyUI configuration menu (Advanced page).

[b]Problem[/b]: There are dollar signs ($) in front of all words in the main menu (and in lots of other places, too)!

Solution: This happens if you accidently removed [color=#7cbeff]Data/Interface/Translate<language>.txt[/color]. To restore it, use Steam to verify the integrity of Skyrim's game-cache (Steam -> Library -> Properties of Skyrim -> Local files tab -> Verify integrity of game cache).

[center][img]http://www.skyrimnexus.com/downloads/images/3575-3-1323877800.png[/img][/center] [b]Question[/b]: Do you support older versions of the game?

No. SkyUI requires the Skyrim Script Extender to be fully functional, which in turn requires you to have the latest version of the game. If SKSE could not be detected, a warning message will be displayed. The purpose of this message is not harassment, but to warn users that SKSE was not installed correctly, and to avoid false bug reports that would otherwise result from this.

[b]Question[/b]: What's the meaning of the small icons after the item name in the inventory?

Yellow star: Favorite Diamond: Best item in class Red hand: Stolen Blue bolt: Enchanted Green drop: Poisoned

[b]Question[/b]: Where is the Value/Weight column?

[url=http://static.skyrim.nexusmods.com/mods/images/3863-1-1357326608.jpg]Here[/url].

[b]Question[/b]: How can I access this menu with a controller?

Hold 'Order' for one second (default LT).

[b]Question[/b]: Against better advice, I used to run SkyUI without SKSE. For version 3.0, a lot of things are broken now. Make a non-SKSE version?

Pretty much all new features of 3.0 would not be possible without SKSE. Best keep using 2.2.

[b]Question[/b]: Where can I learn more about using the MCM for my mods?

Check out the [url=https://github.com/schlangster/skyui/wiki]official documentation[/url].

[b]Question[/b]: Is there going to be a standalone version version of the MCM?

Probably not. But what you can do is use [url=http://skyrim.nexusmods.com/mods/29440]this mod[/url] to override all SkyUI menu files besides the MCM with their default versions.

[b]Question[/b]: I heard SkyUI is not controller-friendly. Is it true?

It's not true. SkyUI can be used with mouse/keyboard, but also with a controller.

[b]Question[/b]: Can you send me the SkyUI source code? May I contribute something to the project?

Here's the [url=https://github.com/schlangster/skyui]SkyUI repository on GitHub[/url]. If you want to contribute, just fork the repository and do what you want to do. If we think it's good, we'll merge it :)