Difference between revisions of "User Interface Overview"

From Nexus Mods Wiki
Jump to: navigation, search
(Automation)
(Automation)
Line 158: Line 158:
  
 
==== Automation ====
 
==== Automation ====
[[File:UI20.JPG]]
 
 
 
Deploy mods when Enabled: Toggles between automatic and manual deployment of mods. This option is turned on by default.
 
Deploy mods when Enabled: Toggles between automatic and manual deployment of mods. This option is turned on by default.
  
 
Run FNIS on Deployment Event: This option is limited to [https://www.nexusmods.com/skyrim/mods/11811 Skyrim] and [https://www.nexusmods.com/skyrimspecialedition/mods/3038 Skyrim SE]. If enabled, Vortex will run FNIS (Fore’s New Idles in Skyrim) on every mod deployment, ensuring that your animation and behaviour files are updated appropriately.
 
Run FNIS on Deployment Event: This option is limited to [https://www.nexusmods.com/skyrim/mods/11811 Skyrim] and [https://www.nexusmods.com/skyrimspecialedition/mods/3038 Skyrim SE]. If enabled, Vortex will run FNIS (Fore’s New Idles in Skyrim) on every mod deployment, ensuring that your animation and behaviour files are updated appropriately.
 +
 +
[[File:UI20.JPG]]
  
 
==== Dashlets ====
 
==== Dashlets ====

Revision as of 10:38, 3 October 2018

The Dashboard

This is the central hub in Vortex displaying the various dashlets that allow you quick access to your mod tools, new files, site news, and more. UI01.png

Managing Dashlets

You can move the dashlets around by clicking and holding the icon to the left of the X in the top right corner of the individual dashlet you would like to move. Dashlets can be disabled by clicking the X in the top right corner, or by accessing your settings, where you can choose which dashlet/widget to show.

ToDo List Dashlet

The dashlet labelled “Let’s get you set up” allows you to easily set up a managed game in Vortex:

UI02.png

  • “Introduction Video” - plays an introductory video that explains the basics of Vortex. Note that parts of the corresponding video series by Gopher might be outdated at this point in time.
  • “Handle Nexus Links” if set to “Yes”, all downloads initiated via the “Mod Manager Download” button on file pages on Nexus Mods will be handled by Vortex. If set to “No” Vortex will not handle these links.
  • “Profile Management” toggles Vortex’s mod profile functionality on or off.
  • “View Advanced Settings” toggles the advanced settings on (or off), giving you access to more involved options.
  • “Scan for missing games” launches the game search which will automatically look for any of the games supported by Vortex on your hard drive.
  • “FNIS Integration” - for Skyrim and Skyrim Special Edition only: this toggles the corresponding "Automation" setting. If enabled Vortex, will automatically update FNIS when you deploy a mod.

Starter Dashlet

This dashlet gives you quick access to various modding tools. Depending on the game, there might be one or several preconfigured tools, but you can easily add any custom or not preconfigured modding tool for quick access.

UI03.png

Recently Managed

This is a shortlist of the games that you have recently managed with Vortex. Click on “activate” on any of those to switch game mode and set them as the actively managed game.

Clicking the plus (+) in the top right corner will reveal meta data for the game as well as several options to e.g. open the corresponding game folder, mod folder, or Nexus Mods page. You can also manually change the game’s location.

UI04.png

New Files

The new files dashlet allows you to learn about the most recent mod uploads for the game you are currently managing from within Vortex. The dashlet displays the mod category, a header image, the mod name (which also serves as a link to the corresponding file page), a short description, as well as endorsements and total file downloads.

UI05.png

Latest News

This dashlet allows you to keep up to date with the latest Nexus Mods news, giveaways, and mod author interviews from within Vortex.

UI06.png

Changelog

The changelog contains information about what is new in your current Vortex version. You can also view past Vortex versions' changelogs by clicking "Previous" (click "Next" to navigate to more recent changelogs).

UI07.png

Issues Dashlet

If you have reported issues via GitHub, this dashlet will help you keep track of them.

Default view UI08A.png
With reported issues UI08B.png

Nexus Account Dashlet

This dashlet displays your avatar, username, and provides a link to your Nexus Mods profile.

UI09.png

ARC Support

This dashlets provides you with a convenient link to "Arctool" which is needed for some games such as Dragon's Dogma.

UI10.png

Navigation Area

Navigation in Vortex is facilitated by the navigation area on the left-hand side. You can collapse the navigation area in order to free up space for the main window. To do so, simply click the arrow button in the bottom left corner.

The navigation area is divided into two sub-groups: General and Mods.

UI11.png

Extensions

This is a list of Vortex extensions which can be enabled/disabled individually.

Extensions are modules that expand Vortex’s capabilities, without interfering with its core functionality. This allows us, as well as users, to create optional and additional modules for Vortex to e.g. managing new games, new types of mods, add tools etc.

To install extensions, drag and drop files into the dropzone at the bottom.

Profiles

See also: Setting up profiles in Vortex

Downloads

This is where all your mod downloads are listed. This includes mods directly downloaded via the “Mod Manager Download” button (if Vortex is set to handle those), as well as mod archives you drag into the field labelled “Drop URL(s) or File(s)” at the bottom of the screen.

Downloads can be sorted and/or filtered by Filename, Name (Mod name), Game, Download date, File Size, and Download Progress. Clicking the cog next to “Actions” on the right allows you to enable/disable individual sorting options.

UI12.png

The button between the dropzone (“Drop URL(s) or File(s)”) and the list of downloads can be used to quickly toggle between showing all downloads, or just downloads that have not been installed yet.

Downloaded mods can be easily installed from within the download section by clicking the “Install” button.

Games

This screen displays the games currently managed by Vortex, games that have been discovered i.e. found on your hard drive, and the complete list of games that are supported by Vortex.

You can perform a Quickscan for games installed on your hard drive by clicking the button in the top left corner.

In the top right corner, on the other hand, you can easily switch between list and grid view.

Grid view (Default) UI13A.png
List View UI13B.png

For your managed games, the “Activate” button on the game’s preview tile (corresponds to the checkmark in list view) switches the game mode to the selected game allowing you to add or manage your mods for that specific game.

In grid view, the plus (+) in the top right corner, unveils a context menu with metadata about the game, as well as some quick links to the game’s root directory, mod folder, and Nexus Mods page. From there, you can also set the game’s location manually or hide the game from being displayed in Vortex.

UI14.png

In list view, the plus (+) can be found on the right-hand side.

UI15.png

To display games that have previously been hidden simply click the “Show hidden games” button next to "Quickscan" in the toolbar:

UI16.png

Discovered games are games that Vortex has found on your hard drive, by conducting e.g. a Quickscan, but which are not yet managed by Vortex.

To manage them, simply click the button in the middle of the game’s preview tile (corresponds to the checkmark in list view).

Supported games is a list of all the games which Vortex is able to manage. Please note that games on your hard drive which have either been discovered by Vortex or games that Vortex is currently managing for you are not included in this list. If you do not wish to perform a game scan, you can set your games’ locations manually from this list by clicking the “Manually Set Location” button in the middle of the preview tile (corresponds to the three dots in list view).

See also: Adding a new game to Vortex

Support

Opens the Vortex section of our help centre allowing you to conveniently access documentation from within Vortex and find answers for e.g. the most frequently asked questions. You are currently viewing our support centre for Vortex.

Settings

Here you can access and define your settings and preferences regarding Vortex’s user interface and functionality.

UI17.png

Interface

Language: choose between English or one of the translations. To install a translation, download one from Nexus Mods, extract the contents to "%AppData%\Roaming\Vortex\" and restart Vortex. You should then be able to select the newly installed localisation from the language drop-down.

Customisation

UI18.JPG

Custom Window Title Bar: This option, which requires a restart of Vortex, will display a normal windows title bar if switched off, and utilise Vortex’s custom title bar if turned on.

Enable Desktop Notifications: Allows/Disallows Vortex to send desktop notifications i.e. messages in the bottom right of your screen e.g. when downloading a file via Vortex.

Advanced

UI19.JPG

Enable advanced mode: This toggles access to several features that are intended to be used by experienced users, but which might seem daunting to new users. Advanced mode is toggled off by default. The features include access to the “Extensions” section on the side menu, quick mode to set up plugin dependencies, and the ability to change the path of a discovered game by clicking it in list view.

Enable Profile management: Gives you access to mod profile management via a side menu entry labelled “Profiles”. This option is turned off by default.

Automation

Deploy mods when Enabled: Toggles between automatic and manual deployment of mods. This option is turned on by default.

Run FNIS on Deployment Event: This option is limited to Skyrim and Skyrim SE. If enabled, Vortex will run FNIS (Fore’s New Idles in Skyrim) on every mod deployment, ensuring that your animation and behaviour files are updated appropriately.

UI20.JPG

Dashlets

Allows you to toggle the various dashlets displayed on your Dashboard on or off.

Vortex

Mods (settings)

Download

Games

Workarounds

Theme


--Pickysaurus 10:12, 3 October 2018 (BST)