Installing-Reactor.md 7.64 KB
Newer Older
Andrew Hazelden's avatar
Andrew Hazelden committed
1 2 3 4
# Table Of Contents #

- [Installing Reactor](Installing-Reactor.md#installing-reactor)
	- [Installing Reactor Visually](Installing-Reactor.md#installing-reactor-visually)
5 6
	- [Installing Reactor for Fusion Manually](Installing-Reactor.md#installing-reactor-manually)
	- [Using Reactor Content on a Fusion Render Node](Installing-Reactor.md#using-reactor-content-on-a-rendernode)
Greg Bovine's avatar
Greg Bovine committed
7
		- [Fusion Render Node Preference File](Installing-Reactor.md#fusion-render-node-preference-file)
Andrew Hazelden's avatar
Andrew Hazelden committed
8 9 10 11
	- [Uninstalling Reactor Manually](Installing-Reactor.md#uninstalling-reactor-manually)

# <a name="installing-reactor"></a>Installing Reactor #

Greg Bovine's avatar
Greg Bovine committed
12
## <a name="installing-reactor-visually"></a>Installing Reactor Visually ##
Andrew Hazelden's avatar
Andrew Hazelden committed
13

14
The `Reactor-Installer.lua` script makes it quick and easy to set up Reactor inside of Fusion or Resolve.
Andrew Hazelden's avatar
Andrew Hazelden committed
15

16
**Step 1.** Drag the Reactor-Installer.lua script from a folder on your desktop into the Fusion Standalone Console tab, or the Resolve Fusion page "Nodes" view. Alternatively, you could paste the Reactor Installer Lua script code into the Fusion Console tab text input field manually and the installer script will be run.
Andrew Hazelden's avatar
Andrew Hazelden committed
17 18 19 20 21 22 23

![Ready to Install](Images/reactor-installer-ready-to-install.png)

**Step 2.** Click the "Install and Relaunch" button. After a few seconds the Reactor Installer progress bar will appear and the installation will proceed.

![Reactor Installer Script](Images/reactor-installer-complete.png)

24
A Reactor.fu file will be downloaded from the Reactor GitLab repository and is saved to the Fusion user prefs location at `Config:/Reactor.fu`. The GitLab repository address string is then written into a new `Reactor:/System/Reactor.cfg` file that is used to control what GitLab repositories are used with Reactor.
Andrew Hazelden's avatar
Andrew Hazelden committed
25 26 27 28 29

When the installer finishes, Fusion will restart automatically and the Reactor Package Manager will be displayed.

![Reactor Window](Images/reactor-gui.png)

30
## <a name="installing-reactor-manually"></a>Installing Reactor for Fusion Manually ##
Andrew Hazelden's avatar
Andrew Hazelden committed
31

32
If you are a system admin/pipeline TD and need more control over the Reactor for Fusion Standalone install process you can manually download files from the GitLab repo and install the tool by yourself.
Andrew Hazelden's avatar
Andrew Hazelden committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

Step 1. To install Reactor, download "Reactor.fu" and place it in your Fusion `Config:/` directory.

Windows `Config:/` Installation Path:

`%appdata%\Blackmagic Design\Fusion\Config\Reactor.fu`

Mac `Config:/` Installation Path:

`$HOME/Library/Application Support/Blackmagic Design/Fusion/Config/Reactor.fu`

Linux `Config:/` Installation Path:

`$HOME/.fusion/BlackmagicDesign/Fusion/Config/Reactor.fu`

Note: `$HOME` represents your current user account's home folder.

50
Step 2. The next time Fusion is launched a new "Reactor" menu will be added. Selecting the **Reactor > Open Reactor...** menu item will open the "Fusion Reactor" Package Manager window.
Andrew Hazelden's avatar
Andrew Hazelden committed
51 52 53

![Reactor Menu](Images/reactor-menu.png)

54 55 56
**Note:** Since Resolve 15 does not support the use of a `.fu` file for creating menu entries, it is recommended that Reactor for Resolve be installed only by the automated Lua installer script. This is due to the fact there are more files to copy in place so a manual installation would be more complex to describe and support.

## <a name="using-reactor-content-on-a-rendernode"></a>Using Reactor Content on a Fusion Render Node ##
Greg Bovine's avatar
Greg Bovine committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138

You can use your Reactor installed content on your render nodes so they have the exact same fuses and plugins installed as your Fusion Studio based workstations have.

This is done by opening the Fusion Render Node's preferences up and setting your PathMaps to match what you have configured on your own workstation's Fusion Studio PathMap preferences so they are 1:1 identical.

![Taskbar Settings](Images/taskbar-render-node-settings.png)

This means you should re-create the Fusion Studio style PathMap settings like this on each of your render nodes:

![Fusion Render Node Preferences](Images/fusion-render-node-prefs.png)

### **User** PathMap Entry ###

**From:**

`Reactor:`

**To:**

`C:\ProgramData\Blackmagic Design\Fusion\Reactor\`

If you have moved Reactor to a new installation location on your network share you would change the "To" section entry to point to that custom location you have placed the files at. This would be the folder you have set in your "`REACTOR_INSTALL_PATHMAP`" environment variable.

### **Defaults** PathMap Entry ###

**From:**

`UserPaths:`

**To:**

`UserData:;AllData:;Fusion:;Reactor:Deploy`

The `UserPaths:` section is where you define the folders that hold your fusion user preferences. Each PathMap location you define here will have a full set of sub-folders created during Fusion or Fusion Render Node's startup for holding the custom addons you can use with Fusion like:

- Bins
- Brushes
- Config
- Defaults
- Filters
- Fuses
- Guides
- Layouts
- Library
- LUTs
- Macros
- Modules
- Plugins
- Scripts
- Settings
- Stamps

### Optional Extra PathMap Entry ###

This extra setting can be configured on a render node if you want to be very thorough with your install. It is not strictly required but is a good idea to have for the future as this setting will become useful a few months from now when more Lua/Python scripted features and atoms are added to the toolset.

**From:**

`Scripts:`

**To:**

`UserPaths:Scripts;Reactor:System/Scripts`

### <a name="fusion-render-node-preference-file"></a>Fusion Render Node Preference File ###

The Fusion Render Node preference file has the filename of `RenderNode.prefs` that is located on your system in this PathMap folder:

`Profile:/`

On Windows this works out to:

`%AppData%\Blackmagic Design\Fusion\Profiles\Default\`

On Linux this works out to:

`$HOME/.fusion/BlackmagicDesign/Fusion/Profiles/Default/`

On MacOS this works out to:

`$HOME/Library/Application Support/Blackmagic Design/Fusion/Profiles/Default/`

Andrew Hazelden's avatar
Andrew Hazelden committed
139 140 141 142
## <a name="uninstalling-reactor-manually"></a>Uninstalling Reactor Manually ##

![Reactor Folder](Images/reactor-pathmap-folder.png)

143 144 145
### Step 1.###

To uninstall Reactor from your system you need to remove the downloaded Reactor "atom" content by deleting the Reactor folder that is located in your shared Fusion `AllData:/Reactor:/` folder.
Andrew Hazelden's avatar
Andrew Hazelden committed
146 147 148

The `AllData:/Reactor:/` folder is located here:

149 150
#### Fusion Paths ###

Andrew Hazelden's avatar
Andrew Hazelden committed
151 152 153 154 155 156 157 158 159 160 161 162
**Windows Reactor Path:**

`C:\ProgramData\Blackmagic Design\Fusion\Reactor\`

**Mac Reactor Path:**

`/Library/Application Support/Blackmagic Design/Fusion/Reactor/`

**Linux Reactor Path:**

`/var/BlackmagicDesign/Fusion/Reactor/`

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179

#### Resolve Paths ####

**Windows Reactor Path:**

`C:\ProgramData\Blackmagic Design\DaVinci Resolve\Fusion\Reactor\`

**Mac Reactor Path:**

`/Library/Application Support/Blackmagic Design/DaVinci Resolve/Fusion/Reactor/`

**Linux Reactor Path:**

`/var/BlackmagicDesign/DaVinci Resolve/Fusion/Reactor/`


Step 2. If you are using Fusion you should remove the `Reactor.fu` file from your Fusion user preferences `Config:/` directory. This will stop the Reactor menu item from being added to Fusion.
Andrew Hazelden's avatar
Andrew Hazelden committed
180 181 182 183 184 185 186 187 188 189 190 191 192

Step 3. Open the Fusion Preferences window and switch to the "Global and Default Settings > PathMap" section.

![Fusion PathMap Preferences](Images/uninstall-pathmap-entries.png)

In the "User" section of the PathMap view click on the entry for the "Reactor:" PathMap. Then press the Delete button.

Scroll up to the "Defaults" section and click on the "UserPaths:" entry. Edit the text in the "To" field and remove the words ";Reactor:Deploy". Be sure to keep the rest of the settings in textfield.

Scroll up in the "Defaults" section and click on the "Scripts:" entry. Edit the text in the "To" field and remove the words ";Reactor:System/Scripts". Be sure to keep the rest of the settings that are in textfield.

Step 4. Restart Fusion. Reactor will have been cleanly removed from your system.

193
Last Revised 2018-05-21