Automation
Make a local integration
Package your own tool or program plugin so AnimSync Bridge can install it, and let a tool on your computer work with AnimSync through Bridge.
A local integration is your own tool or plugin, installed and run on your computer through AnimSync Bridge. It can go into an animation program, like a Maya or Unreal plugin, or be a tool of its own that talks to AnimSync through Bridge. Your tool never needs an API token: Bridge works for it as you.
The manifest
An integration is a folder with a file named animsync-integration.json at its top. It says what the integration is and which programs it suits.
{
"id": "acme.houdini-export",
"name": "Acme export tools",
"publisher": "Acme Studio",
"version": "1.2.0",
"description": "One line people see when they choose what to install.",
"programs": ["maya", "unreal"],
"install": { "folder": "payload" }
}
idis lower-case letters, digits, dots and dashes, with your own prefix. Names starting withanimsync.are reserved for AnimSync's own.versionlooks like1.2.0. Adding a newer copy with the sameidreplaces the older one.programslists the kinds of program it suits:maya,blender,3dsmax,motionbuilder,unreal, orstandalonefor a tool that installs into no program.install.folderis the folder inside yours that goes into the program.
What goes into each program
Bridge installs the folder the way each program loads add-ons. It never runs your code itself: the program loads it.
- Maya: the folder is a module. Bridge writes a module file into your Maya
modulesfolder. - MotionBuilder: the folder holds your scripts. Set
install.startupto the module Bridge imports when MotionBuilder starts. - Blender: the folder is the add-on package. Bridge copies it into your add-ons and enables it.
- 3ds Max: the folder is a
.bundle. Bridge copies it into your ApplicationPlugins folder. - Unreal Engine: the folder is the plugin, with its
.uplugin. Bridge copies it into a game project'sPluginsfolder and enables it in the.uproject.
Add it to Bridge
- In Bridge, open Integrations.
- Under Your own, choose Add from folder… and pick the folder that holds
animsync-integration.json. - Bridge keeps its own copy, so you can move or change the original afterwards. Add it again to update it.
It now shows under Installed in Bridge. Each program it suits has a button that opens that program on the Programs page. There, choose Install integration… and pick yours. For Unreal, you pick the game project first, and Bridge changes it only after you confirm.
From a terminal, animsync integrations add <folder> does the same.
Talk to AnimSync from your tool
A tool on the same computer as Bridge works with AnimSync through Bridge's local API. It asks to pair once, and you allow it in Bridge's window, for the projects you choose. Bridge then forwards what you allowed, as you, and logs every call. You can revoke a tool at any time on the Integrations page.
The local API only answers on this computer, and never to a web page. Bridge must be running, and signed in to your server.
Python tools can use the client that comes with every AnimSync plugin:
from animsync_core.bridge_client import BridgeClient
client = BridgeClient(key_file="~/.acme/animsync.json")
client.ensure_paired("acme.exporter", "Acme exporter", "Acme Studio", ["projects.list", "tasks.mine", "files.publish"])
for task in client.tasks_mine()["tasks"]:
print(task["projectCode"], task["title"])
client.publish("D:/export/walk.fbx", project="GAME", asset="AS_Walk", comment="first pass")
A tool can ask for these operations: projects.list, tasks.mine, requirements.read, assets.read, versions.download and files.publish. Anything else is refused. A workspace's owners and admins can switch local integrations off, or block one tool, in the workspace settings.
Share it with every studio
Anyone signed in on animsync.app can offer an integration to every studio.
- Make one
.zipwithanimsync-integration.jsonat its top. - On your account page, under Your integrations, choose the zip and Submit for review.
- Once AnimSync approves it, it is listed on animsync.app/integrations and under Available from AnimSync in Bridge. Bridge checks each download before it installs it.
The first publisher to have an id approved owns it. Send each new version as a new submission with a higher version.