Warning: This document is out of date. Use at your own risk.
Shave And A Haircut for Linux comes in a RedHat Package Manager (RPM) file, with a name ending in .rpm. E.g:
That is the 9.0v36 version of Shave And A Haircut for Maya 2018.
Make sure that the Maya version given in the filename matches the version of Maya for which you are installing Shave And A Haircut. For the remainder of this document we will assume that you are installing Shave And A Haircut for Maya 2018. If not, please remember to adjust the version numbers in any filenames or commands presented here to match your version of Maya.
If any users on the system are currently running Maya, have them exit until the installation is complete.
Depending on how your Linux system is configured, use either the rpm command or the yum command to install Shave And A Haircut. E.g:
Note that you will need superuser privileges to run either of these commands.
To use Shave And A Haircut from within Maya, bring up Maya's Plug-in Manager, which can be found on the Maya menubar under Window : Settings/Preferences : Plug-in Manager.
The Plug-in Manager will display its plugins in several sections. Shave And A Haircut will have its own section, bearing a name something like this:
Beneath that heading you should see an entry for the shaveNode.so file with two checkboxes to the right of it, marked loaded and auto load.
To load Shave And A Haircut, check the loaded box. To have Shave And A Haircut automatically load whenever you start up Maya, also check the auto load box.
To uninstall Shave And A Haircut, make yourself the superuser and use either the rpm command or the yum command, whichever is appropriate for your system. E.g:
The rpm and yum tools used to install Shave And A Haircut are both command line tools which makes them well suited to remote installation. Simply copy Shave And A Haircut's .rpm file to the remote system, or to a network drive visible to the remote system, then use the rsh command to run rpm or yum on the remote system.
The yum command will by default prompt the user for confirmation before performing the install. To avoid this, use the -y flag. E.g:
For most users the standard locations used by Shave for its components will be sufficient. However, some users with special needs may need to relocate some or all of Shave's components to different locations on their computer's disks, or on a network.
This section lists the various categories of files included in the Shave And A Haircut installation, their default locations, and how to go about relocating them to different directories.
On Linux Shave And A Haircut is shipped as a Maya module. This means that there is a module definition file which points to a special directory tree containing most of the files required by Shave And A Haircut. Unfortunately, Maya does not yet support the modularization of runtime libraries, presets, or shader icons, so those elements of the plugin must be dealt with separately.
The module definition file for Shave And A Haircut is named shaveHaircut.mod and is located in Maya's module directory. For example:
By default, the module file will point to the Epic Games/shaveHaircut tree within that same module directory:
Beneath that directory lie four subdirectories, containing the base plug-ins, scripts, icons and Shave API sample files:
All except the sample files are required for the proper operation of Shave And A Haircut.
The easiest way to relocate these files is to move the entire sub-tree, as a unit, and modify the path in the shaveHaircut.mod file to point to the new location.
The shaveHaircut.mod file itself may be relocated to any directory in the user's MAYA_MODULE_PATH.
Alternatively, the files in the plug-ins subdirectory may be moved to any directory which is in the user's MAYA_PLUG_IN_PATH, the files in the scripts subdirectory to any directory in the user's MAYA_SCRIPT_PATH, and the files in the icons subdirectory to any directory in the user's XBMLANGPATH. The files in the samples subdirectory can go wherever you like.
Shave And A Haircut installs a library named libShave.so to which it must have access at runtime. By default this file is placed in Maya's lib directory along with Maya's own runtime libraries. E.g:
You may relocate this library to any directory in the user's LD_LIBRARY_PATH
Some versions of Maya do not allow render node and button icons to be stored within the module tree, so Shave And A Haircut installs them into Maya's own icons directory. E.g:
Icon files whose names begin with either shave or render_shave are part of the Shave And A Haircut plugin.
If these files are not present Maya will print warnings and buttons on the Shave shelf will be displayed with a blank icon, as will any Shave-specific buttons on the Hypershade and Create Render Node windows. Other than that, both Shave And A Haircut and Maya will still function properly.
These files can be relocated to any directory in the user's XBMLANGPATH.
Shave And A Haircut includes a number of preset files which can be used to quickly create hair with certain predefined looks, such as blond, grass, scruffy, etc. Each preset consists of a MEL script file and an XPM image file containing a sample swatch.
These presets are intended to be available to all users on the system and are normally stored with the rest of Maya's system-wide presets in a directory relative to Maya's installation directory. So for Maya 2018 the default location of the script file for Shave's grass preset would be:
When searching for these built-in presets Shave And A Haircut looks in the following directories, in the order listed, from top to bottom:
The syntax ${NAME} refers to the expansion of the environment variabled named NAME. Note that ${MAYA_PRESET_PATH} may expand to a list of directories in which case each is checked in turn.
Shave provides both Reyes and RIS shaders for currently supported versions of RenderMan Studio. These are all located in the plug-ins/prman tree in the Shave installation tree. For example:
Shave looks for this directory relative to the location of its plugin file, shaveNode.so, which normally sits in the plug-ins directory of the path given above. So if you move shaveNode.so to a different directory then you must move the prman tree there as well.
Third-party plugins developed using the Shave And A Haircut API will require the presence of the libShaveAPI.so runtime library, which by default can be found in Maya's own lib directory. E.g:
If you are using third-party plugins built with the Shave And A Haircut API and need to relocate this file, the directory to which you relocate it must be in the user's LD_LIBRARY_PATH.
Note that Shave And A Haircut does not itself use this file.
Developers wishing to create their own plugins which use the Shave And A Haircut API will need access to the libShaveAPI.so runtime library described in the previous section, as well as the associated header files, shaveAPI.h and shaveItHair.h. By default these files are located within Maya's own include directory. E.g:
Shave And A Haircut does not itself use this header file, so you may freely relocate it to any directory.
Shave And A Haircut for OSX comes as a zipped OSX installation bundle, with a name ending in .pkg.zip. E.g:
Make sure that the Maya version given in the filename (e.g. '2018_0') matches the version of Maya for which you are installing Shave And A Haircut (e.g. '2018'). For the remainder of this document we will assume that you are installing Shave And A Haircut for Maya 2018. If not, please remember to adjust the Maya version numbers in any filenames or commands presented here to match your version of Maya.
If any users on the system are currently running Maya, have them exit until the installation is complete.
If you are upgrading from an earlier version of Shave And A Haircut, just follow the same instructions as if you were installing for the first time.
If you downloaded Shave And A Haircut using your web browser, depending upon its configuration it may have automatically expanded the .zip file into a .mpkg bundle. If not, then try double-clicking on the .zip file to see if that will expand it. If that doesn't work either, then open up a Terminal window, use the cd command to change to whatever directory you downloaded the .zip file to, then use the unzip command to expand it. For example, if you downloaded the .zip file to your desktop, then you would do something like this:
However you get there, you should eventually end up with a bundle ending in .mpkg. Unlike the .zip file, the bundle will also contain the version of Shave in its name (e.g. shaveHaircut_Maya2018_0-9.0v36.mpkg). Again, depending upon your settings, your browser may automatically launch the OSX installer. If not, then double-click on the bundle to launch the installer.
The installer will first display a welcome window. Click on the Continue button.
The next window will give you an opportunity to change where Shave will be installed. To install to a non-default volume, such as a network drive, click the Change Install Location button.
To change where individual components of Shave are installed, click the Customize button. You will be presented with a window listing each of Shave's components: Maya Support Files, Plugin Files and API Samples. You can choose not to install a given component by toggling off its checkbox, however note that Shave requires the first two components for proper operation. By clicking on the folder icon beside each component you can change the directory where that component will be installed. In choosing an alternate location for a component, keep the following in mind:
Once you're ready to continue with the installation, click on the Install button. The Installer will prompt you for your password, or that of System Administrator. After supplying that, it will proceed to install Shave And A Haircut. When it is done, click the Close button.
To use Shave And A Haircut from within Maya, bring up Maya's Plug-in Manager, which can be found on the Maya menubar under Window : Settings/Preferences : Plug-in Manager.
The Plug-in Manager will display its plugins in several sections. If you installed the "Maya Support Files" component of Shave And A Haircut in its default location then its plugin will be in a section bearing a name something like this:
If you installed the component elsewhere then the path in the header will differ correspondingly.
Beneath that heading you should see an entry for shaveNode.bundle with two checkboxes to the right of it, marked Loaded and Auto load.
To load Shave And A Haircut, check the Loaded box. To have Shave And A Haircut automatically load whenever you start up Maya, also check the Auto load box.
Unfortunately, OSX's Installer does not support uninstalling packages, so you must remove the files by hand.
If you look in your system's /var/db/receipts directory you should see a .bom file for each of Shave's components. E.g:
From a terminal window you can use the lsbom command to display the list of files installed for that component. E.g:
All of the files will be listed relative to the directory in which the component was installed. If you don't remember where you installed a component, there is a corresponding .plist which contains that information. To view the contents of the .plist file, bring up the Finder, select Go from the menu, followed by Go to Folder.., and enter /var/db/receipts into the window which pops up. When you click on the .plist file in the Finder it should display the file's contents to the right. Near the top of the file should be a line for the InstallPrefixPath key. E.g:
With these two pieces of information you should be able to locate and delete all of the files.
If you downloaded Shave And A Haircut as a zip file, you will first have to unzip it. That will give you a bundle with a name ending in ".mpkg". E.g:
In Finder the bundle will appear as a single file but from the command line you will see that it is in fact a directory.
The installer command can be used to do command line installations of the package without invoking a graphical user interface. As such it is well suited for use in remote and unattended installations. Note that you must have root privileges to use this command.
To install Shave And A Haircut in its default location you would use a command something like this:
The -pkg flag specifies the location of the of the package to be installed and the -target flag specifies the disk volume where Maya is installed, which is usually just the system root ('/').
If you want to install one or more of Shave's components in a non-default location then you will have to install each of the components separately. To do this you must first move into the Contents/Packages directory inside the bundle. In there you will see a separate bundle for each of Shave's components. E.g:
The installer command can be used to install each component separately. In doing so you must use the -target flag to provide the full path for the component. For example, let's say that you have Maya 2018 installed in /Volumes/Shared/Maya/2018. You will have to provide that path when installing the 'mayaFiles' component:
When choosing an alternate location for a component, keep the following in mind:
Even if you wish for a component to be installed in its default location, you will still have to provide the appropriate path. E.g:
For most users the standard locations used by Shave for its components will be sufficient. However, users with special needs may need to relocate some or all of Shave's components to different locations on their computer's disks, or on a network.
This section lists the various categories of files included in the Shave And A Haircut installation, their default locations, and how to go about relocating them to different folders.
The Plugin Files component contains three subdirectories: icons, plug-ins and scripts. For proper operation of Shave the icons directory must be in Maya's XBMLANGPATH, the plug-ins directory must be in Maya's MAYA_PLUG_IN_PATH and the scripts directory must be in Maya's MAYA_SCRIPT_PATH.
By default the Plugin Files component is installed into Maya's shared directory (e.g. /Users/Shared/Autodesk/maya/2018) because its subdirectories are already included in the appropriate environment variables. If you decide to install the component elsewhere then you must ensure that Maya will know about the new locations of those three subdirectories. There are two ways of doing this.
The simplest approach is to add each of the subdirectories to its corresponding environment variable, for example by placing appropriate assignments into each user's Maya.env file.
A more robust approach is to create a module file. This is a text file containing a single line of text with the following format:
Replace [shaveVersion] with the version of shave you are installing and replace [componentPath] with the full path to where you have installed the Plugin Files component. For example, if you are installing the Plugin Files component of Shave 9.0v36 into /Library/MayaPlugins/shave then the module file would contain this:
Place this file in Maya's modules directory (e.g. /Applications/Autodesk/maya/2018/Maya.app/Contents/modules). Maya will automatically add the subdirectories of the path specified in the module file to the correct environment variables.
Shave And A Haircut installs a library named libShave.dylib to which it must have access at runtime. This file is installed into Maya's Maya.app/Contents/MacOS directory along with Maya's own runtime libraries. E.g:
This file cannot be relocated.
Shave And A Haircut includes a number of preset files which can be used to quickly create hair with certain predefined looks, such as blond, grass, scruffy, etc. Each preset consists of a MEL script file and an XPM image file containing a sample swatch.
These presets are intended to be available to all users on the system and are normally stored with the rest of Maya's system-wide presets in the Contents hierarchy of Maya's installation directory. So for Maya 2018 the default location of the script file for Shave's grass preset would be:
When searching for these built-in presets Shave And A Haircut looks in the following directories, in the order listed, from top to bottom:
The syntax ${NAME} refers to the expansion of the environment variabled named NAME. Note that ${MAYA_PRESET_PATH} may expand to a list of directories in which case each is checked in turn.
Shave provides both Reyes and RIS shaders for currently supported versions of RenderMan Studio. These are all located in the prman tree in Maya's shared plug-ins directory. For example:
Shave looks for this directory relative to the location of its plugin file, shaveNode.bundle, which normally sits in the plug-ins directory of the path given above. So if you move shaveNode.bundle to a different directory then you must move the prman tree there as well.
Third-party plugins developed using the Shave And A Haircut API will require the presence of the libShaveAPI.dylib runtime library, which is installed into Maya's Maya.app/Contents/MacOS directory along with Maya's own runtime libraries. E.g:
This file cannot be relocated.
Note that Shave And A Haircut does not itself use this file.
Shave And A Haircut for Windows comes as an executable installer with a filename something like this:
For the remainder of this document we will assume that you are installing Shave And A Haircut for Maya 2018. If not, please remember to adjust the version numbers in any filenames or commands presented here to match your version of Maya.
If any users on the system are currently running Maya, have them exit until the installation is complete.
To install Shave And A Haircut, run the executable by double-clicking on its filename. This will launch the Shave And A Haircut installation wizard which will guide you through the remainder of the installation process.
To use Shave And A Haircut from within Maya, bring up Maya's Plug-in Manager, which can be found on the Maya menubar under Window : Settings/Preferences : Plug-in Manager.
The Plug-in Manager will display its plugins in several sections. Shave And A Haircut will have its own section, bearing a name something like this:
Beneath that heading you should see an entry for the shaveNode.mll file with two checkboxes to the right of it, marked loaded and auto load.
To load Shave And A Haircut, check the loaded box. To have Shave And A Haircut automatically load whenever you start up Maya, also check the auto load box.
There is currently a bug in the uninstaller for Shave And A Haircut: if you try to uninstall it from the Windows Control Panel you will get and error message saying "Incorrect command line options specified".
To work around this problem, re-run the installer and select "Uninstall Shave And A Haircut for Maya" from the window which appears.
The installer executable provides a "silent" mode of operation which performs a default installation without using a graphical interface and without requiring any user input. As such it is well suited for use in remote and unattended installations.
To access the silent mode, run the executable from the command line and append the /s flag. You'll also want to use the /r flag to tell it not to prompt you about file conflicts but to just go ahead and replace any existing files with those from the installer. E.g:
Some System Administrators install Maya simply by copying its files from another system. This results in an installation for which there are no entries in the Windows Registry. The installer can handle this so long as Maya has been installed in its standard location (e.g. C:\Program Files\Autodesk\Maya2018). However, if there are no registry entries and Maya has been installed in a non-standard location, then the installation will fail.
If you run into this problem, you will have to explictly give the path
to the Maya installation directory on the command line, using the
'/var:MayaLocation=
For most users the standard locations used by Shave for its components
will be sufficient. However, users with special needs may need to relocate
some or all of Shave's components to different locations on their
computer's disks, or on a network.
This section lists the various categories of files included in the
Shave And A Haircut installation, their default locations, and how to go
about relocating them to different folders.
On Windows Shave And A Haircut is shipped as a Maya module. This means
that there is a module definition file which points to a special folder
containing most of the files required by Shave And A Haircut.
Unfortunately, Maya does not yet support the modularization of runtime
libraries, presets, or shader icons, so those
elements of the plugin must be dealt with separately.
The module definition file for Shave And A Haircut is named
shaveHaircut.mod and is located in Maya's module folder for the
specific version of Maya for which it was installed. For example:
By default, the module file will point to the
Epic Games\shaveHaircut\maya2018 folder, located in your system's
Program Files folder:
Within that folder lie sub-folders, containing plug-ins,
scripts, and Shave API sample files:
All except the sample files are required for the proper operation of Shave
And A Haircut.
The easiest way to relocate these files is to move the entire sub-tree, as
a unit, and modify the path in the shaveHaircut.mod file to point to
the new location.
The shaveHaircut.mod file itself may be relocated to any folder in
the user's MAYA_MODULE_PATH.
Alternatively, the files in the plug-ins sub-folder may be moved to
any folder which is in the user's MAYA_PLUG_IN_PATH,
and the files in the scripts sub-folder to any folder in the user's MAYA_SCRIPT_PATH.
sub-folder to any folder in the user's XBMLANGPATH.
The files in the samples sub-folder can go wherever you like.
Shave And A Haircut installs a library named libShave.dll to
which it must have access at runtime. By default this file is placed in
Maya's bin folder along with Maya's own runtime libraries. E.g:
You may relocate this library to any folder in the user's
PATH
Some versions of Maya do not allow icons to be stored within the module
tree, so Shave And A Haircut installs its icons into Maya's own
icons folder. E.g:
Any files whose names begin with shave or render_shave are
part of the Shave And A Haircut plugin.
If these files are not present Maya will print warnings and buttons on the
Shave shelf will be displayed with a blank icon, as will any Shave-specific
buttons on the Hypershade and Create Render Node windows. Other than that,
both Shave And A Haircut and Maya will still function properly.
The icons can be relocated to any directory in the user's
XBMLANGPATH.
Shave And A Haircut includes a number of preset files which can be used to
quickly create hair with certain predefined looks, such as blond, grass,
scruffy, etc. Each preset consists of a MEL script file and an XPM image file
containing a sample swatch.
These presets are intended to be available to all users on the system and
are normally stored with the rest of Maya's system-wide presets in a
folder relative to Maya's installation directory. So for Maya 2018 the
default location of the script file for Shave's grass preset would
be:
When searching for these built-in presets Shave And A Haircut looks in the
following directories, in the order listed, from top to bottom:
The syntax ${NAME} refers to the expansion of the environment
variabled named NAME. Note that ${MAYA_PRESET_PATH} may
expand to a list of directories in which case each is checked in turn.
Shave provides both Reyes and RIS shaders for currently supported versions
of RenderMan Studio. These are all located in the plug-ins\prman tree
in the Shave installation tree. For example:
Shave looks for this directory relative to the location of its
plugin file, shaveNode.dll, which normally sits in the
plug-ins directory of the path given above. So if you move
shaveNode.dll to a different directory then you must move the
prman tree there as well.
Third-party plugins developed using the Shave And A Haircut API will
require the presence of the libShaveAPI.dll runtime library, which
by default can be found in Maya's own bin folder. E.g:
If you are using third-party plugins built with the Shave And A Haircut API
and need to relocate this file, the folder to which you relocate it must
be in the user's PATH.
Note that Shave And A Haircut does not itself use this file.
Developers wishing to create their own plugins which use the Shave And A
Haircut API will need access to the libShaveAPI.dll runtime library
described in the previous section, as well as its associated header files,
shaveAPI.h and shaveItHair.h. By default these header files
are located within Maya's own include folder. E.g:
Shave And A Haircut does not itself use these files so you may
freely relocate them to any folder.
If you don't know which directories are pointed to by a given Maya
environment variable, such as MAYA_PLUG_IN_PATH, then start up Maya
and in the Script Editor window use the getenv command on the
variable name. E.g:
Maya will display a single line containing all of the directories that Maya
will search for, in this case, plug-ins.
Relocating Files
Base Plugin And Scripts (required)
C:\Program Files\Epic Games\shaveHaircut\maya2018\scripts
C:\Program Files\Epic Games\shaveHaircut\maya2018\samples
Base Runtime Library (required)
Icons (recommended)
Presets (required)
RenderMan Shaders (optional)
Shave API Plugins (optional)
Shave API Development (optional)
C:\Program Files\Autodesk\Maya2018\include\maya\shaveItHair.h
Maya Environment Variables