-
Notifications
You must be signed in to change notification settings - Fork 10
Home
Welcome to the byu-pipeline-tools wiki!
This is a guide to understanding our code base and a basic guide for tool development. If you can understand how these modules work and you can feel comfortable exploring the python module documentation for Maya, Houdini, Mari, and Nuke, then you will be able to easily start making tool.
The purpose of these wiki is to give you a good overview of all of the different parts of the pipeline. I want you to be able to get a good feel for the basic workflow for tool development and how to let your tools integrate into the pipeline. I want you to be able understand the code that is already in place for you. For most of the classes and modules I have given a short description and listed out all of the methods so that at a glance you can see what each one is capable of doing instead of having to scroll through the source code to hunt down a method. The idea is that you can find a method that you need and then you can dive into the source code to figure out exactly how it behaves.
The first thing to do is learn about the tools you will be working with. If you are not familiar with the pipeline tools, what they do and how they work then you should read How to Use the BYU Pipeline Tools. Next the Operations section gives an overview of how those tools work under the hood.
If you are new to pipeline tool development head over to the getting started section. It will help you get your feet wet.
The most important things to learn are the byuam and byugui modules. These modules are the heart of the BYU pipeline tools and understanding them and knowing what functions are at your disposal will save you a lot of time.
If you are anything like me then at first all of the files can be a little intimidating. The project walkthrough will help you understand what files are where, and the project file structure will help you learn about how the pipeline keeps track of all of the bodies.
We want our code to be consistent. Checkout the style guide to find out how you can help in that endeavor!
There is a little bit of name collision that you need to be careful of. HDA could refer to the asset assemblies but it could also refer to it the tools. And there are a couple of things that could be hda directories. Just make sure you are getting the right thing when you are talking about HDAs