==================================
Drive Connect (Deprecated)
==================================

|drive|: Overview
------------------------------

The |drive_long| software mounts an |nuc| server to the user's Windows 10/11 OS as a virtual hard drive, such that one can manipulate server assets as if they were local files. That means the users can copy, read, and write files directly in Windows Explorer.  It can also be used to open to and save directly from applications. This is useful for some existing tools that can only export assets to local disks and are not supported by |connectors| .

Usage Instructions
-------------------------------------

|drive| Usage Video
#####################################

Though |drive| is typically used to manage files on an Omniverse Nucleus, it is also effective as an intermediary between a Nucleus and Applications.  In the video below we demonstrate these capabilities with both Adobe Photoshop and Substance Painter.  This same technique can be used with a multitude of apps such as Substance Designer, Gimp, or any other tools that create content that does not need conversion.

.. raw:: html

    <div style="width: 100%;display: inline-block;position: relative;">
        <div id="dummy" style="margin-top: 56%;">
        </div>
        <div align="center">
        <div id="kaltura_player_1" style="position:absolute;top:0;left:0;left: 0;right: 0;bottom:0;border:solid thin black;"></div>
        <script type="text/javascript" src="https://cdnapisec.kaltura.com/p/2935771/embedPlaykitJs/uiconf_id/46302491"></script>
        <script type="text/javascript">
            try {
            var kalturaPlayer = KalturaPlayer.setup({
            targetId: "kaltura_player_1",
            provider:
            { partnerId: 2935771, uiConfId: 46302491 }
            });
            kalturaPlayer.loadMedia(
            {entryId: '1_dd2sbhp1'}
            );
            } catch (e)
            { console.error(e.message) }
        </script>
        </div>
    </div>

.. _Install Drive:

Installation
#############################

You can install Omniverse Drive from the Omniverse Launcher.  Simply select Omniverse Drive from the exchange, select "Install" and Omniverse Drive will be installed to your computer.  You can then Launch |drive| from the Library tab in Launcher.


Launch |drive|
#############################

Upon launching Drive from the Launcher, the Omniverse server window will appear. Type in the Server Name/Address to connect to a remote server or ``localhost`` to login to your locally hosted nucleus.

    .. image:: /content/images/connect_drive_login.png
	   :align: center
	   :alt: Max Roughness = 1.0

.. note:: |drive| can only connect to one server at a time.


Sign In
#####################

After clicking the Sign In button, the Omniverse Login will appear in a browser window. Use your |nuc| Server credentials to login.

Once complete, You are now connected to the |nuc| server with |drive|. Now it is time to choose a drive letter from the drop down list. Click the OK button to enable it.

    .. image:: /content/images/connect_drive_login2.png
	:align: center
	:alt: Max Roughness = 1.0

.. note:: The Log File button will redirect the user to the log file for the debugging purpose.

Enable Drive
#####################

After enabling the |drive|, a new hard drive shows up in the Windows Explorer. Note that it may take several seconds to populate the file tree to the cache after logging in to the server.

    .. image:: /content/images/connect_drive_progress.png
	   :align: center
	   :alt: Max Roughness = 1.0

Meanwhile, the Omniverse window is minimized to the system tray icon. Either left or right clicking the icon will bring back the Omniverse window.


    .. image:: /content/images/connect_drive_taskicon.png
	   :align: center
	   :alt: Max Roughness = 1.0


Up to this point, the user can manipulate Omniverse assets the same as any other local files in Windows 10/11.


Unmounting
########################

If you want to un-mount the |drive| (or switch to another Omniverse server), click the system tray icon and Sign Out.  Form here you can Exit completely or Log into a new server.


Known Issues
-----------------------------

- When transferring a big file in Windows File Explorer, the progress bar may stall a long time at the last 1%
- Setting the file properties, e.g. read-only, hidden, from the File Explorer's property window doesn't work yet
- After logging out, the mounted drive letter may still appear on the left panel of the window file explorer for a while until it is refreshed.

Release Notes
-----------------------------
100.1.11
#########################
- Update some third party libraries including Dokany runtime installer, Config lib, and omni client library
- Update omni client library to 1.17.5

100.1.7
#########################
- Update the omniverse client library
- Fix a multi-thread file read/write crash issue
- Fix a installer script issue to get rid of the hanging at the end of the installation


100.1.6
#########################
- Renamed the version format from 2020.x to 100.x
- Upgraded the omni client library to 0.18.1297
- Upgraded the dokany lib to 1.4.0
- Fixed a file time bug
- Upgraded the license file

2020.3 Point Release
##########################
- Updated Client Library


2020.2 Point Release
##########################

New Features
^^^^^^^^^^^^^^^^^^^^^
- New Omniverse Server Login Workflow
- No "warm-up" time to launch the mount process

Improvements
^^^^^^^^^^^^^^^^^^^
- Big files (over 2GB) no longer fail to transfer
- |drive| is no longer unresponsive during large transfers
- |drive| no longer crashes when deleting & uploading files at the same time
- Resolved issue where first character of folders were missing in Omniverse Kit's file explorer
- |drive| now properly reports I/O driver installation errors
- Unified logs and temporary data cache paths with other omniverse modules