Difference between revisions of "Install TouchDesigner"

From TouchDesigner Documentation
Jump to: navigation, search
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== How to install TouchDesigner ==
 
== How to install TouchDesigner ==
 
'''Download'''
 
'''Download'''
* Download the latest version of TouchDesigner from [https://www.derivative.ca/099/Downloads/ here]
+
* Download the latest version of TouchDesigner from [https://derivative.ca/download here]
 
'''Windows'''
 
'''Windows'''
* Double-click the <code>TouchDesigner099.xxxx.xxxxx.64-Bit.exe</code> file and follow the instruction on the installer dialog.  Please make sure you are installing from an Administrator account.
+
* Double-click the <code>TouchDesigner.xxxx.xxxxx.exe</code> file and follow the instructions on the installer dialog.  Please make sure you are installing from an Administrator account.
 
'''macOS'''
 
'''macOS'''
* Double- click the TouchDesigner099.xxxx.xxxxx.dmg file and then drag the TouchDesigner icon to your Applications folder.
+
* Double-click the TouchDesigner.xxxx.xxxxx.dmg file and then drag the TouchDesigner icon to your Applications folder.
 
'''Keying'''
 
'''Keying'''
* When opening TouchDesigner099 for the first time, the [[Key Manager Dialog]] will guide through the process of installing a license.
+
* When opening TouchDesigner for the first time, the [[Key Manager Dialog]] will guide through the process of installing a license.
  
 
== Installer Options ==
 
== Installer Options ==
# You can make [[TouchPlayer]] the default application associated with TouchDesigner files by choosing "Custom install and TouchPlayer options" and selecting "Make Default for .toe files" on the following page.
+
[[image:InstallOptions.png|400px]]
# You can choose to "Install Runtime for Dongle Licensing" if you are planning to use TouchDesigner with a [[License Dongle]]
+
 
 +
'''Custom Install and TouchPlayer options'''
 +
 
 +
Using this checkbox will give you more options after clilcking 'Next' such as
 +
* Give this installation a custom tag to identify it. This name will be used on the desktop icon and as an additional identifier on all OS references like 'Open With...' menus and 'Add or remove program' dialogs.
 +
* Display or hide the desktop icon
 +
* Customize file associations with TouchDesigner
 +
* TouchPlayer options
 +
** Include TouchPlayer desktop icon
 +
** Include TouchPlayer in the Open With... menu
 +
** Make TouchPlayer the default aaplication for .toe files (ToughDesigner files)
 +
 
 +
'''Install Runtime for Dongle Licensing'''
 +
 
 +
Check this box to include the installation of CodeMeter service which is required to use TouchDesigner with a [[License Dongle]]
 +
 
 +
== Installing Multiple Builds at Once ==
 +
 
 +
Sometimes you will want multiple builds of TouchDesigner or TouchPlayer installed at the same time. You may need older builds to test previous projects, or you may want to try out the latest features in '''Experimental''' while keeping '''Official''' installed for your current project.
 +
 
 +
=== Windows ===
 +
When the installer detects TouchDesigner is already installed on the system, it will give you some options for managing multiple builds
 +
 
 +
'''Install Parallel Build'''
 +
 
 +
This option will install the new build alongside whatever is already installed, without removing your current TouchDesigner builds. You can also use the new 'custom tag' feature under '''Custom Install and TouchPlayer options''' on the next page to more easily identify it, for example a tag name like ''Official'', ''Experimental'', or ''ProjectName''.
 +
 
 +
[[image:InstallParallelBuild.png|400px]]
 +
 
 +
'''Replace currently installed build'''
 +
 
 +
This option will replace the build you currently have installed with the new build. If you already have multiple builds installed, a list will be presented letting you pick exactly which build you would like to replace.
 +
 
 +
[[image:ReplaceInstalledBuildSingle.png|400px]] [[image:ReplaceInstalledBuildMultiple.png|400px]]
 +
 
 +
=== macOS ===
 +
* Just drag the application to any convenient location. If it conflicts with another TouchDesigner build already there, select "Keep Both" from the pop-up dialog. To keep it more organized, you can rename the application file to include the build number.
 +
* Right-clicking on any TouchDesigner file and selecting 'Open With >' will show a list of all TouchDesigner builds on the computer, just select the one you wish to use.
  
 
== Useful Installer Command-line switches on Windows based Systems ==
 
== Useful Installer Command-line switches on Windows based Systems ==
  
 
The Installer can be used with a variety of command-line switches:
 
The Installer can be used with a variety of command-line switches:
* <code>/exenoui</code> - Launches the EXE setup without UI.
+
* <code>/SILENT</code>, <code>/VERYSILENT</code>Instructs Setup to be silent or very silent. When Setup is silent the wizard and the background window are not displayed but the installation progress window is. When a setup is very silent this installation progress window is not displayed. Everything else is normal so for example error messages during installation are displayed and the startup prompt is (if you haven't disabled it with DisableStartupPrompt or the '/SP-' command line).
* <code>/extract</code> - Extracts the MSI contained by the EXE to the specified location. The full path to an existent folder is required. If the path contains spaces you must enclose it in quotes:
+
* <code>/DIR="x:\dirname"</code>Overrides the default directory name displayed on the Select Destination Location wizard page. A fully qualified pathname must be specified. May include an "expand:" prefix which instructs Setup to expand any constants in the name. For example: '/DIR=expand:{autopf}\My Program'.
<syntaxhighlight>TouchDesigner099.xxxx.xxxxx.64-Bit.exe /extract "C:\My Files\TouchDesigner"</syntaxhighlight>
+
* <code>/LOG="filename"</code>Causes Setup to create a log file in the user's TEMP directory detailing file installation and [Run] actions taken during the installation process. This can be a helpful debugging aid. For example, if you suspect a file isn't being replaced when you believe it should be (or vice versa), the log file will tell you if the file was really skipped, and why.
* <code>/quiet</code> - Run installer in quiet mode (there is no user interaction).
+
 
* <code>/passive</code> - Run installer in unattended mode (the installation shows only a progress bar)
+
The log file is created with a unique name based on the current date. (It will not overwrite or append to existing files.)
 +
 
 +
The information contained in the log file is technical in nature and therefore not intended to be understandable by end users. Nor is it designed to be machine-parsable; the format of the file is subject to change without notice.
  
For a full list of Command-line switches, please refer to this article: https://msdn.microsoft.com/en-us/library/windows/desktop/aa367988(v=vs.85).aspx
+
For a full list of Command-line switches, please refer to this article: https://jrsoftware.org/ishelp/index.php?topic=setupcmdline
  
== Problems during Installation on Windows based Systems ==
+
== Problems during Installation on Windows OS ==
 
=== Installer exits during installation or aborts with an Error ===
 
=== Installer exits during installation or aborts with an Error ===
  
 
When the Installer exits during Installation without giving a sufficient reason, start a Windows Command Prompt window with Administrator privileges and run:
 
When the Installer exits during Installation without giving a sufficient reason, start a Windows Command Prompt window with Administrator privileges and run:
  
<code>"C:\MyFolder\TouchDesigner0xx.xxxxx.xx-Bit.exe" /L*V "example.log"</code>
+
<code>"C:\MyFolder\TouchDesigner0xx.xxxxx.exe" /LOG="example.log"</code>
  
 
Send the resulting log file as a zip or link including a description of the encountered error to [mailto:support@derivative.ca Derivative Support]
 
Send the resulting log file as a zip or link including a description of the encountered error to [mailto:support@derivative.ca Derivative Support]
  
'''Note:''' If you persistantly run into an issue with the installer, you can try running TouchDesigner without actually installing it. To some extend the installer just copies files to disk and makes sure that some prerequisites are met. All the required files are contained seperatly in the installer and can be extracted to disk using following command in a standard Windows Command Prompt
+
'''Note:''' If you persistantly run into an issue with the installer, you can try running TouchDesigner without actually installing it. To some extent the installer just copies files to disk and makes sure that some prerequisites are met. All the required files are contained seperatly in the installer and you can try extracting them using a third-party software such as [https://constexpr.org/innoextract/ InnoExtract]
 
 
<syntaxhighlight>TouchDesigner099.xxxx.xxxxx.64-Bit.exe /extract "C:\My Files\TouchDesigner"</syntaxhighlight>
 
  
The extracted folderstructure will contain a <code>bin</code> folder in which you can find <code>TouchDesigner099.exe</code>
+
The extracted folderstructure will contain a <code>bin</code> folder in which you can find <code>TouchDesigner.exe</code>
  
 
=== Installer can't continue because of insufficient access rights to folder ===
 
=== Installer can't continue because of insufficient access rights to folder ===
Line 53: Line 90:
 
If the error is persistent, try re-installing the previously installed version of TouchDesigner, remove it via the Windows "Apps & features" Dialog and try installing the new version again.
 
If the error is persistent, try re-installing the previously installed version of TouchDesigner, remove it via the Windows "Apps & features" Dialog and try installing the new version again.
  
== Problems after Installation ==
+
== Problems after Installation on Windows OS ==
  
 
=== Installing missing libraries for Windows N and Windows KN distributions ===
 
=== Installing missing libraries for Windows N and Windows KN distributions ===
Line 68: Line 105:
 
In some cases starting TouchDesigner will fail with a License Retrieval Error. The content of the error message will look similar to this:
 
In some cases starting TouchDesigner will fail with a License Retrieval Error. The content of the error message will look similar to this:
  
[[File:LicenseRetrievalWMI.png|frameless|License Retrieval Error]]
+
[[File:LicenseRetrievalWMI.png|frameless|License Retrieval Error]] [[File:LicenseRetrievalWMI2.png|205px|frameless|License Retrieval Error]]
  
 
Best success with resolving this has been rebuilding the wmi repository.  
 
Best success with resolving this has been rebuilding the wmi repository.  
Line 77: Line 114:
  
 
<code>winmgmt /resetrepository</code>
 
<code>winmgmt /resetrepository</code>
 +
 +
===WMI services===
 +
 +
For some users, simply rebooting caused the issue to fix itself. For other users they have been able to reset their WMI services (used by our license manager) through the following:
 +
 +
If you start cmd.exe (as Administrator) do you get this a successful output such as:
 +
 +
'''''c:\>winmgmt /verifyrepository'''''
 +
<br>WMI repository is consistent<br>
 +
 +
You can also stop / re-start WMI services:
 +
* C:\Windows\system32>net stop winmgmt
 +
* C:\Windows\system32>net start winmgmt
 +
 +
 +
Some have also tried:
 +
* winmgmt /clearadap
 +
* winmgmt /resyncperf
 +
* winmgmt /resetrepository
 +
     
 +
The repository is reset to the initial state when the operating system is first installed.
 +
 +
 +
== Problems after Installation on macOS ==
 +
 +
=== Permissions Error when installing a key ===
 +
 +
If you get a '''L1 Key Error''' when installing your key (see image below), follow these instructions.
 +
 +
[[Image:L1KeyError.png]]
 +
 +
* In your admin account, open Terminal and paste in the command:
 +
  ls -l  -d "/Library/Application Support/ca.derivative"
 +
You should get a line back like so:
 +
    drwxrwxr-x@ 10 root  admin  340 17 Jan  2017 /Library/Application Support/ca.derivative
 +
* If you do not have admin as a group (4th column), then enter these commands in the Terminal:
 +
    cd  "/Library/Application Support"
 +
    sudo chgrp -R admin ca.derivative
 +
* Restart TouchDesigner and try installing the key again. 
  
 
== Problems during Uninstall ==
 
== Problems during Uninstall ==
Line 83: Line 159:
  
 
When this happen, best practice has been to restart the computer to free up any possible locks on the folder. Most commonly after a restart the remaining files will have been removed and a fresh install can be started.
 
When this happen, best practice has been to restart the computer to free up any possible locks on the folder. Most commonly after a restart the remaining files will have been removed and a fresh install can be started.
 +
 +
==See Also==
 +
[[Automatic Key Installation]]
 +
 +
{{History}}
 +
[[Category:Licensing and Keying]]
 +
[[Category:TDPages]]

Revision as of 00:45, 21 May 2020

How to install TouchDesigner[edit]

Download

  • Download the latest version of TouchDesigner from here

Windows

  • Double-click the TouchDesigner.xxxx.xxxxx.exe file and follow the instructions on the installer dialog. Please make sure you are installing from an Administrator account.

macOS

  • Double-click the TouchDesigner.xxxx.xxxxx.dmg file and then drag the TouchDesigner icon to your Applications folder.

Keying

  • When opening TouchDesigner for the first time, the Key Manager Dialog will guide through the process of installing a license.

Installer Options[edit]

InstallOptions.png

Custom Install and TouchPlayer options

Using this checkbox will give you more options after clilcking 'Next' such as

  • Give this installation a custom tag to identify it. This name will be used on the desktop icon and as an additional identifier on all OS references like 'Open With...' menus and 'Add or remove program' dialogs.
  • Display or hide the desktop icon
  • Customize file associations with TouchDesigner
  • TouchPlayer options
    • Include TouchPlayer desktop icon
    • Include TouchPlayer in the Open With... menu
    • Make TouchPlayer the default aaplication for .toe files (ToughDesigner files)

Install Runtime for Dongle Licensing

Check this box to include the installation of CodeMeter service which is required to use TouchDesigner with a License Dongle

Installing Multiple Builds at Once[edit]

Sometimes you will want multiple builds of TouchDesigner or TouchPlayer installed at the same time. You may need older builds to test previous projects, or you may want to try out the latest features in Experimental while keeping Official installed for your current project.

Windows[edit]

When the installer detects TouchDesigner is already installed on the system, it will give you some options for managing multiple builds

Install Parallel Build

This option will install the new build alongside whatever is already installed, without removing your current TouchDesigner builds. You can also use the new 'custom tag' feature under Custom Install and TouchPlayer options on the next page to more easily identify it, for example a tag name like Official, Experimental, or ProjectName.

InstallParallelBuild.png

Replace currently installed build

This option will replace the build you currently have installed with the new build. If you already have multiple builds installed, a list will be presented letting you pick exactly which build you would like to replace.

ReplaceInstalledBuildSingle.png ReplaceInstalledBuildMultiple.png

macOS[edit]

  • Just drag the application to any convenient location. If it conflicts with another TouchDesigner build already there, select "Keep Both" from the pop-up dialog. To keep it more organized, you can rename the application file to include the build number.
  • Right-clicking on any TouchDesigner file and selecting 'Open With >' will show a list of all TouchDesigner builds on the computer, just select the one you wish to use.

Useful Installer Command-line switches on Windows based Systems[edit]

The Installer can be used with a variety of command-line switches:

  • /SILENT, /VERYSILENTInstructs Setup to be silent or very silent. When Setup is silent the wizard and the background window are not displayed but the installation progress window is. When a setup is very silent this installation progress window is not displayed. Everything else is normal so for example error messages during installation are displayed and the startup prompt is (if you haven't disabled it with DisableStartupPrompt or the '/SP-' command line).
  • /DIR="x:\dirname"Overrides the default directory name displayed on the Select Destination Location wizard page. A fully qualified pathname must be specified. May include an "expand:" prefix which instructs Setup to expand any constants in the name. For example: '/DIR=expand:{autopf}\My Program'.
  • /LOG="filename"Causes Setup to create a log file in the user's TEMP directory detailing file installation and [Run] actions taken during the installation process. This can be a helpful debugging aid. For example, if you suspect a file isn't being replaced when you believe it should be (or vice versa), the log file will tell you if the file was really skipped, and why.

The log file is created with a unique name based on the current date. (It will not overwrite or append to existing files.)

The information contained in the log file is technical in nature and therefore not intended to be understandable by end users. Nor is it designed to be machine-parsable; the format of the file is subject to change without notice.

For a full list of Command-line switches, please refer to this article: https://jrsoftware.org/ishelp/index.php?topic=setupcmdline

Problems during Installation on Windows OS[edit]

Installer exits during installation or aborts with an Error[edit]

When the Installer exits during Installation without giving a sufficient reason, start a Windows Command Prompt window with Administrator privileges and run:

"C:\MyFolder\TouchDesigner0xx.xxxxx.exe" /LOG="example.log"

Send the resulting log file as a zip or link including a description of the encountered error to Derivative Support

Note: If you persistantly run into an issue with the installer, you can try running TouchDesigner without actually installing it. To some extent the installer just copies files to disk and makes sure that some prerequisites are met. All the required files are contained seperatly in the installer and you can try extracting them using a third-party software such as InnoExtract

The extracted folderstructure will contain a bin folder in which you can find TouchDesigner.exe

Installer can't continue because of insufficient access rights to folder[edit]

This behaviour can happen during the de-installation phase of a previously installed version. The best way around this is to restart your computer and start the installation process again.

Installer can't remove previous installed TouchDesigner version[edit]

In some cases the Installer will quit because it was not able to uninstall a previously installed TouchDesigner version.

Follow the instructions on the Microsoft Article here. This solution is now available for all Windows versions TouchDesigner is supporting.

Alternatively Geekuninstaller, available free from here, has had good results when trying to resolve install and uninstall related problems.

If the error is persistent, try re-installing the previously installed version of TouchDesigner, remove it via the Windows "Apps & features" Dialog and try installing the new version again.

Problems after Installation on Windows OS[edit]

Installing missing libraries for Windows N and Windows KN distributions[edit]

Windows N and Windows KN versions are made for the European and Korean market and do to antitrust regulations do not include Windows Media Player which parts of are required to run TouchDesigner.

You can download and install the missing features for

An unexpected licensing error has occurred[edit]

In some cases starting TouchDesigner will fail with a License Retrieval Error. The content of the error message will look similar to this:

License Retrieval Error License Retrieval Error

Best success with resolving this has been rebuilding the wmi repository.

Please be advised though that deleting and rebuilding the repository can cause damage to the system or to installed applications.

Open a Command Prompt with Administrative Rights and run:

winmgmt /resetrepository

WMI services[edit]

For some users, simply rebooting caused the issue to fix itself. For other users they have been able to reset their WMI services (used by our license manager) through the following:

If you start cmd.exe (as Administrator) do you get this a successful output such as:

c:\>winmgmt /verifyrepository
WMI repository is consistent

You can also stop / re-start WMI services:

  • C:\Windows\system32>net stop winmgmt
  • C:\Windows\system32>net start winmgmt


Some have also tried:

  • winmgmt /clearadap
  • winmgmt /resyncperf
  • winmgmt /resetrepository

The repository is reset to the initial state when the operating system is first installed.


Problems after Installation on macOS[edit]

Permissions Error when installing a key[edit]

If you get a L1 Key Error when installing your key (see image below), follow these instructions.

L1KeyError.png

  • In your admin account, open Terminal and paste in the command:
  ls -l  -d "/Library/Application Support/ca.derivative"

You should get a line back like so:

   drwxrwxr-x@ 10 root  admin  340 17 Jan  2017 /Library/Application Support/ca.derivative
  • If you do not have admin as a group (4th column), then enter these commands in the Terminal:
   cd  "/Library/Application Support"
   sudo chgrp -R admin ca.derivative
  • Restart TouchDesigner and try installing the key again.

Problems during Uninstall[edit]

Installer exits during Uninstall without error[edit]

When this happen, best practice has been to restart the computer to free up any possible locks on the folder. Most commonly after a restart the remaining files will have been removed and a fresh install can be started.

See Also[edit]

Automatic Key Installation

TouchDesigner Build:

TOuch Environment file, the file type used by TouchDesigner to save your project.

Any floating window that is not a Pane or Viewer.