AutodeskGames/stingray-plugin

Ce référentiel fournit un moyen facile de commencer à créer de nouveaux plug-ins pour Autodesk Stingray 1.9.

Vous trouverez un exemple de plug-in déjà configuré avec un contenu de base et un framework sur lequel vous pouvez vous appuyer :

• Un exemple.fichier descripteur stingray_plugin, qui indique à Stingray ce qu’est votre plug-in et ce qu’il fait.
• Divers composants qui étendent l’environnement Stingray:
  • Ressources de contenu que votre plug-in met à la disposition de tous les projets Stingray que vous ouvrez dans l’éditeur.
  • Code C/C++ qui étend le moteur d’exécution avec de nouvelles fonctionnalités.
  • Code C/C++ qui étend l’environnement JavaScript de l’éditeur avec des hooks aux fonctions implémentées dans du code natif.
  • Modules JavaScript qui étendent l’éditeur Stingray avec de nouveaux panneaux, menus et commandes.
  • Un projet de contenu Stingray que vos utilisateurs de plug-in verront dans l’onglet Modèles du Gestionnaire de projet.
• Tout ce dont vous avez besoin pour créer du code de plug-in C / C++.fichiers dll prêts à être chargés par le moteur et l’éditeur :
  • make.rb lance le système de construction du plug-in.
  • spm.rb récupère et installe les paquets de construction et les bibliothèques externes. Il est appelé en interne par make.rb, mais vous pouvez également l’utiliser seul si votre plug-in a d’autres dépendances que vous souhaitez télécharger automatiquement.
  • cmake génère et compile des solutions Visual Studio pour les extensions de plug-in natives.

Pour plus d’informations sur les plug-ins, leur fonctionnement et ce que vous pouvez en faire, consultez l’aide du SDK Stingray.

Étape 1. Installez les prérequis

Vous aurez besoin d’un client Git pour cloner le contenu de ce dépôt sur votre ordinateur.

Si vous souhaitez que votre plug-in inclue des bibliothèques C/C++ qui étendent l’éditeur ou le moteur, vous aurez également besoin de :

• Ruby 2.0 ou version ultérieure.

• Nœud 6.11.2 LTS ou ultérieur.

• Visual Studio 2015 avec la mise à jour 3 &Patch KB3165756.

Étape 2. Obtenez une copie locale de la source

Vous devrez récupérer le contenu de ce dépôt sur votre ordinateur afin de pouvoir l’utiliser.

IMPORTANT : Vous devez obtenir la version de ce dépôt qui correspond à la version de Stingray avec laquelle vous utiliserez votre plug-in ! Cela est particulièrement vrai si votre plug-in utilisera un C / C++.dll pour étendre le moteur ou l’éditeur, car vous aurez besoin de versions compatibles des fichiers d’en-tête du SDK Stingray pour compiler votre plug-in.

• La branche master est toujours synchronisée avec la dernière version de Stingray. C’est la branche par défaut que vous obtiendrez si vous clonez ce dépôt. Utilisez-le si vous souhaitez que votre plug-in fonctionne avec la version actuelle de Stingray.

• Si vous souhaitez configurer votre plug-in pour qu’il fonctionne avec une version précédente de Stingray, vous pouvez obtenir une version de ce dépôt en vérifiant une balise de release ou en téléchargeant la source depuis l’onglet Releases sur GitHub.

Si vous avez accès au code source de Stingray:

• Si vous utilisez la branche develop du dépôt du moteur Stingray pour prendre en compte les modifications les plus récentes et les plus importantes et les corrections de bogues, utilisez la branche develop de ce dépôt pour créer votre plug-in.

• Si vous souhaitez que votre plug-in prenne en charge une version à venir qui n’est pas encore disponible publiquement mais qui possède sa propre branche release dans le référentiel Stingray Engine, utilisez la branche release correspondante de ce dépôt pour rester synchronisée.

Étape 3. Configurez votre répertoire de bibliothèque

