AutodeskGames / stingray-plugin

Dieses Repository bietet eine einfache Möglichkeit, neue Plug-Ins für Autodesk Stingray 1.9 zu erstellen.

Sie finden ein Beispiel-Plug-In, das bereits mit einigen grundlegenden Inhalten eingerichtet ist, und ein Framework, auf dem Sie aufbauen können:

• Ein Beispiel .stingray_plugin-Deskriptordatei, die Stingray mitteilt, was Ihr Plug-In ist und was es tut.
• Verschiedene Komponenten, die die Stingray-Umgebung erweitern:
  • Inhaltsressourcen, die Ihr Plug-In allen Stingray-Projekten zur Verfügung stellt, die Sie im Editor öffnen.
  • C/C++-Code, der die Runtime Engine um neue Funktionen erweitert.
  • C/C ++ – Code, der die JavaScript-Umgebung des Editors mit Hooks auf Funktionen erweitert, die in nativem Code implementiert sind.
  • JavaScript-Module, die den Stingray-Editor um neue Bedienfelder, Menüs und Befehle erweitern.
  • Ein Stingray-Inhaltsprojekt, das Ihre Plug-In-Benutzer auf der Registerkarte Vorlagen des Projektmanagers sehen.
• Alles, was Sie zum Erstellen von C / C ++ – Plug-In-Code benötigen.dll-Dateien bereit für den Motor und Editor zu laden:
  • make.rb startet das Plug-in-Build-System.
  • spm.rb ruft Build-Pakete und externe Bibliotheken ab und installiert sie. Es wird intern von make.rb aufgerufen, aber Sie können es auch alleine verwenden, wenn Ihr Plug-In andere Abhängigkeiten hat, die Sie automatisch herunterladen möchten.
  • cmake generiert und kompiliert Visual Studio-Lösungen für die nativen Plug-In-Erweiterungen.

Weitere Informationen zu Plug-Ins, wie sie funktionieren und was Sie damit tun können, finden Sie in der Stingray SDK-Hilfe.

Schritt 1. Voraussetzungen installieren

Sie benötigen einen Git-Client, um den Inhalt dieses Repos auf Ihren Computer zu klonen.

Wenn Sie möchten, dass Ihr Plug-In C/C ++ – Bibliotheken enthält, die den Editor oder die Engine erweitern, benötigen Sie außerdem:

• Ruby 2.0 oder höher.

• Node 6.11.2 LTS oder höher.

• Visual Studio 2015 mit Update 3 & Patch KB3165756.

Schritt 2. Holen Sie sich eine lokale Kopie der Quelle

Sie müssen den Inhalt dieses Repos auf Ihren Computer übertragen, damit Sie damit arbeiten können.

WICHTIG: Sie müssen die Version dieses Repos erhalten, die der Version von Stingray entspricht, mit der Sie Ihr Plug-In verwenden werden! Dies gilt insbesondere, wenn Ihr Plug-In ein C / C ++ verwendet.dll, um die Engine oder den Editor zu erweitern, da Sie kompatible Versionen der Stingray SDK-Header-Dateien benötigen, um Ihr Plug-In zu kompilieren.

• Der master Zweig ist immer synchron mit der neuesten Version von Stingray. Dies ist der Standardzweig, den Sie erhalten, wenn Sie dieses Repo klonen. Verwenden Sie es, wenn Sie möchten, dass Ihr Plug-In mit der aktuellen Version von Stingray funktioniert.

• Wenn Sie Ihr Plug-In so einrichten möchten, dass es mit einer früheren Version von Stingray funktioniert, können Sie eine entsprechende Version dieses Repos abrufen, indem Sie ein Release-Tag auschecken oder die Quelle von der Registerkarte Releases auf GitHub herunterladen.

Wenn Sie Zugriff auf den Quellcode für Stingray haben:

• Wenn Sie den develop Zweig des Stingray Engine-Repos verwenden, um die neuesten und größten Änderungen und Fehlerbehebungen zu erhalten, verwenden Sie den develop Zweig dieses Repos, um Ihr Plug-In zu erstellen.

• Wenn Sie möchten, dass Ihr Plug-In eine kommende Version unterstützt, die noch nicht öffentlich verfügbar ist, aber einen eigenen release -Zweig im Stingray Engine-Repository hat, verwenden Sie den passenden release -Zweig dieses Repos, um synchron zu bleiben.

Schritt 3. Richten Sie Ihr Bibliotheksverzeichnis ein

