Difference between revisions of "Deployment Methods"

From Nexus Mods Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
{{VortexVersion | 0.16.8 and above}}
  
Coming soon
+
A deployment method refers to how Vortex installs your mods so they load when the game is launched. When adding a supported game to Vortex, it will automatically choose the best deployment method for your game and system. It is not recommended that you switch the deployment method.
  
 +
== Hardlink Deployment (Default) ==
 +
To understand Hardlink deployment you must first know how File Systems work. Files are stored in two parts, the actual file data and an index containing the filename, access rights, creation/modified dates and other information.
  
<span style="display:none">Hardlink vs VFS
+
Hard Links work by creating a second entry in the index pointing to the new location but still referencing the original file data. This way there is no difference between the original and link files after the link is created.
- There is no stable "commercial grade" vfs for free.
+
 
- The vfs I built for MO2 should work fine for the games and tools it has been tested with (since it has received a bunch of bugfixes from other devs now) but it is a common problem that a new tool wouldn't work until the vfs has been fixed to support it.
+
Vortex adds your mods to the mod install path, then makes a hard link to your mod install location when deployed. Each deployment will check and rebuild all Hard links. On purging your mods these links are removed.
Considering Vortex supports >30 games plus their associated tools vs the 6 games MO2 supports (that all use the same engine) this would have been a maintenance nightmare.
+
 
- the MO2 usvfs can produce very hard to diagnose errors.
+
{| class="wikitable" style="width: 800px;"
- usvfs is windows only whereas hard-links are supported on all platforms so it will be easier to port to Linux/MacOS
+
! style="width: 50%;" | Advantages
- usvfs will frequently trigger AV software
+
! style="width: 50%;" | Disadvantages
- usvfs causes a performance hit, hard links don't
+
|-
There is probably a few other cons against the vfs - at least as the "primary" deployment method</span>
+
| style="vertical-align:top;" |
 +
*Fully compatible with all applications
 +
*No impact on performance
 +
*Wide Operating System and File System support.
 +
*Mods are managed from their own folders, rather than the game mods folder.
 +
| style="vertical-align:top;" |
 +
*Vortex Mods folder must be on the same partition as the game mods folder.
 +
*Due to the seamless nature of hard links, some applications may see the link as a copy of the original file and measure disc space as if it was duplicated.
 +
|-
 +
|}
 +
 
 +
=== Hardlink vs Virtual File System (VFS) ===
 +
A common question users ask is "How is Vortex deployment different to Mod Organizer's VFS?". Both methods achieve a similar result but go about it in different ways. The VFS used by Mod Organizer (originally designed by Tannin, Lead Vortex Developer) has been heavily customised to work with Gamebryo (Bethesda's Elder Scrolls and Fallout series) games and popular tools for that modding scene. Using this approach in Vortex would have the following drawbacks:
 +
 
 +
*There is no stable high-quality VFS with a free-to-use licence.  
 +
*VFS methods require extensive customisation to work with different tools, hard links are supposed natively as they are no different to access normal system files.
 +
*Diagnosing errors in VFS deployment is considerably more difficult.
 +
*USVFS is a Windows-only feature, whereas hard links are supported on all platforms. This means Vortex would be easier to support Linux or Mac operating systems.
 +
*USVFS can often trigger false positives on anti-virus software.
 +
*Hard links have no performance impact on the game, whereas USVFS will have access files considerably slower.
 +
 
 +
This is not to say that using VFS is worse or bad, simply that Vortex did not opt for this as a default deployment method.
 +
 
 +
== Move Deployment ==
 +
As of Vortex 0.16.8, this deployment method is still considered experimental so is only used by default where Hardlink deployment cannot be supported. Move deployment is a simpler deployment method which doesn't create links between the files and actually moves the files from the Vortex Mods folder to the game mods folder. For each file moved across it creates a .lnk file in the Vortex folder to allow a clean un-deployment.
 +
 
 +
{| class="wikitable" style="width: 800px;"
 +
! style="width: 50%;" | Advantages
 +
! style="width: 50%;" | Disadvantages
 +
|-
 +
| style="vertical-align:top;" |
 +
*Fully compatible with all games
 +
*No impact on performance after the move is completed.
 +
*Wide Operating System and File System support.
 +
| style="vertical-align:top;" |
 +
*Extremely slow if the Vortex mods folder and game mods folder are on different partitions.
 +
*If Vortex is uninstalled while mods are deployed, you must delete the files manually from the mods folder.
 +
*Process is more error prone since the game directory contains real files.
 +
|-
 +
|}
  
 
[[Category: Vortex]]
 
[[Category: Vortex]]

Revision as of 13:37, 15 October 2018

VortexLogoSmall.png This content applies to Vortex 0.16.8 and above.


A deployment method refers to how Vortex installs your mods so they load when the game is launched. When adding a supported game to Vortex, it will automatically choose the best deployment method for your game and system. It is not recommended that you switch the deployment method.

Hardlink Deployment (Default)

To understand Hardlink deployment you must first know how File Systems work. Files are stored in two parts, the actual file data and an index containing the filename, access rights, creation/modified dates and other information.

Hard Links work by creating a second entry in the index pointing to the new location but still referencing the original file data. This way there is no difference between the original and link files after the link is created.

Vortex adds your mods to the mod install path, then makes a hard link to your mod install location when deployed. Each deployment will check and rebuild all Hard links. On purging your mods these links are removed.

Advantages Disadvantages
  • Fully compatible with all applications
  • No impact on performance
  • Wide Operating System and File System support.
  • Mods are managed from their own folders, rather than the game mods folder.
  • Vortex Mods folder must be on the same partition as the game mods folder.
  • Due to the seamless nature of hard links, some applications may see the link as a copy of the original file and measure disc space as if it was duplicated.

Hardlink vs Virtual File System (VFS)

A common question users ask is "How is Vortex deployment different to Mod Organizer's VFS?". Both methods achieve a similar result but go about it in different ways. The VFS used by Mod Organizer (originally designed by Tannin, Lead Vortex Developer) has been heavily customised to work with Gamebryo (Bethesda's Elder Scrolls and Fallout series) games and popular tools for that modding scene. Using this approach in Vortex would have the following drawbacks:

  • There is no stable high-quality VFS with a free-to-use licence.
  • VFS methods require extensive customisation to work with different tools, hard links are supposed natively as they are no different to access normal system files.
  • Diagnosing errors in VFS deployment is considerably more difficult.
  • USVFS is a Windows-only feature, whereas hard links are supported on all platforms. This means Vortex would be easier to support Linux or Mac operating systems.
  • USVFS can often trigger false positives on anti-virus software.
  • Hard links have no performance impact on the game, whereas USVFS will have access files considerably slower.

This is not to say that using VFS is worse or bad, simply that Vortex did not opt for this as a default deployment method.

Move Deployment

As of Vortex 0.16.8, this deployment method is still considered experimental so is only used by default where Hardlink deployment cannot be supported. Move deployment is a simpler deployment method which doesn't create links between the files and actually moves the files from the Vortex Mods folder to the game mods folder. For each file moved across it creates a .lnk file in the Vortex folder to allow a clean un-deployment.

Advantages Disadvantages
  • Fully compatible with all games
  • No impact on performance after the move is completed.
  • Wide Operating System and File System support.
  • Extremely slow if the Vortex mods folder and game mods folder are on different partitions.
  • If Vortex is uninstalled while mods are deployed, you must delete the files manually from the mods folder.
  • Process is more error prone since the game directory contains real files.