AutodeskGames/stingray-plugin

tämä arkisto tarjoaa helpon tavan aloittaa uusien laajennusten luominen Autodesk Stingray 1.9: lle.

löydät näytelaajennuksen, johon on jo perustettu jokin perussisältö, ja kehyksen, jonka varaan voit rakentaa:

• näyte .stingray_plugin descriptor file, joka kertoo Stingraylle, mitä plug-in on ja mitä se tekee.
• useita osia, jotka laajentavat Stingrayn ympäristöä:
  • sisältöresurssit, jotka laajennuksesi tuo kaikkien editorissa avaamiesi Stingray-projektien saataville.
  • C / C++ – koodi, joka laajentaa ajonaikaista moottoria uusilla toiminnoilla.
  • C / C++ – koodi, joka laajentaa muokkaimen JavaScript-ympäristön koukuilla natiivikoodilla toteutettaviin funktioihin.
  • JavaScript-moduulit, jotka laajentavat Stingray-muokkainta uusilla paneeleilla, valikoilla ja komennoilla.
  • Stingray-sisältöprojekti, jonka plug-in-käyttäjät näkevät projektinhallinnan mallineet-välilehdessä.
• kaikki mitä tarvitset C / C++-laajennuskoodin rakentamiseen .DLL-tiedostot valmiina Moottorin ja muokkaimen ladattavaksi:
  • make.rb käynnistää plug-in build-järjestelmän.
  • spm.rb hakee ja asentaa rakennuspaketteja ja ulkoisia kirjastoja. Sitä kutsutaan sisäisesti make.rb, mutta voit käyttää sitä myös yksinään, jos laajennuksessasi on muita riippuvuuksia, jotka haluat ladata automaattisesti.
  • cmake luo ja kokoaa Visual Studio-ratkaisut natiivilaajennuksille.

lisätietoja liitännäisistä, niiden toiminnasta ja siitä, mitä niillä voi tehdä, on Stingrayn SDK-ohjeessa.

Vaihe 1. Asenna edeltävät edellytykset

tarvitset git-asiakasohjelman kloonataksesi tämän repon sisällön tietokoneellesi.

Jos haluat laajennuksen sisältävän C/C++-kirjastoja, jotka laajentavat editoria tai moottoria, tarvitset myös:

• Ruby 2.0 tai uudempi.

• Node 6.11.2 LTS tai uudempi.

Visual Studio 2015 päivityksellä 3&paikkaus KB3165756.

Vaihe 2. Hanki paikallinen kopio lähteestä

sinun täytyy saada tämän repon sisältö tietokoneellesi, jotta voit työskennellä sen kanssa.

tärkeää: sinun täytyy saada tästä reposta se versio, joka vastaa Stingrayn versiota, jonka kanssa käytät laajennustasi! Tämä pätee erityisesti, jos plug-in käyttää C/C++ .DLL laajentaa Moottorin tai editorin, koska tarvitset yhteensopivia versioita Stingray SDK otsikko tiedostoja kääntää plug-in vastaan.

• master haara on aina Stingrayn uusimman julkaistun version tahdissa. Tämän oletushaaran saat, jos kloonaat tämän repon. Käytä sitä, jos haluat plug-inin toimivan Stingrayn nykyisen version kanssa.

• Jos haluat määrittää laajennuksesi toimimaan Stingrayn aikaisemman version kanssa, voit saada tämän repon version vastaamaan tarkistamalla julkaisutunnisteen tai lataamalla lähteen Githubin Releases-välilehdeltä.

Jos sinulla on pääsy Stingrayn lähdekoodiin:

• Jos käytät develop Stingray engine repon haaraa uusimpien ja suurimpien muutosten ja virheenkorjausten hakemiseen, käytä develop tämän repon haaraa laajennuksen rakentamiseen.

• Jos haluat laajennuksesi tukevan tulevaa julkaisua, joka ei ole vielä julkisesti saatavilla, mutta jolla on oma release haara Stingray engine-arkistossa, Käytä tämän repon vastaavaa release haaraa pysyäksesi synkronoituna.

Vaihe 3. Määritä kirjastokansio

