AutodeskGames / stingray-plugin

detta arkiv ger ett enkelt sätt att komma igång med att skapa nya plug-ins för Autodesk Stingray 1.9.

Du hittar ett exempel plug-in som redan är inställd med vissa grundläggande innehåll, och ett ramverk som du kan bygga på:

• ett prov .stingray_plugin deskriptorfil, som berättar Stingray vad din plug-in är och vad den gör.
• olika komponenter som förlänger Stingray-miljön:
  • innehållsresurser som din plug-in gör tillgängliga för alla Stingray-projekt som du öppnar i redigeraren.
  • c / c++ – kod som utökar runtime-motorn med ny funktionalitet.
  • c / c++ – kod som utökar redaktörens JavaScript-miljö med krokar till funktioner som implementeras i inbyggd kod.
  • JavaScript-moduler som utökar Stingray editor med nya paneler, menyer och kommandon.
  • ett Stingray – innehållsprojekt som dina plug-in-användare kommer att se på fliken Mallar i projektledaren.
• allt du behöver för att bygga C / C++ plug-in kod i .dll-filer redo för motorn och redigeraren att ladda:
  • make.rb startar plug-in-byggsystemet.
  • spm.rb hämtar och installerar byggpaket och externa bibliotek. Det kallas internt av make.rb, men du kan också använda det på egen hand också om din plug-in har andra beroenden som du vill ladda ner automatiskt.
  • cmake genererar och sammanställer Visual Studio-lösningar för de inbyggda plugin-tilläggen.

För mer information om plug-ins, hur de fungerar och vad du kan göra med dem, se Stingray SDK hjälp.

Steg 1. Installera förutsättningar

du behöver en Git-klient för att klona innehållet i denna repo till din dator.

om du vill att din plug-in ska inkludera C/C++ – bibliotek som utökar redigeraren eller motorn behöver du också:

• Ruby 2.0 eller senare.

• nod 6.11.2 LTS eller senare.

• Visual Studio 2015 med uppdatering 3 & Patch KB3165756.

steg 2. Få en lokal kopia av källan

Du måste hämta innehållet i denna repo till din dator så att du kan arbeta med den.

viktigt: du måste få den version av denna repo som motsvarar den version av Stingray som du kommer att använda din plug-in med! Detta gäller särskilt om din plug-in kommer att använda en C/c++ .DLL för att förlänga motorn eller redigeraren, eftersom du behöver kompatibla versioner av Stingray SDK-huvudfilerna för att kompilera din plug-in mot.

• master grenen är alltid synkroniserad med den senaste versionen av Stingray. Detta är standardgrenen du får om du klonar denna repo. Använd den om du vill att din plug-in ska fungera med den aktuella versionen av Stingray.

• Om du vill ställa in din plug-in för att fungera med en tidigare version av Stingray kan du få en version av denna repo att matcha genom att kolla in en release-tagg eller ladda ner källan från fliken Releases på GitHub.

om du har tillgång till källkoden för Stingray:

• om du använderdevelop gren av Stingray engine repo att plocka upp de senaste och största förändringar och buggfixar, använddevelop gren av denna repo att bygga din plug-in.

• Om du vill att din plug-in för att stödja en kommande version som ännu inte är offentligt tillgänglig men som har sin egen release gren i Stingray engine repository, använd matchande release gren av denna repo för att hålla i synk.

steg 3. Ställ in din bibliotekskatalog

varje revision av plugin-källkoden beror på bibliotek och beroenden som inte lagras i Git. Istället kopierar våra byggverktyg dessa bibliotek till din dator från en lagringsplats på Internet.

innan du kör en byggnad måste du ange en plats på din dator där du vill att byggnaden ska lagra och komma åt dessa bibliotek.

• skapa en miljövariabel med namnet SR_LIB_DIR. Ange dess värde till en tom katalog på din dator där du vill att biblioteken ska kopieras.

steg 4. Bygg

om du inkluderar en C/C++-plugin för motorn eller redigeraren, bygg den genom att köra skriptet make.rb i rotkatalogen i detta arkiv.

> ruby make.rb

detta kommando:

• uppdaterar automatiskt din bibliotekskatalog med rätt versioner av alla bibliotek som behövs för din build.
• genererar och bygger Visual Studio-lösningar för Stingray engine och redigeringsverktyg.
• erbjuder flera parametrar som du kan använda för att styra vad som byggs och hur. Ring det med kommandoradsparametern --help för att få en lista över alla tillgängliga parametrar.

OBS: Om du får ett fel om certifikatverifiering kan du behöva installera den här SSL-korrigeringen för RubyGems

Byggresultat

som standard skriver skriptet alla kompilerade .dll-filer till katalogen plugin/binaries under rotkatalogen där du klonade Stingray-källkoden.

Du kan också använda Visual Studio-lösningarna som genereras i mapparna build/engine och build/editor för att arbeta med källkoden och bygga om dina bibliotek.

handledning!

se wikin för en handledning som leder dig steg för steg genom processen att göra en plug-in som utökar både motorn och redigeraren.

katalogstruktur

• build: olika byggutgångar (dvs. cmake-genererade lösningar)
• cmake: Cmake-hjälparskript nedladdade av spm
• editor: en mapp där du kan lägga C/C++ – kod som utökar redigeraren.
• engine: en mapp där du kan lägga C/C++ – kod som förlänger runtime-motorn.
• plugin: andra plugin-källor (plugin-deskriptor, redigeringstillägg, kompilerad redigerare och motorförlängningar, etc.)
• stingray_sdk: Stingray editor och motor C/C++ header baserat plugin SDK hämtat av spm.
• tools: Olika byggverktyg nedladdade av spm.
• make.rb: Bygg gränssnittsskript. Kör make.rb --help för att se alla alternativ.

När du har byggt Stingray-plugin kan du zip mappen plugin och distribuera ditt plugin. För hjälp med att komma igång med Stingray SDK, SE handledningsvideor och ämnen i Stingray SDK-hjälpen.

Plugin struktur

• stingray-example.plugin: Initial plugin deskriptor. Det rekommenderas starkt att byta namn på filnamnet på den här filen.
• sample_project/: exempelprojekt som visar hur ditt plugin fungerar.

mer hjälp

se Stingray SDK-hjälpen för mer information om hur du arbetar med plug-ins, API-referensdokumentation och mer.

Håll kontakten!

din feedback är viktig för att göra denna produkt till en framgång. Hjälp oss genom att dela dina åsikter om alla saker vi gör fel i Stingray användarforum eller i användarforum på Autodesk beta portal. Autodesk ingenjörer och designers är aktivt engagerade i forumtrådarna, så att du kan göra din röst hörd högt och tydligt och få hjälp direkt från källan.