API & SDK

weSkel s’utilise depuis ses interfaces Maya, mais aussi depuis Python pour créer des outils et adapter un pipeline de rig.

Le SDK se prépare

Les wrappers et les fonctions présentés existent dans le code actuel. Le SDK distribué avec le package User est en préparation : son contenu final, l’autocomplétion complète et la compatibilité des extensions avec le moteur compilé restent à valider.

API, SDK : quelle différence ?

Élément	Ce que tu utilises
Outils	Les interfaces prêtes à l’emploi : Module Manager, Pushers, Chroma…
API	Des classes, propriétés et fonctions Python pour manipuler des nœuds Maya et appeler des outils.
SDK	L’API accompagnée de sa documentation, d’exemples et des informations de types pour ton éditeur.

Une API peut rester utilisable lorsque son implémentation est compilée. Les noms, paramètres, résultats et comportements documentés permettent de programmer avec elle.

Choisir ton parcours

Tu souhaites…	Commencer par…
Créer et connecter tes premiers nœuds avec weSkel	Premier script
Comprendre les wrappers, les plugs et les propriétés	Wrappers & specs
Ouvrir une fenêtre depuis ton shelf	Les commandes du manuel Chroma ou de Module Manager
Appeler Switch FK/IK depuis un picker	Le guide Switch FK/IK
Installer weSkel	Bien démarrer

Ce qui est disponible et ce qui se prépare

Capacité	État
Utiliser les wrappers et lire leurs specs	Existant ; les exemples concernent une installation actuelle autorisée.
Appeler les commandes documentées des outils	Existant ; consulter le guide de chaque outil pour ses prérequis.
Disposer du SDK dans le package User	Prévu ; aucun téléchargement SDK séparé n’est annoncé ici.
Complétion complète des API dans l’éditeur	En préparation.
Créer ses propres wrappers à partir de classes compilées	Parcours d’extension à valider avant publication de son guide.
Disposer d’une API stable entre les versions distribuées	Le périmètre et les règles de compatibilité restent à formaliser.

Les exemples montrent les chemins d’import actuels. Conserver tes scripts dans ton propre dossier d’outils : modifier les fichiers installés de weSkel rendrait leur remplacement lors des mises à jour difficile à gérer.

Package User et développement interne

Le package User vise les artistes, y compris les riggers qui écrivent leurs propres scripts. Utiliser l’API ne nécessite pas, à lui seul, de contribuer au développement de weSkel.

Le package Dev concerne le développement interne avec un accès autorisé aux sources. Le présent guide documente l’utilisation du produit et ne donne pas accès à cet environnement.

Livrer un rig ou un script

Ce que tu transmets	Dépendance à prendre en compte
Un rig produit en nœuds Maya natifs	Son évaluation ne nécessite pas le SDK weSkel.
Un script qui importe weSkel	weSkel doit être installé dans l’environnement qui exécute ce script.
Un picker qui appelle Switch FK/IK	La commande weSkel appelée doit être disponible ; un futur package Animation n’est pas encore une distribution disponible.

La documentation technique ne fixe pas les droits de redistribution ni les conditions de licence. Ceux-ci accompagneront la distribution concernée.