Recommended workflow for creating a plug-in module

The following is an example of how a plug-in module can be used in a central network location. For more information about the plug-in modules, see Maya module paths, folders and versions.

• You can save the module and module file to the following locations:

  //networkPath/share/modules/modFile.mod

  //networkPath/share/modFolder

• These can serve as common directories for all platforms (Windows 64-bit, Linux, and so forth):

  //networkPath/share/modFolder/scripts

  //networkPath/share/modFolder/presets

  //networkPath/share/modFolder/icons

  //networkPath/share/modFolder/devkit

• Sample platform specific directories as follows:

  //networkPath/share/modFolder/*PLATFORM*/bin

  //networkPath/share/modFolder/*PLATFORM*/bin/image

  //networkPath/share/modFolder/*PLATFORM*/plug-ins

  //networkPath/share/modFolder/*PLATFORM*/shaders

  //networkPath/share/modFolder/*PLATFORM*/shaders/include

• Set the MAYA_MODULE_PATH environment variable in Maya, for example, as follows:

  MAYA_MODULE_PATH = //networkPath/share/modules

  NOTE:For more information about setting environment variables in Maya, see Environment Variables in the Maya Help.
• Sample module file as follows:

  + PLATFORM:win64 myModule 1.10.1.x ../modFolder/win64 
  MYMODULE_LOCATION:= 
  MYMODULE_SHADERS_LOCATION:=shaders 
  MYMODULE_INCLUDE_LOCATION:=shaders/include 
  MOD_PLUG_IN_PATH+:=bin/image 
  PATH+:=bin 
  icons: ../icons 
  presets: ../presets 
  scripts: ../scripts 
  
  + PLATFORM:mac myModule 1.10.1.x ../modFolder/mac 
  MYMODULE_LOCATION:= 
  MYMODULE_SHADERS_LOCATION:=shaders 
  MYMODULE_INCLUDE_LOCATION:=shaders/include 
  MOD_PLUG_IN_PATH+:=bin/image 
  PATH+:=bin 
  icons: ../icons 
  presets: ../presets 
  scripts: ../scripts 
  
  + PLATFORM:linux myModule 1.10.1.x ../modFolder/linux 
  MYMODULE_LOCATION:= 
  MYMODULE_SHADERS_LOCATION:=shaders 
  MYMODULE_INCLUDE_LOCATION:=shaders/include 
  MOD_PLUG_IN_PATH+:=bin/image 
  PATH+:=bin 
  icons: ../icons 
  presets: ../presets 
  scripts: ../scripts

  NOTE:

  Refer to the \modules directory of your Maya installation for more example module files.

  You can use environment variables in both scripts and module files.

  Files/folders named in a module file are case sensitive.

 Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. Please see the Autodesk Creative Commons FAQ for more information.