# CMRigScript

**Repository Path**: RiggerLiuqi/cmrig-script

## Basic Information

- **Project Name**: CMRigScript
- **Description**: Maya2024 绑定工具整理
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-03
- **Last Updated**: 2026-07-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CMRig Script

Maya 插件工具盒项目，用于整理和迁移 `lqMayaScript2024` 中常用的绑定、动画、TD 和流程工具，并通过 Maya Modules 发布给同事使用。

## 目录结构

长期学习项目结构、函数调用链和新工具写法，请优先阅读：

```text
docs/CMRIG_PYTHON_MAYA_LEARNING.md
```

```text
cmrig-script/
  modules/              # 生成或提交给同事使用的 .mod 文件
  scripts/              # Maya Python 脚本入口
    userSetup.py        # Maya 启动时自动安装菜单
    cmrig_toolbox/      # 工具盒核心代码
    tools/              # 迁移后的工具按分类存放
      rigging/
      animation/
      td/
      modeling/
      pipeline/
    vendor/             # 第三方 Python 包或旧工具依赖
  plug-ins/             # Maya 插件文件，mll/py 插件等
  icons/                # 图标资源
  shelves/              # 货架文件
  docs/                 # 文档
  tools/                # 仓库维护、安装、打包脚本
```

## 安装

1. 将仓库 clone 到本地，例如 `Q:\cmrig-script`。
2. 双击运行 `tools\install_module.bat`。
3. 重启 Maya。
4. Maya 顶部菜单会出现 `CMRig`。

安装脚本会把 `modules\cmrig-script.mod` 复制到当前用户的 Maya modules 目录：

```text
%USERPROFILE%\Documents\maya\modules
```

如果仓库移动了位置，重新运行一次安装脚本即可。

## 迁移旧工具

旧项目 `lqMayaScript2024` 中可直接迁移的单文件工具，建议按用途放入：

- `scripts/tools/rigging`
- `scripts/tools/animation`
- `scripts/tools/td`
- `scripts/tools/modeling`
- `scripts/tools/pipeline`

每个工具模块建议提供一个 `main()` 函数：

```python
def main():
    # open ui or run command
    pass
```

工具盒会自动扫描这些分类目录，把带有 `main()` 的 `.py` 文件加入菜单。

需要二级菜单时，可以在分类目录下再建一层目录。例如骨骼相关工具放在：

```text
scripts/tools/rigging/skeleton
```

会显示为：

```text
CMRig > Rigging > 骨骼工具
```

## Maya Modules

`.mod` 文件模板位于 `modules/cmrig-script.mod.template`。安装脚本会把模板里的仓库路径替换成当前项目路径，生成：

```text
modules/cmrig-script.mod
```

不要在模板里写死个人路径，避免同事安装后路径失效。

注意：`cmrig-script` 是 Maya Module + Python 菜单工具盒，不是 `.mll` 或 Maya Python plug-in，所以不会在 Plug-in Manager 里显示。安装成功后应检查 Maya 顶部是否出现 `CMRig` 菜单。

## 第三方机器初始化

同事安装后，如果热键或 Channel Box 右键菜单没有自动出现，先确认 Maya 顶部已经出现 `CMRig` 菜单，然后在 Script Editor 执行：

```python
import jointMatrixSaveTool
reload(jointMatrixSaveTool)
jointMatrixSaveTool.install_all()
```

执行后，Hotkey Editor 的 `User` 分类里应能看到 `LQ Restore Default TRS`，默认快捷键为 `Alt + R`。

## 开发记忆

后续维护 Maya 版本兼容、启动脚本、热键、Channel Box 右键菜单前，先阅读：

```text
docs/CMRIG_PROJECT_MEMORY.md
```