diff --git a/INSTALL b/INSTALL index 823374e..976fab4 100644 --- a/INSTALL +++ b/INSTALL @@ -4,6 +4,7 @@ Simply copy the files from the subdirectories to the relevant subdirectories of the appropriate paths): For MtoA (in-place install) +- See also: [MtoA (Maya)](https://support.solidangle.com/display/A5AFMUG/Cryptomatte) - Libraries and MTD files found in the 'bin' directory go somewhere in your ARNOLD_PLUGIN_PATH or in 'shaders' under your MtoA installation directory - *.py interface templates found in the 'ae' directory go somwhere in your MTOA_TEMPLATES_PATH or in 'scripts/mtoa/ui/ae' under your MtoA installation directory @@ -14,6 +15,7 @@ For MtoA (custom install) - Set the MAYA_CUSTOM_TEMPLATE_PATH variable to include {CryptomatteArnold_INSTALL}/aexml For C4DtoA +- See also: [C4DtoA (Cinema 4D)](https://support.solidangle.com/display/A5AFCUG/Cryptomatte) - Libraries and MTD files found in the 'bin' directory go somewhere in your ARNOLD_PLUGIN_PATH or in 'shaders' under your C4DtoA installation directory - Copy content of C4DtoA directory to your C4DtoA installation directory @@ -25,11 +27,16 @@ For SitoA - In the render tree, you may need to refresh the preset manager to see the shaders. - If you've already created some instances of the shader and they didn't have the PPGLayout, delete the spdl xsiindex in your $XSI_USERHOME\Application folder and start Softimage again. +For 3D Studio Max +- See also: [3DSMaxToA (3D Studio Max)](https://support.solidangle.com/display/A5AF3DSUG/Cryptomatte) +- Libraries and MTD files found in the 'bin' directory go somewhere in your ARNOLD_PLUGIN_PATH or in the shaders folder of the MAXtoA plugin + For Katana - Libraries and MTD files found in the 'bin' directory go somewhere in your ARNOLD_PLUGIN_PATH - Copy the Args directory to the same place as you copy the binaries For HtoA +- See also: [HtoA (Houdini)](https://support.solidangle.com/display/A5AFHUG/Cryptomatte) - Copy the libraries and .mtd files in the 'bin' directory to HtoA/arnold/plugins or anywhere else in your ARNOLD_PLUGIN_PATH SOURCE DISTRIBUTION diff --git a/README.md b/README.md index f6ccbfc..b052a0c 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,21 @@ # Cryptomatte for Arnold 5 -Version 1.0.0 - This is the Arnold 5 implementation of [Cryptomatte](https://github.com/Psyop/Cryptomatte). +Version 1.0.0. See [changelog](CHANGELOG.md) for version history. + ## User documentation * [Main Cryptomatte for Arnold 5 shader documentation](/docs/cryptomatte.md) -* Solid Angle has helpfully provided documentation for usage in the *toA plugins +* Usage in *toA plugins (Helpfully provided by Solid Angle): * [MtoA (Maya)](https://support.solidangle.com/display/A5AFMUG/Cryptomatte) * [HtoA (Houdini)](https://support.solidangle.com/display/A5AFHUG/Cryptomatte) * [C4DtoA (Cinema 4D)](https://support.solidangle.com/display/A5AFCUG/Cryptomatte) * [3DSMaxToA (3D Studio Max)](https://support.solidangle.com/display/A5AF3DSUG/Cryptomatte) -* Nuke, Fusion, and links to After Effects compositor implementations are found in the [Main Cryptomatte repo](https://github.com/Psyop/Cryptomatte). - -## Change Log / Release Notes +* Nuke and Fusion documentation found in the [Main Cryptomatte repo](https://github.com/Psyop/Cryptomatte), as are links to Fnordware ProEXR builds and others. -See [changelog.](CHANGELOG.md) - -## Developer info +## Developer documentation ### Building from source @@ -41,11 +37,12 @@ On Windows, in cmake-gui, ARNOLD_ROOT and INSTALL_DIR can be set in the UI. #### Build (Linux and Mac OS X) Once those variables are set, cd to the top-level CryptomatteArnold directory: -> mkdir build -> cd build -> cmake .. -> make -> make install + +`> mkdir build` +`> cd build` +`> cmake ..` +`> make` +`> make install` #### Build (Windows) @@ -54,9 +51,9 @@ On Windows use CMakeGUI. 2. Set the build directory to be the same but with "\build" on the end. 3. Click "Configure" and select "Yes" when it asks if you want to create the build directory. 4. Click "Generate". This will create a Visual Studio project file in the build directory which you can use to build the library -5. Open a `Developer Command Prompt for VS2015` +5. Open a "Developer Command Prompt for VS2015" 6. cd to the top-level CryptomatteArnold directory -> msbuild build\INSTALL.vcxproj /p:Configuration=Release +7. `> msbuild build\INSTALL.vcxproj /p:Configuration=Release` ### Tests