Skip to content

Commit

Permalink
Add update manager wiki page
Browse files Browse the repository at this point in the history
  • Loading branch information
LucaScheller committed Oct 27, 2023
1 parent bd95c31 commit cb9bc6c
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 5 deletions.
28 changes: 28 additions & 0 deletions docs/src/installation/automatic_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,31 @@ We also offer a quick install method that does the download of the compiled reso

Currently we only support doing this in Houdini.

## Update Manager
Installing is done via the "USD Asset Resolver - Update Manager". Depending on the application, running the installer is a bit different, for more information check the specific app instructions below.

![Update Manager](./media/UpdateManager.jpg)

The update dialog will prompt you for an installation directory and offers you to choose between different releases and resolvers.
Once you have made your choices, you can press install and the chosen resolver will be installed.

As mentioned in our [Resolvers Plugin Configuration](../resolvers/overview.md#usd-plugin-configuration) section, we need to setup a few environment variables before launching our application so that USD detects our resolver.

In your install directory you will find a "launch.sh/.bat" file, which does this for you based on what host app you ran the installer in.
All you then have to do is run the "launch.sh/.bat" file by double clicking it and then your app should open as usual with the resolver running. In the launch file we have enabled the "TF_DEBUG=AR_RESOLVER_INIT" environment variable, so there will be debug logs where you can see if everything worked correctly.

![Install folder and launcher](./media/AutomaticInstallFolder.jpg)

## Houdini
In Houdini we simply need to open the "Python Source Editor" from the "Windows" menu and run the following code to get access to the update manager. You should preferably do this in a clean Houdini session as a safety measure.

~~~admonish info title=""
```python
import urllib,ssl
update_manager_url = 'https://raw.githubusercontent.com/LucaScheller/VFX-UsdAssetResolver/main/tools/update_manager.py'
exec(urllib.request.urlopen(update_manager_url,context=ssl._create_unverified_context()).read(), globals(), locals())
run_houdini()
```
~~~

![Houdini Python Source editor](./media/HoudiniPythonSourceEditor.jpg)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/installation/media/UpdateManager.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/src/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide currently covers compiling against Houdini on Linux and Windows. Alte
```

```admonish tip
We also offer a quick install method for Houdini that does the download of the compiled resolvers and environment variable setup for you. This is ideal if you want to get your hands dirty right away and you don't have any C++ knowledge or extensive USD developer knowledge. If you are a small studio, you can jump right in and play around with our "PythonResolver"/"CachedResolver" resolvers and prototype around to make it fit your production needs.
We also offer a quick install method for Houdini that does the download of the compiled resolvers and environment variable setup for you. This is ideal if you want to get your hands dirty right away and you don't have any C++ knowledge or extensive USD developer knowledge. If you are a small studio, you can jump right in and play around with our "PythonResolver"/"CachedResolver" resolvers and prototype around to make it fit your production needs. See our [Automatic Installation](./installation/automatic_install.md) section for more information.
```

## Feature Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/src/resolvers/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Run this in your terminal before running your USD capable app. If your are using


~~~admonish tip
If you are using our quick install method, this will already have been done for you via the "launch.sh/.bat" file in the directory where you downloaded the compiled release to.
If you are using our quick install method, this will already have been done for you via the "launch.sh/.bat" file in the directory where you downloaded the compiled release to. See our [Automatic Installation](../installation/automatic_install.md) section for more information.
~~~

~~~admonish info title=""
Expand Down
11 changes: 8 additions & 3 deletions tools/update_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,13 @@

from PySide2 import QtWidgets, QtGui, QtCore

# Execute Directly
# import urllib,ssl; exec (urllib.urlopen('https://raw.githubusercontent.com/LucaScheller/VFX-LYNX/master/lib/LYNX_update.py',context=ssl._create_unverified_context()).read(), globals(), locals()); LYNX_update_manager_object = LYNX_update_manager();LYNX_update_manager_object.ui_LYNX_update_manager();
# To run, execute this in the Houdini Python Source Editor
"""
import urllib,ssl
update_manager_url = 'https://raw.githubusercontent.com/LucaScheller/VFX-UsdAssetResolver/main/tools/update_manager.py'
exec(urllib.request.urlopen(update_manager_url,context=ssl._create_unverified_context()).read(), globals(), locals())
run_houdini()
"""

REPO_URL = "https://api.github.com/repos/lucascheller/VFX-UsdAssetResolver"
RELEASE_ASSET_ELEMENTS_REGEX = re.compile(
Expand Down Expand Up @@ -200,7 +205,7 @@ def install_button_clicked(self):
QT_WINDOW_TITLE,
"Installation successfull.\n"
"Please restart the application by launching it via the 'launcher.bat/.sh' file "
"in your chosen install directory {install_dir_path}.".format(install_dir_path=install_dir_path),
"in your chosen install directory at '{install_dir_path}'.".format(install_dir_path=install_dir_path),
)

def uninstall_button_clicked(self):
Expand Down

0 comments on commit cb9bc6c

Please sign in to comment.