AutodeskGames / stingray-plugin

dette arkiv giver en nem måde at komme i gang med at oprette nye plug-ins til Autodesk Stingray 1.9.

du finder et eksempel på plug-in, der allerede er konfigureret med noget grundlæggende indhold, og en ramme, som du kan bygge videre på:

• en prøve .stingray_plugin deskriptor fil, som fortæller Stingray, hvad din plug-in er, og hvad den gør.
• forskellige komponenter, der udvider Stingray-miljøet:
  • indholdsressourcer, som din plug-in Gør tilgængelig for alle Stingray-projekter, du åbner i editoren.
  • C / C++ – kode, der udvider runtime-motoren med ny funktionalitet.
  • C / C++ kode, der udvider editorens JavaScript-miljø med kroge til funktioner implementeret i native code.
  • JavaScript-moduler, der udvider Stingray-editoren med nye paneler, menuer og kommandoer.
  • et Stingray-indholdsprojekt, som dine plug-in-brugere vil se på fanen Skabeloner i projektlederen.
• alt hvad du behøver for at opbygge C / C++ plug-in kode til .DLL-filer klar til, at motoren og editoren kan indlæses:
  • make.rb lancerer plug-in build-systemet.
  • spm.rb henter og installerer bygge pakker og eksterne biblioteker. Det kaldes internt af make.rb, men du kan også bruge det alene, hvis din plug-in har andre afhængigheder, som du vil hente automatisk.
  • cmake genererer og kompilerer Visual Studio-løsninger til de oprindelige plug-in-udvidelser.

For mere information om plug-ins, hvordan de fungerer, og hvad du kan gøre med dem, se Stingray SDK hjælp.

Trin 1. Installer forudsætninger

Du skal bruge en Git-klient til at klone indholdet af denne repo til din computer.

Hvis du vil have din plug-in til at omfatte C/C++ – biblioteker, der udvider editoren eller motoren, skal du også:

• Ruby 2.0 eller nyere.

• Node 6.11.2 LTS eller nyere.

• Visual Studio 2015 med opdatering 3 & Patch KB3165756.

Trin 2. Få en lokal kopi af kilden

Du skal hente indholdet af denne repo til din computer, så du kan arbejde med det.

vigtigt: du skal få den version af denne repo, der svarer til den version af Stingray, som du vil bruge din plug-in med! Dette gælder især, hvis din plug-in vil bruge en C/C++ .dll at udvide motoren eller editor, da du skal bruge kompatible versioner af Stingray SDK header filer til at kompilere din plug-in mod.

• master gren er altid synkroniseret med den seneste udgivne version af Stingray. Dette er den standardgren, du får, hvis du kloner denne repo. Brug den, hvis du vil have din plug-in til at arbejde med den aktuelle version af Stingray.

• Hvis du vil konfigurere dit plug-in til at fungere med en tidligere version af Stingray, kan du få en version af denne repo til at matche ved at tjekke et release tag eller hente kilden fra fanen Releases på GitHub.

Hvis du har adgang til kildekoden til Stingray:

• Hvis du brugerdevelop grenen af Stingray engine repo for at hente de nyeste og bedste ændringer og fejlrettelser, skal du brugedevelop grenen af denne repo til at opbygge din plug-in.

• Hvis du vil have din plug-in til at understøtte en kommende udgivelse, der endnu ikke er offentligt tilgængelig, men som har sin egenrelease gren i Stingray engine repository, skal du bruge den matchenderelease gren af denne repo for at holde synkronisering.

Trin 3. Opsæt dit bibliotek mappe

hver revision af plug-in kildekoden afhænger af biblioteker og afhængigheder, der ikke er gemt i Git. I stedet kopierer vores byggeværktøjer disse biblioteker til din computer fra en lagerplads på internettet.

før du kører en build, skal du angive en placering på din computer, hvor du vil have build til at gemme og få adgang til disse biblioteker.

• Opret en miljøvariabel med navnetSR_LIB_DIR. Indstil dens værdi til et tomt bibliotek på din computer, hvor bibliotekerne skal kopieres.

Trin 4. Byg

Hvis du inkluderer et C/C++-plug-in til motoren eller editoren, skal du bygge det ved at køre make.rb script i rodmappen til dette lager.

> ruby make.rb

denne kommando:

• opdaterer automatisk dit biblioteksmappe med de korrekte versioner af alle biblioteker, der er nødvendige til din build.
• genererer og bygger Visual Studio-løsninger til Stingray-motoren og redigeringsværktøjerne.
• tilbyder flere parametre, som du kan bruge til at styre, hvad der bliver bygget og hvordan. Kald det med --help kommandolinjeparameter for at få en liste over alle tilgængelige parametre.

BEMÆRK: Hvis du får en fejl om certifikatbekræftelse, skal du muligvis installere denne SSL-rettelse til RubyGems

Build results

som standard skriver scriptet alle kompilerede .DLL-filer til plugin/binaries – mappen under rodmappen, hvor du klonede Stingray-kildekoden.

Du kan også bruge Visual Studio-løsninger genereret i build/engineog build/editor mapper til at arbejde med kildekoden og genopbygge dine biblioteker.

Tutorial!

se en tutorial, der går dig trin for trin gennem processen med at lave en plug-in, der udvider både motoren og editoren.

mappestruktur

• build: forskellige byggeudgange (dvs. CMake genererede løsninger)
• cmake: CMake helper scripts hentet af spm
• editor: en mappe, hvor du kan sætte C/C++ kode, der udvider editoren.
• engine: en mappe, hvor du kan sætte C/C++ – kode, der udvider runtime-motoren.
• plugin: andre plugin kilder (plugin deskriptor, editor udvidelse, kompileret editor og motor udvidelser, etc.)
• stingray_sdk: Stingray editor og motor C/C++ header baseret plugin SDK hentet af spm.
• tools: Forskellige bygge værktøjer hentet af spm.
• make.rb: Byg interface script. Udfør make.rb --help for at se alle mulighederne.

Når du har bygget Stingray plugin, kan du Lynlåsplugin mappe og distribuere dit plugin. For hjælp til at komme i gang med med Stingray SDK, se tutorial videoer og emner i de vigtigste Stingray SDK hjælp.

Plugin struktur

• stingray-example.plugin: Initial plugin deskriptor. Det anbefales kraftigt at omdøbe filnavnet på denne fil.
• sample_project/: eksempel projekt, der viser, hvordan dit plugin fungerer.

mere hjælp

se Stingray SDK hjælp for flere detaljer om at arbejde med plug-ins, API reference dokumentation og meget mere.

Hold kontakten!

din feedback er afgørende for at gøre dette produkt til en succes. Hjælp os ved at dele dine meninger om alle de ting, vi gør forkert i Stingray-brugerforumet eller i brugerforaene på Autodesk beta-portalen. Autodesk ingeniører og designere er aktivt engageret i forum tråde, så du kan gøre din stemme hørt højt og tydeligt og få hjælp direkte fra kilden.