Welcome to OpenRig’s documentation!

OpenRig is an open-source rigging library designed for Autodesk Maya.

Architecture

• OpenRig — Architecture Overview

Style Guide

• Python Coding Style Guide
  • Introduction
  • 1. Code Layout & Imports (PEP 8)
  • 2. Naming (PEP 8)
  • 3. Docstrings (Google Style & PEP 257)
  • 4. Type Hinting (PEP 484)
  • 5. Logging (PEP 282)
  • 6. Tooling

Conventions

• Naming Convention
  • Introduction
  • Core Design Principles
  • Default Convention
  • Global Rules
  • Using the Naming Library
  • Available Normalizers
  • Extending the Convention
  • Real-World Use Cases
  • Quick Reference — Valid vs Invalid Names
• Rigging Standards
  • Introduction
  • 1. Coordinate System & Axes
  • 2. Side Convention
  • 3. Joint Orientation
  • 4. Controls & Hierarchy
  • 5. Node Naming
  • 6. Connections & Data Flow
  • 7. Build vs Scene State

API Reference

• openrig
  • openrig package

Indices and tables

• Index

• Module Index

• Search Page