Getting Started

Installing openPipeline
Creating a Project Using the Project Manager
Updating openPipeline for Maya

Installing openPipeline

  1. First, put the openPipeline.mel and the openPipeline folder inside your user scripts folder (below).

    On a PC, this folder will be similar to:
    C:/Documents and Settings/USERNAME/My Documents/maya/2008/scripts/

    On a Mac:

    You can also find this location by typing internalVar -usd in the MEL command line.

    Take a note of the location that you place these in, as you will need it later in the setup process.

  2. Next, open Maya and run the script openPipeline (below). Do this by typing openPipeline in the MEL command line. You may also make a MEL button to perform this action using the icon included. Highlight the text openPipeline and middle-mouse drag it onto a shelf tab.

  3. The openPipeline setup will now begin, as seen below in (below). You’ll only need to set this once, unless you uninstall and re-install openPipeline.

  4. You’ll now be asked to browse for the location of your scripts folder. As listed in the Product File Setup, you may want to select a new location for your Project File. You can edit these values later if you wish. Press Accept when you have finished setting these paths.

  5. This is the main Project Manager window. As previously mentioned, you may change the locations of the script and Project File with the Edit Locations button. Your current projects can be added, removed, and changed in the window on the left. Detailed information regarding each project will be shown in the grey window on the right.

Back to Top

Creating a Project Using the Project Manager

  1. To begin, select “New.” This will open the Create New Project window (below).

  2. As part of this process, we can change several ways in which the eventual project will be created and sorted within the openPipeline structure.
    • Project Name: Limited to 22 characters, this will appear in all project associated windows.
    • Project Path: Determine the location of your project folders for this specific project. Be sure to allocate the necessary amount of space to the designated area, as this folder will contain all of your assets and other project related files. You will, however, be able to select a different location for archived and deleted items later in the process.
    • Project Description: This will be displayed in the Project Info window within the Project Manager text box.
    • Project Status: By selecting “active,” your project will appear in both the Project Manager list and the pulldown Project Name selector in the main openPipeline window. If you select “inactive” the project will only appear in the main Project Manager list and not the pulldown tab.
    • Creation and Deadline Dates: This will allow you to set dates for view in the Project Manager informational screen. Note that projects in the white list box of the Project Manager are sorted by their order of creation, and not their due date.
    • Master Files: A Master File is a finalized asset version. Here you can set the name of the master files for your usage, and decide on the type of file (.ma or .mb) you wish to have them saved as. It is important to note that these settings cannot be edited after the initial project creation.
    • Workshop Files: A Workshop File is an unfinished or preliminary asset version. Here you may set the name of the workshop files for your usage, and change their file format (.ma or .mb). As with the Master File setting, this cannot be edited after the initial project creation.
    • Sub Folder Names: You can change the names of the folders that openPipeline creates. You cannot edit these names once the project has been started.
    • Archived and Deleted Item Locations: Here you may designate the folder name and location for archived and deleted items.
  3. Once the project is created, you can view the project in the openPipeline Project window, as seen on the right in the image below.
  4. If you wish to change certain values of the project after its creation, highlight the project in the Project Manager and select the blue Edit button to bring back the Editing Project window.
  5. You can create your own image to suit the project currently being worked on. Simply make a jpg file named “openPipelineIcon.jpg” and put it in the project folder.

Back to Top

Updating openPipeline for Maya

Since openPipeline for Maya is open-source, the team operates under a “release early, release often” ideology. Of course we test it to the best of our abilities but bugs crop up and more importantly we have a lot of things we want to add. As such, we release new versions often. As a general rule #.0.0 is for major (non-beta) releases, 0.#.0 is for large feature releases, and 0.0.# is for bug fixes.

New versions of openPipeline ask you to replace the .mel files that we have updated so the steps are as follows:

1. Back-up your installation of openPipeline including openPipeline.mel and the openPipeline folder. Most important to back-up is the openPipelineProjects.xml file which stores your project information.
2. Once backed-up, copy the files from the new openPipeline folder into the installed one. We have been restructuring the code and rearranging MEL files so for 0.9.x it is best to replace all the MEL files.
3. Only replace the openPipeline.mel file if you have changed the location of openPipeline or you are instructed to do so for that version (we try not to edit this file).
4. Place the openPipelineProjects.xml file back into the openPipeline folder.
5. Launch openPipeline as normal.

Back to Top

Go to Top