Chaque révision du code source du plug-in dépend des bibliothèques et des dépendances qui ne sont pas stockées dans Git. Au lieu de cela, nos outils de génération copient ces bibliothèques sur votre ordinateur à partir d’un emplacement de stockage sur Internet.

Avant d’exécuter une génération, vous devez spécifier un emplacement sur votre ordinateur où vous souhaitez que la génération stocke et accède à ces bibliothèques.

• Créez une variable d’environnement nommée SR_LIB_DIR. Définissez sa valeur sur n’importe quel répertoire vide de votre ordinateur dans lequel vous souhaitez copier les bibliothèques.

Étape 4. Build

Si vous incluez un plug-in C/C++ pour le moteur ou l’éditeur, créez-le en exécutant le script make.rb dans le répertoire racine de ce référentiel.

> ruby make.rb

Cette commande:

• met automatiquement à jour votre répertoire de bibliothèque avec les versions correctes de toutes les bibliothèques nécessaires à votre build.
• génère et construit des solutions Visual Studio pour le moteur Stingray et les outils d’édition.
• offre plusieurs paramètres que vous pouvez utiliser pour contrôler ce qui est construit et comment. Appelez-le avec le paramètre de ligne de commande --help pour obtenir une liste de tous les paramètres disponibles.

REMARQUE : Si vous obtenez une erreur concernant la vérification du certificat, vous devrez peut-être installer ce correctif SSL pour RubyGems

Résultats de construction

Par défaut, le script écrit tout compilé.fichiers dll dans le répertoire plugin/binaries sous le répertoire racine dans lequel vous avez cloné le code source de Stingray.

Vous pouvez également utiliser les solutions Visual Studio générées dans les dossiers build/engine et build/editor pour travailler avec le code source et reconstruire vos bibliothèques.

Tutoriel!

Consultez le wiki pour un tutoriel qui vous guide étape par étape dans le processus de création d’un plug-in qui étend à la fois le moteur et l’éditeur.

Structure de répertoire

• build: Différentes sorties de construction (c’est-à-dire des solutions générées par CMake)
• cmake: Scripts d’assistance CMake téléchargés par spm
• editor: Un dossier où vous pouvez mettre du code C/C++ qui étend l’éditeur.
• engine: Un dossier où vous pouvez mettre du code C /C++ qui étend le moteur d’exécution.
• plugin : Autres sources de plugin (descripteur de plugin, extension d’éditeur, extensions d’éditeur et de moteur compilées, etc.)
• stingray_sdk: SDK de plugin basé sur l’en-tête C/C++ de l’éditeur et du moteur Stingray téléchargé par spm.
• tools: Divers outils de construction téléchargés par spm.
• make.rb: Script d’interface de construction. Exécutez make.rb --help pour voir toutes les options.

Une fois que vous avez construit avec succès le plugin Stingray, vous pouvez compresser le dossier plugin et distribuer votre plugin. Pour obtenir de l’aide pour démarrer avec le SDK Stingray, consultez les vidéos et les rubriques du tutoriel dans l’aide principale du SDK Stingray.

Structure du plugin

• stingray-example.plugin: Descripteur initial du plugin. Il est fortement recommandé de renommer le nom de fichier de ce fichier.
• sample_project/: Exemple de projet qui démontre le fonctionnement de votre plugin.

Plus d’aide

Veuillez consulter l’aide du SDK Stingray pour plus de détails sur l’utilisation des plug-ins, de la documentation de référence de l’API, etc.

Restez en contact!

Vos commentaires sont essentiels pour faire de ce produit un succès. Aidez-nous en partageant vos opinions sur tout ce que nous faisons de mal sur le forum des utilisateurs de Stingray ou sur les forums des utilisateurs du portail Autodesk beta. Les ingénieurs et les concepteurs Autodesk sont activement engagés dans les discussions du forum, vous pouvez donc faire entendre votre voix haut et fort et obtenir de l’aide directement à la source.