This is a heavily modified version of the Cenote film pipeline with many tools and improvements for the Unfamiliar film project. Improvements include:
- Full adoption of USDs
- Use of Python 3
This pipeline has been developed on and for CentOS 7.
Asset management makes heavy use of the groups folder in the BYU CS server. Since every user has access to the groups folder, this pipeline does not have tools for sharing assets between users/computers.
-
Usage and features (for artists)
-
Development (for programmers)
Unmaya can be started by clicking the unmaya icon in the icons folder or running the maya.sh script directly, (e.g. /groups/unfamiliar/anim_pipeline/launch/maya.sh).
UnMaya provides several custom shelves with functionality specifically for Unfamiliar and other silly things.
- UnAnim
- Kelleth: References the Kelleth rig into the current scene
- Maggie: References the Maggie rig into the current scene
- Singe: References the Singe rig into the current scene
- Dolls: References the dolls rigs into the current scene
- Frog: References the frog rig into the current scene
- Amogus: References the Amogus rig into the current scene
- Previous Rig: Launches a dialog to reference a previous version of a rig into current scene
- Layout: Imports the USD layout into the current scene
- Cam: References the exported production camera
- Prod Ref: Converts a selected prop in the USD layout into an FBX reference that can be animated on
- Ref: Refreshes all prop references to their most recent USD version
- Export Alembic: Launches a dialog to export the current shot as an alembic and publish it into the pipe
- StudioLibrary: Loads the StudioLibrary plugin for animators
- Discord: Launches the Maya to Discord tool
- AnimBot: Loads the AnimBot plugin for animators
- UnPipe
- Get Asset List:
- Get Shot List:
- UnRig
- Publish: Publishes a rig and versions it in its correct location within the
productionfolder
- Publish: Publishes a rig and versions it in its correct location within the
- UnFiles
- Checkout: Launches a dialog to check out a shot
- Publish: Publishes a shot
- UnDev
- Debug: Launches a debug session using
debugpythat can be attached to with VS Code. - Unload: Unloads all python packages allowing for code refreshes without having to reopen Maya.
- Report: Launches a dialog allowing the user to report an issue on the Github page.
- Debug: Launches a debug session using
- UnPrevis
- Import DAG: brings model in as a Maya shape
- Export DAG: bakes animation back into USD (very buggy!)
- Cam FBX: exports camera for both Unreal and production
- Unreal Export: Maya to Unreal export tool dialog
Undini can be started by clicking the undini icon in the icons folder or running the houdini.sh script directly, (e.g. /groups/unfamiliar/anim_pipeline/launch/houdini.sh).
Undini provides a custom file menu, UnPipe, that provides shot functionality.
- Shot>Checkout: checks out a shot
- Shot>Return: returns a shot
Undini provides several custom shelves with functionality specifically for Unfamiliar.
- UnAnim
- Layout: brings in an
unlayoutnode that imports the USD layout - Singe: brings in an
unanimnode that imports the Singe model. Also warns the user if they have not checked out a shot. - Maggie: brings in an
unanimnode that imports the Maggie model. Also warns the user if they have not checked out a shot. - Kelleth: brings in an
unanimnode that imports the Kelleth model. Also warns the user if they have not checked out a shot.
- Layout: brings in an
- UnShading
- Edit Model
- Edit Shader
- Build Shader
- Txmake Repath
- Tex Delete
UnDini defines many custom nodes with functionality specifically for Unfamiliar.
- unlayout: imports the USD layout with the correct scale.
- uncamera: brings the camera in to an OBJ context and allows for exporting into the pipeline.
- unanim: imports a specified character for animation.
- untpose: imports a character in t-pose at the correct scale.
- unfx: ask Brendan
- uncloth: used by the
unfxnode - unhair: used by the
unfxnode
This pipeline consists of toolsets for several DCC packages.
The maya.sh file found in the launch/ folder is a bash script that sets many environment variables and settings for Maya before launching it.
The userSetup.py file located in the pipe folder sets up the custom shelves and keyboard shortcuts that turn Maya into the unmaya we all know and love.
It can be started by running the script directly, (e.g. /groups/unfamiliar/anim_pipeline/launch/maya.sh) or clicking the unmaya icon in the icons folder.
To edit Maya environment variables, make changes within the maya.sh file.
To add a new shelf, create a json file within /pipe/tools/mayaTools/custom. It will be automatically detected when unmaya launches.
To add a button to the shelf, add a new JSON entry (see other buttons for examples). It will be automatically detected when unmaya launches. Button icons are located in the icons folder and should be pathed relative to that folder (e.g. an icon located at /icons/discordIcons/desktop.png should have its path provided as "discordIcons/desktop.png")
To create a new keyboard shortcut, add a new entry to /pipe/tools/mayaTools/UnDev/setupHotkeys.py at the bottom of the file such that it is added to the unfamiliarHotkeySet. Make sure to not overwrite any existing keyboard shortcuts, since this change will propogate to everybody and could destroy expected functionality.