Installing the plug-in
(20 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | <span style="color:red">'''These instructions are for the full version of Fracture FX.'''<br /> | ||
+ | '''For instructions on installing the trial version, please check the "Fracture FX Trial Download" email you received.'''</span> | ||
+ | <br /><br /> | ||
+ | |||
__TOC__ | __TOC__ | ||
== Contents of the build folder == | == Contents of the build folder == | ||
− | Upon purchasing Fracture, you will be sent an email | + | Upon purchasing Fracture FX, you will be sent an email called "Your Order at Fracture FX". Use the log in details inside that email to log in at your user area: https://www.fracture-fx.com/user |
+ | |||
+ | Go to the "Files" tab to download your copy of Fracture FX. The Fracture FX download is a compressed file, so please use winzip, winrar or gzip to extract the content. | ||
Once extracted, you will see 3 folders: | Once extracted, you will see 3 folders: | ||
+ | |||
+ | [[File:folderContent.jpeg]] | ||
#'''lib:''' this folder contains the actual Fracture plugin for each OS and Maya version. You obviously proceed with the folder relevant to your system. <span style="color:red"> IMPORTANT: copy the "fracture_plugins" folder in the same location as fracture.so/fracture.mll/fracture.bundle (for more info about that see below). The "fracture_plugins" folder contains plugins used by Fracture. In this case the Bullet solver. Do no attempt to load this plugin through the plug-in manager. This will happen automagically when you load Fracture. </span> | #'''lib:''' this folder contains the actual Fracture plugin for each OS and Maya version. You obviously proceed with the folder relevant to your system. <span style="color:red"> IMPORTANT: copy the "fracture_plugins" folder in the same location as fracture.so/fracture.mll/fracture.bundle (for more info about that see below). The "fracture_plugins" folder contains plugins used by Fracture. In this case the Bullet solver. Do no attempt to load this plugin through the plug-in manager. This will happen automagically when you load Fracture. </span> | ||
Line 11: | Line 19: | ||
#'''devkit''': this folder contains the API that allows developers to connect Fracture with external solvers. | #'''devkit''': this folder contains the API that allows developers to connect Fracture with external solvers. | ||
<br> | <br> | ||
+ | |||
== Installing the plug-in (fracture.so/fracture.bundle/fracture.mll) == | == Installing the plug-in (fracture.so/fracture.bundle/fracture.mll) == | ||
Line 19: | Line 28: | ||
A note about the plugin directories. A default Maya installation may not create these folders by default. However if you do create (and name correctly) these directories, Maya will recognize them. Those working in a production pipeline may have to request the installation be handled by IT. | A note about the plugin directories. A default Maya installation may not create these folders by default. However if you do create (and name correctly) these directories, Maya will recognize them. Those working in a production pipeline may have to request the installation be handled by IT. | ||
− | + | ===Windows=== | |
<pre> | <pre> | ||
− | + | <user’s directory>/Documents/maya/<maya version>/plug-ins | |
− | + | or | |
− | / | + | <user’s directory>/OneDrive/Documents/maya/<maya version>/plug-ins |
− | + | ||
− | + | ||
</pre> | </pre> | ||
− | + | ===Linux=== | |
<pre> | <pre> | ||
− | <user's | + | <user's home directory>/maya/<maya version>/plug-ins |
− | < | + | /usr/autodesk/userconfig/maya/<maya version>/plug-ins |
− | / | + | |
− | + | ||
− | + | ||
</pre> | </pre> | ||
− | + | ===Mac OS=== | |
<pre> | <pre> | ||
− | < | + | <user's homefolder>/Library/Preferences/Autodesk/maya/<maya version>/plug-ins |
− | + | /Users/Shared/Autodesk/maya/<maya version>/plug-ins | |
− | < | + | |
</pre> | </pre> | ||
+ | |||
+ | Some versions of MacOS hide the Library folder by default in your home directory. You can get to it by running the Terminal app, then entering: | ||
+ | |||
+ | <pre>open ~/Library/Preferences</pre> | ||
+ | |||
+ | [[File:mac_terminal.png]] | ||
+ | |||
+ | [[File:mac_plugins_dir.png]] | ||
== Installing the MEL scripts == | == Installing the MEL scripts == | ||
Line 48: | Line 59: | ||
The MEL scripts need to be placed into a valid script path. | The MEL scripts need to be placed into a valid script path. | ||
− | + | ===Windows=== | |
<pre> | <pre> | ||
− | + | <user’s directory>/Documents/maya/<maya version>/scripts | |
− | + | or | |
− | / | + | <user’s directory>/OneDrive/Documents/maya/<maya version>/scripts |
− | + | ||
</pre> | </pre> | ||
− | + | ===Linux=== | |
<pre> | <pre> | ||
− | <user's | + | <user's home directory>/maya/<maya version>/scripts |
− | < | + | /usr/autodesk/userconfig/maya/<maya version>/scripts |
− | / | + | |
− | + | ||
− | + | ||
</pre> | </pre> | ||
− | + | ||
+ | ===Mac OS=== | ||
<pre> | <pre> | ||
− | < | + | <user's homefolder>/Library/Preferences/Autodesk/maya/<maya version>/scripts |
− | < | + | /Users/Shared/Autodesk/maya/<maya version>/scripts |
− | + | ||
</pre> | </pre> | ||
Line 77: | Line 84: | ||
</pre> | </pre> | ||
− | To load Fracture in Maya, locate it in the Plug-in Manager (fracture.mll) and tick the check box on. | + | == Overview == |
+ | |||
+ | [[File:Installation_dirs.png]] | ||
+ | |||
+ | == Maya 2018 == | ||
+ | |||
+ | Due to a Maya 2018 bug, Fracture FX is not compatible with Viewport 2.0. To use Fracture with Maya 2018, you'll need to enable the Legacy Viewport by adding MAYA_ENABLE_LEGACY_VIEWPORT=1 to your maya.env file. | ||
+ | |||
+ | More info here: https://vimeo.com/248014221 | ||
+ | |||
+ | How to set an environment variable using maya.env: https://knowledge.autodesk.com/support/maya/learn-explore/caas/CloudHelp/cloudhelp/2018/ENU/Maya-EnvVar/files/GUID-8EFB1AC1-ED7D-4099-9EEE-624097872C04-htm.html?v=2018 | ||
+ | |||
+ | == Loading the plug-in in Maya's plug-in manager == | ||
+ | To load Fracture in Maya, locate it in the Plug-in Manager (fracture.mll/fracture.so) and tick the check box on. | ||
+ | <br> | ||
+ | |||
+ | [[File:PluginManagerScreenshot.jpeg]] |
Latest revision as of 15:07, 3 April 2022
These instructions are for the full version of Fracture FX.
For instructions on installing the trial version, please check the "Fracture FX Trial Download" email you received.
Contents |
[edit] Contents of the build folder
Upon purchasing Fracture FX, you will be sent an email called "Your Order at Fracture FX". Use the log in details inside that email to log in at your user area: https://www.fracture-fx.com/user
Go to the "Files" tab to download your copy of Fracture FX. The Fracture FX download is a compressed file, so please use winzip, winrar or gzip to extract the content.
Once extracted, you will see 3 folders:
- lib: this folder contains the actual Fracture plugin for each OS and Maya version. You obviously proceed with the folder relevant to your system. IMPORTANT: copy the "fracture_plugins" folder in the same location as fracture.so/fracture.mll/fracture.bundle (for more info about that see below). The "fracture_plugins" folder contains plugins used by Fracture. In this case the Bullet solver. Do no attempt to load this plugin through the plug-in manager. This will happen automagically when you load Fracture.
- mel: this folder contains the MEL scripts that support the plugin. For installation see below.
- devkit: this folder contains the API that allows developers to connect Fracture with external solvers.
[edit] Installing the plug-in (fracture.so/fracture.bundle/fracture.mll)
The FractureFX plug-in needs to be installed to your Maya plug-in path. The path varies from OS to OS. Below is a basic reference of the standard paths. Those on a production pipeline may find that their paths are altered and don't reflect the examples below.
Official documentation about plug-in paths can be found here.
A note about the plugin directories. A default Maya installation may not create these folders by default. However if you do create (and name correctly) these directories, Maya will recognize them. Those working in a production pipeline may have to request the installation be handled by IT.
[edit] Windows
<user’s directory>/Documents/maya/<maya version>/plug-ins or <user’s directory>/OneDrive/Documents/maya/<maya version>/plug-ins
[edit] Linux
<user's home directory>/maya/<maya version>/plug-ins /usr/autodesk/userconfig/maya/<maya version>/plug-ins
[edit] Mac OS
<user's homefolder>/Library/Preferences/Autodesk/maya/<maya version>/plug-ins /Users/Shared/Autodesk/maya/<maya version>/plug-ins
Some versions of MacOS hide the Library folder by default in your home directory. You can get to it by running the Terminal app, then entering:
open ~/Library/Preferences
[edit] Installing the MEL scripts
The MEL scripts need to be placed into a valid script path.
[edit] Windows
<user’s directory>/Documents/maya/<maya version>/scripts or <user’s directory>/OneDrive/Documents/maya/<maya version>/scripts
[edit] Linux
<user's home directory>/maya/<maya version>/scripts /usr/autodesk/userconfig/maya/<maya version>/scripts
[edit] Mac OS
<user's homefolder>/Library/Preferences/Autodesk/maya/<maya version>/scripts /Users/Shared/Autodesk/maya/<maya version>/scripts
If you are still having issues, the follow MEL commands can be used to print all the paths that Maya is looking in for plug-ins and scripts. When executing these commands, make sure you are using a MEL tab in the script editor, and not a Python tab!
getenv "MAYA_PLUG_IN_PATH" getenv "MAYA_SCRIPT_PATH"
[edit] Overview
[edit] Maya 2018
Due to a Maya 2018 bug, Fracture FX is not compatible with Viewport 2.0. To use Fracture with Maya 2018, you'll need to enable the Legacy Viewport by adding MAYA_ENABLE_LEGACY_VIEWPORT=1 to your maya.env file.
More info here: https://vimeo.com/248014221
How to set an environment variable using maya.env: https://knowledge.autodesk.com/support/maya/learn-explore/caas/CloudHelp/cloudhelp/2018/ENU/Maya-EnvVar/files/GUID-8EFB1AC1-ED7D-4099-9EEE-624097872C04-htm.html?v=2018
[edit] Loading the plug-in in Maya's plug-in manager
To load Fracture in Maya, locate it in the Plug-in Manager (fracture.mll/fracture.so) and tick the check box on.