jokainen laajennetun lähdekoodin versio riippuu kirjastoista ja riippuvuuksista, joita ei ole tallennettu Git: hen. Sen sijaan rakentamistyökalumme kopioivat nämä kirjastot tietokoneellesi Internetin tallennuspaikasta.

ennen kuin suoritat käännöksen, sinun täytyy määrittää tietokoneellesi paikka, johon haluat käännöksen tallentavan ja käyttävän näitä kirjastoja.

• luo ympäristömuuttuja, jonka nimi on SR_LIB_DIR. Aseta sen arvo mille tahansa tietokoneen tyhjälle hakemistolle, johon haluat kirjastojen kopioitavan.

Vaihe 4. Koosta

Jos käytät c/c++-laajennusta moottorille tai muokkaimelle, rakenna se ajamalla make.rb skripti tämän arkiston juurihakemistoon.

> ruby make.rb

Tämä komento:

• päivittää automaattisesti kirjastohakemistosi oikeilla versioilla kaikista rakentamiseesi tarvittavista kirjastoista.
• luo ja rakentaa visuaalisia Studioratkaisuja Stingray-moottorille ja muokkaustyökaluille.
• tarjoaa useita parametreja, joiden avulla voi kontrolloida, mitä saa rakennettua ja miten. Kutsu sitä --help komentoriviparametrilla saadaksesi listan kaikista käytettävissä olevista parametreista.

HUOM: jos saat virheen varmenteen vahvistuksessa, saatat joutua asentamaan tämän SSL-korjauksen Rubygeemeille

Rakentamistulokset

oletuksena, skripti kirjoittaa kaikki kootusti .dll-tiedostot plugin/binaries hakemistoon juurihakemiston alle, jossa kloonasit Stingrayn lähdekoodin.

voit käyttää myös build/engine ja build/editor – kansioissa tuotettuja Visual Studio-ratkaisuja lähdekoodin työstämiseen ja kirjastojen uudelleenrakentamiseen.

Tutorial!

katso wikistä opetusohjelma, joka opastaa sinut vaihe vaiheelta läpi sekä moottoria että editoria laajentavan laajennuksen tekemisen.

hakemistorakenne

• build: Various build outputs (eli CMake generated solutions)
• cmake: CMake helper scripts latasi spm

editor: kansio, johon voi laittaa editoria laajentavan C/C++ – koodin.

• engine: kansio, johon voi laittaa C / C++ – koodia, joka laajentaa runtime-moottoria.
• plugin: muita liitännäislähteitä (plugin descriptor, editor extension, compiled editor and engine extenions, jne.)
• stingray_sdk: Stingray editor and engine C/C++ header based plugin SDK downloaded by spm.
• tools: Erilaisia käännöstyökaluja latasi spm.
• make.rb: Build interface script. Suorita make.rb --help nähdäksesi kaikki vaihtoehdot.

kun olet onnistunut rakentamaan Stingray-liitännäisen, voit tyhjentää plugin – kansion ja jakaa liitännäisen. Jos haluat apua Stingray SDK: n aloittamiseen, katso opetusvideoita ja aiheita Stingray SDK: n Pääohjeesta.

liitännäisen rakenne

• stingray-example.plugin: liitännäisen alustava kuvaaja. On erittäin suositeltavaa nimetä tiedostonimi tämän tiedoston.
• sample_project/: Esimerkkiprojekti, joka osoittaa, miten plugin toimii.

lisää apua

katso Stingrayn SDK-ohjeesta lisätietoja liitännäisten, API-referenssidokumentaation ja muiden kanssa työskentelystä.

Stay in touch!

palautteesi on oleellista tämän tuotteen menestymisen kannalta. Auta meitä jakamalla mielipiteesi kaikista asioista, joita teemme väärin Stingrayn käyttäjäfoorumilla tai Autodesk beta-portaalin käyttäjäfoorumeilla. Autodeskin insinöörit ja suunnittelijat ovat aktiivisesti mukana foorumin viestiketjuissa, joten voit saada äänesi kuuluviin ääneen ja saada apua suoraan lähteestä.