Jede Revision des Plug-In-Quellcodes hängt von Bibliotheken und Abhängigkeiten ab, die nicht in Git gespeichert sind. Stattdessen kopieren unsere Build-Tools diese Bibliotheken von einem Speicherort im Internet auf Ihren Computer.

Bevor Sie einen Build ausführen, müssen Sie einen Speicherort auf Ihrem Computer angeben, an dem der Build diese Bibliotheken speichern und darauf zugreifen soll.

• Erstellen Sie eine Umgebungsvariable mit dem Namen SR_LIB_DIR. Setzen Sie den Wert auf ein leeres Verzeichnis auf Ihrem Computer, in das die Bibliotheken kopiert werden sollen.

Schritt 4. Build

Wenn Sie ein C/C++ – Plug-In für die Engine oder den Editor verwenden, erstellen Sie es, indem Sie das Skript make.rb im Stammverzeichnis dieses Repositorys ausführen.

> ruby make.rb

Dieser Befehl:

• aktualisiert automatisch Ihr Bibliotheksverzeichnis mit den korrekten Versionen aller Bibliotheken, die für Ihren Build benötigt werden.
• generiert und erstellt Visual Studio-Lösungen für die Stingray Engine und Bearbeitungswerkzeuge.
• bietet mehrere Parameter, mit denen Sie steuern können, was wie erstellt wird. Rufen Sie es mit dem --help Befehlszeilenparameter auf, um eine Liste aller verfügbaren Parameter zu erhalten.

HINWEIS: Wenn Sie einen Fehler bei der Zertifikatüberprüfung erhalten, müssen Sie möglicherweise diesen SSL-Fix für RubyGems installieren

Build-Ergebnisse

Standardmäßig schreibt das Skript alle kompilierten .dll-Dateien in das plugin/binaries -Verzeichnis unter dem Stammverzeichnis, in das Sie den Stingray-Quellcode geklont haben.

Sie können auch die Visual Studio-Lösungen verwenden, die in den Ordnern build/engine und build/editor generiert wurden, um mit dem Quellcode zu arbeiten und Ihre Bibliotheken neu zu erstellen.

Anleitung!

Im Wiki finden Sie ein Tutorial, das Sie Schritt für Schritt durch die Erstellung eines Plug-Ins führt, das sowohl die Engine als auch den Editor erweitert.

Verzeichnisstruktur

• build: Verschiedene Build-Ausgaben (dh von CMake generierte Lösungen)
• cmake: CMake-Hilfsskripte, die von spm
• editor heruntergeladen wurden: Ein Ordner, in den Sie C / C ++ – Code einfügen können, der den Editor erweitert.
• engine: Ein Ordner, in den Sie C/ C ++ – Code einfügen können, der die Laufzeitengine erweitert.
• plugin: Andere Plugin-Quellen (Plugin-Deskriptor, Editor-Erweiterung, kompilierte Editor- und Engine-Erweiterungen usw.)
• stingray_sdk: Stingray Editor und Engine C/C++ Header basiertes Plugin SDK heruntergeladen von spm.
• tools: Verschiedene Build-Tools heruntergeladen von spm.
• make.rb: Schnittstellenskript erstellen. Führen Sie make.rb --help aus, um alle Optionen anzuzeigen.

Sobald Sie das Stingray-Plugin erfolgreich erstellt haben, können Sie den plugin -Ordner komprimieren und Ihr Plugin verteilen. Hilfe zu den ersten Schritten mit dem Stingray SDK finden Sie in den Tutorial-Videos und Themen in der Stingray SDK-Hilfe.

Plugin-Struktur

• stingray-example.plugin: Anfänglicher Plugin-Deskriptor. Es wird dringend empfohlen, den Dateinamen dieser Datei umzubenennen.
• sample_project/: Beispielprojekt, das zeigt, wie Ihr Plugin funktioniert.

Weitere Hilfe

Weitere Informationen zur Arbeit mit Plug-Ins, API-Referenzdokumentation und mehr finden Sie in der Stingray SDK-Hilfe.

Bleiben Sie in Kontakt!

Ihr Feedback ist wichtig, damit dieses Produkt ein Erfolg wird. Bitte helfen Sie uns, indem Sie Ihre Meinung zu all den Dingen, die wir falsch machen, im Stingray-Benutzerforum oder in den Benutzerforen im Autodesk Beta-Portal mitteilen. Autodesk-Ingenieure und -Designer sind aktiv an den Forenthreads beteiligt, sodass Sie Ihre Stimme laut und deutlich hören und Hilfe direkt von der Quelle erhalten können.