AutodeskGames/stingray-plugin

dette depotet gir en enkel måte å komme i gang med å lage nye plug-ins For Autodesk Stingray 1.9.

du finner en prøve plug-in som allerede er satt opp med noe grunnleggende innhold, og et rammeverk som du kan bygge på:

• en prøve .stingray_plugin descriptor fil, som forteller Stingray hva plug-in er og hva den gjør.
• Ulike komponenter som utvider Stingray-miljøet:
  • Innholdsressurser som plugin – modulen gjør tilgjengelig for Alle stingray-prosjektene du åpner i redigeringsprogrammet.
  • C / C++ – kode som utvider kjøretidsmotoren med ny funksjonalitet.C / C++ – kode som utvider redaktørens JavaScript-miljø med kroker til funksjoner implementert i innfødt kode.JavaScript-moduler som utvider stingray-editoren med nye paneler, menyer og kommandoer.
  • Et Stingray-innholdsprosjekt som plug-in-brukerne dine vil se i Maler-fanen til Prosjektlederen.
• Alt du trenger for å bygge c / C++ plug-in kode inn .dll-filer klar for motoren og redaktøren å laste:
  • make.rb lanserer plug-in build-systemet.
  • spm.rb henter og installerer byggepakker og eksterne biblioteker. Det kalles internt av make.rb, men du kan også bruke den på egen hånd også hvis plug-in har andre avhengigheter som du vil laste ned automatisk.
  • cmake genererer Og kompilerer Visual Studio-løsninger for de opprinnelige plugin-utvidelsene.

for mer informasjon om plug-ins, hvordan de fungerer, og hva du kan gjøre med Dem, se Stingray SDK Hjelp.

Trinn 1. Installer forutsetninger

du trenger En Git-klient for å klone innholdet i denne repo til datamaskinen.

Hvis du vil at plugin-modulen skal inkludere c/C++ – biblioteker som utvider redigeringsprogrammet eller motoren, trenger du også:

• Ruby 2.0 eller nyere.

• Node 6.11.2 LTS eller nyere.

• Visual Studio-2015 Med Oppdatering 3 & Oppdatering KB3165756.

Trinn 2. Få en lokal kopi av kilden

du må få innholdet i denne repoen til datamaskinen din slik at du kan jobbe med den.

VIKTIG: du må få den versjonen av denne repo som tilsvarer den versjonen Av Stingray som du vil bruke plug-in med! Dette gjelder spesielt hvis plug-in vil bruke En C / C++ .eller editor, siden du trenger kompatible versjoner Av Stingray SDK header filer for å kompilere plug-in mot.

• master grenen er alltid synkronisert med den nyeste versjonen Av Stingray. Dette er standardgrenen du får hvis du kloner denne repoen. Bruk den hvis du vil at plugin-modulen skal fungere med den gjeldende versjonen Av Stingray.

• Hvis du ønsker å sette opp plug-in til å fungere med en tidligere versjon Av Stingray, kan du få en versjon av denne repo å matche ved å sjekke ut en release tag, eller laste ned kilden Fra Utgivelser fanen På GitHub.

hvis du har tilgang til kildekoden For Stingray:

• hvis du brukerdevelop grenen Av Stingray engine repo å plukke opp de nyeste og største endringene og feilrettinger, brukdevelop grenen av denne repo å bygge din plug-in.

• hvis du vil at plugin-modulen din skal støtte en kommende utgivelse som ennå ikke er offentlig tilgjengelig, men som har sin egen release – gren I stingray engine-depotet, bruker du den matchende release – grenen av denne repoen for å holde den synkronisert.

Trinn 3. Konfigurer bibliotekskatalogen

Hver revisjon av plugin-kildekoden avhenger av biblioteker og avhengigheter som ikke er lagret I Git. I stedet kopierer byggeverktøyene våre disse bibliotekene til datamaskinen din fra et lagringssted på Internett.

Før du kjører en build, må du angi et sted på datamaskinen der du vil at build skal lagre og få tilgang til disse bibliotekene.

• Opprett en miljøvariabel med navnet SR_LIB_DIR. Angi verdien til en tom katalog på datamaskinen der du vil at bibliotekene skal kopieres.

Trinn 4. Bygg

hvis Du inkluderer En c/C++ plug-in for motoren eller redaktøren, bygg den ved å kjøre make.rb skriptet i rotkatalogen i dette depotet.

> ruby make.rb

denne kommandoen:

• oppdaterer automatisk bibliotekkatalogen din med de riktige versjonene av alle biblioteker som trengs for byggingen din.
• genererer Og bygger Visual Studio-løsninger for Stingray-motoren og redigeringsverktøyene.
• tilbyr flere parametere som du kan bruke til å kontrollere hva som blir bygget og hvordan. Ring det med kommandolinjeparameteren --help for å få en liste over alle tilgjengelige parametere.

MERK: hvis du får en feil om sertifikatbekreftelse, må du kanskje installere DENNE SSL-reparasjonen For RubyGems

Bygge resultater

som standard skriver skriptet alt kompilert .dll-filer til plugin/binaries katalogen under rotkatalogen der Du klonet Stingray kildekoden.

Du kan også bruke Visual Studio-løsningene som genereres ibuild/engine ogbuild/editor – mappene til å arbeide med kildekoden og bygge bibliotekene på nytt.

Opplæring!

Se wikien for en veiledning som leder deg trinnvis gjennom prosessen med å lage en plugin som utvider både motoren og redaktøren.

Katalogstruktur

• build: Ulike bygge utganger (dvs. CMake genererte løsninger)
• cmake: CMake helper scripts lastet ned av spm
• editor: en mappe Hvor Du kan sette C / C++ kode som utvider redaktøren.
• engine: en mappe der Du kan sette C / C++ – kode som utvider kjøretidsmotoren.
• plugin: andre plugin kilder (plugin descriptor, editor utvidelse, kompilert redaktør og motor extenions, etc.)
• stingray_sdk: stingray redaktør Og motor C/C++ header basert plugin SDK lastet ned avspm.
• tools: Ulike byggverktøy lastet ned av spm.
• make.rb: Bygg grensesnittskript. Utfør make.rb --help for å se alle alternativene.

Når Du har bygget stingray plugin, kan du zip denplugin mappen og distribuere plugin. For hjelp til å komme i gang Med Stingray SDK, se opplæringsvideoer og emner i Hoved Stingray SDK Hjelp.

Plugin struktur

• stingray-example.plugin: Innledende plugin beskrivelse. Det anbefales sterkt å gi nytt navn til filnavnet til denne filen.
• sample_project/: Eksempel prosjekt som viser hvordan plugin fungerer.

Mer hjelp

se Stingray SDK Hjelp for mer informasjon om å jobbe med plug-ins, API referanse dokumentasjon, og mer.

Hold kontakten!

din tilbakemelding er viktig for å gjøre dette produktet til en suksess. Vennligst hjelp oss ved å dele dine meninger om alt vi gjør galt i Stingray brukerforum eller i brukerforum På Autodesk beta portal. Autodesks ingeniører og designere er aktivt engasjert i forumtrådene, slik at du kan få stemmen din hørt høyt og tydelig og få hjelp rett fra kilden.