AutodeskGames / stingray-plugin

acest depozit oferă o modalitate ușoară de a începe crearea de noi plug-in-uri pentru Autodesk Stingray 1.9.

veți găsi un exemplu de plug-in care este deja configurat cu un conținut de bază și un cadru pe care puteți construi:

• un eșantion .stingray_plugin fișier descriptor, care spune Stingray ce plug-in-ul este și ceea ce face.
• diverse componente care extind mediul Stingray:
  • resurse de conținut pe care plug-in-ul dvs. le pune la dispoziția tuturor proiectelor Stingray pe care le deschideți în editor.
  • C / C++ cod care extinde motorul de rulare cu noi funcționalități.
  • cod C/C++ care extinde mediul JavaScript al editorului cu cârlige la funcții implementate în cod nativ.
  • module JavaScript care extind editorul Stingray cu noi panouri, meniuri și comenzi.
  • un proiect de conținut Stingray pe care utilizatorii plug-in-ului dvs. îl vor vedea în fila șabloane a Managerului de proiect.
• tot ce ai nevoie pentru a construi C / C++ cod plug-in în .fișiere dll gata pentru încărcarea motorului și editorului:
  • make.rb lansează sistemul de construire plug-in.
  • spm.rb preia și instalează construi pachete și biblioteci externe. Se numește intern prin make.rb, dar îl puteți utiliza și singur dacă plug-in-ul dvs. are alte dependențe pe care doriți să le descărcați automat.
  • cmake generează și compilează soluții Visual Studio pentru extensiile plug-in native.

Pentru mai multe informații despre plug-in-uri, cum funcționează și ce puteți face cu ele, consultați ajutorul Stingray SDK.

Pasul 1. Instalați cerințe preliminare

veți avea nevoie de un client Git pentru a clona conținutul acestui repo pe computer.

dacă doriți ca plug-in-ul dvs. să includă biblioteci C/C++ care extind editorul sau motorul, veți avea nevoie și de:

• Ruby 2.0 sau o versiune ulterioară.

• nod 6.11.2 LTS sau mai târziu.

• Visual Studio 2015 cu actualizare 3& Patch KB3165756.

Pasul 2. Obțineți o copie locală a sursei

va trebui să obțineți conținutul acestui repo pe computer, astfel încât să puteți lucra cu acesta.

IMPORTANT: trebuie să obțineți versiunea acestui repo care corespunde versiunii Stingray cu care veți folosi plug-in-ul! Acest lucru este valabil mai ales dacă plug-in-ul dvs. va utiliza un c/c++ .dll pentru a extinde motorul sau editorul, deoarece veți avea nevoie de versiuni compatibile ale fișierelor antet Stingray SDK pentru a compila plug-in-ul împotriva.

• master filiala este întotdeauna sincronizată cu cea mai recentă versiune lansată de Stingray. Aceasta este ramura implicită pe care o veți obține dacă clonați acest repo. Utilizați – l dacă doriți ca pluginul dvs. să funcționeze cu versiunea curentă a Stingray.

• dacă doriți să configurați plug-in-ul pentru a lucra cu o versiune anterioară a Stingray, puteți obține o versiune a acestui repo pentru a se potrivi prin verificarea unei etichete de lansare, sau descărcarea sursei din fila versiuni pe GitHub.

Dacă aveți acces la codul sursă pentru Stingray:

• dacă utilizațidevelop ramură a repo motor Stingray pentru a ridica cele mai recente și mai mari modificări și bug fixat, utilizațidevelop ramură a acestui repo pentru a construi plug-in-ul.

• dacă doriți ca plug-in-ul dvs. să accepte o versiune viitoare care nu este încă disponibilă public, dar care are propria sa ramurărelease în depozitul motorului Stingray, utilizați ramurarelease a acestui repo pentru a păstra sincronizarea.

Pasul 3. Configurați directorul Bibliotecii

fiecare revizuire a codului sursă plug-in depinde de biblioteci și dependențe care nu sunt stocate în Git. În schimb, instrumentele noastre de construire copiază aceste biblioteci pe computerul dvs. dintr-o locație de stocare de pe Internet.

înainte de a executa o compilare, trebuie să specificați o locație pe computer unde doriți să stocheze compunerea și să acceseze aceste biblioteci.

• creați o variabilă de mediu numităSR_LIB_DIR. Setați valoarea sa la orice director gol de pe computer unde doriți să fie copiate bibliotecile.

Pasul 4. Construiți

dacă includeți un plug-in C/C++ pentru motor sau editor, construiți-l rulând scriptulmake.rb în directorul rădăcină al acestui depozit.

> ruby make.rb

această comandă:

• actualizează automat directorul Bibliotecii cu versiunile corecte ale tuturor bibliotecilor necesare pentru construirea dvs.
• generează și construiește soluții Visual Studio pentru motorul Stingray și instrumente de editare.
• oferă mai mulți parametri pe care le puteți utiliza pentru a controla ceea ce se construiește și cum. Apelați-l cu --help parametrul liniei de comandă pentru a obține o listă cu toți parametrii disponibili.

NOTĂ: Dacă primiți o eroare la verificarea certificatului, poate fi necesar să instalați această remediere SSL pentru RubyGems

construiți rezultate

în mod implicit, scriptul scrie toate compilate .fișiere dll în directorul plugin/binaries din directorul rădăcină în care ați clonat codul sursă Stingray.

de asemenea, puteți utiliza soluțiile Visual Studio generate în folderelebuild/engine șibuild/editor pentru a lucra cu codul sursă și a reconstrui bibliotecile.

Tutorial!

a se vedea wiki pentru un tutorial care te plimba pas cu pas prin procesul de a face un plug-in care se extinde atât motorul și editorul.

structura de directoare

• build: diverse ieșiri de construire (adică soluții generate CMake)
• cmake : Scripturi de ajutor CMake descărcate de spm
• editor: un folder în care puteți pune codul C/C++ care extinde editorul.
• engine: un folder în care puteți pune codul C / C++ care extinde motorul de rulare.
• plugin: alte surse de plugin (descriptor de plugin, extensie editor, Editor compilat și extensii de motor etc.)
• stingray_sdk: Stingray editor și motor c/c++ antet pe bază de plugin SDK descărcat despm.
• tools: Diverse instrumente de construire descărcate de spm.
• make.rb: construi script-ul de interfață. Executați make.rb --help pentru a vedea toate opțiunile.

odată ce ați construit cu succes plugin Stingray, puteți zipplugin folderul și distribui plugin-ul. Pentru ajutor Noțiuni de bază cu Stingray SDK, consultați videoclipurile tutorial și subiecte în principal Stingray SDK ajutor.

structura pluginului

• stingray-example.plugin: descriptorul inițial al pluginului. Este recomandat să redenumiți numele fișierului acestui fișier.
• sample_project/: exemplu de proiect care demonstrează modul în care funcționează plugin-ul.

mai mult ajutor

vă rugăm să consultați Stingray SDK ajutor pentru mai multe detalii despre lucrul cu plug-in-uri, documentația de referință API, și mai mult.

păstrați legătura!

feedback-ul dvs. este esențial pentru a face acest produs un succes. Vă rugăm să ne ajutați prin împărtășirea opiniilor dvs. despre toate lucrurile pe care le facem greșit în Forumul utilizatorilor Stingray sau în forumurile utilizatorilor de pe portalul Autodesk beta. Inginerii și designerii Autodesk sunt implicați activ în firele forumului, astfel încât să vă puteți face vocea auzită tare și clară și să obțineți ajutor direct de la sursă.