AutodeskGames/Stingray-plugin

to repozytorium zapewnia łatwy sposób na rozpoczęcie tworzenia nowych wtyczek do Autodesk Stingray 1.9.

znajdziesz przykładową wtyczkę, która jest już skonfigurowana z podstawową zawartością, oraz framework, na którym możesz budować:

• próbka .plik deskryptora stingray_plugin, który mówi Stingray, czym jest twoja wtyczka i co robi.
• różne komponenty rozszerzające środowisko Stingray:
  • zasoby treści, które wtyczka udostępnia wszystkim projektom Stingray, które otwierasz w edytorze.
  • kod C / C++, który rozszerza silnik runtime o nową funkcjonalność.
  • kod C / C++, który rozszerza środowisko JavaScript edytora o Hooki do funkcji zaimplementowanych w kodzie natywnym.
  • Moduły JavaScript rozszerzające edytor Stingray o nowe panele, menu i polecenia.
  • projekt zawartości Stingray, który użytkownicy wtyczek zobaczą na karcie Szablony menedżera projektu.
• wszystko, czego potrzebujesz, aby zbudować kod wtyczki c / c++.pliki dll gotowe do załadowania silnika i edytora:
  • make.rb uruchamia system budowania wtyczek.
  • spm.rb pobiera i instaluje Pakiety kompilacyjne oraz zewnętrzne biblioteki. Jest wywoływany wewnętrznie przez make.rb, ale możesz go również używać samodzielnie, jeśli wtyczka ma inne zależności, które chcesz pobrać automatycznie.
  • cmake generuje i kompiluje rozwiązania Visual Studio dla natywnych rozszerzeń wtyczek.

aby uzyskać więcej informacji na temat wtyczek, ich działania i możliwości korzystania z nich, zobacz Pomoc zestawu SDK Stingray.

Krok 1. Install prerequisites

będziesz potrzebował klienta Git, aby sklonować zawartość tego repozytorium na Twój komputer.

Jeśli chcesz, aby wtyczka zawierała biblioteki C/C++, które rozszerzają edytor lub silnik, będziesz również potrzebował:

• Ruby 2.0 lub nowszy.

• węzeł 6.11.2 LTS lub nowszy.

• Visual Studio 2015 z aktualizacją 3 & Patch KB3165756.

Krok 2. Pobierz lokalną kopię źródła

będziesz musiał pobrać zawartość tego repozytorium na swój komputer, abyś mógł z nim pracować.

ważne: musisz uzyskać wersję tego repozytorium, która odpowiada wersji Stingray, z którą będziesz korzystać z wtyczki! Jest to szczególnie ważne, jeśli wtyczka będzie używać C/C++ .dll, aby rozszerzyć silnik lub edytor, ponieważ będziesz potrzebował kompatybilnych wersji plików nagłówkowych SDK Stingray do skompilowania wtyczki.

• master gałąź jest zawsze zsynchronizowana z najnowszą wydaną wersją Stingray. Jest to domyślna gałąź, którą otrzymasz, jeśli sklonujesz to repozytorium. Użyj go, jeśli chcesz, aby wtyczka działała z bieżącą wersją Stingray.

• Jeśli chcesz skonfigurować wtyczkę do pracy z poprzednią wersją Stingray, możesz pobrać wersję tego repo do dopasowania, sprawdzając tag wydania lub pobierając źródło z karty wydania na Githubie.

Jeśli masz dostęp do kodu źródłowego dla Stingray:

• Jeśli używasz developgałęzi repo silnika Stingray, aby pobrać najnowsze i największe zmiany i poprawki błędów, użyj develop gałęzi tego repo, aby zbudować wtyczkę.

• Jeśli chcesz, aby wtyczka obsługiwała nadchodzące wydanie, które nie jest jeszcze publicznie dostępne, ale które ma własną gałąźreleasew repozytorium silnika Stingray, użyj pasującej gałęzirelease, aby zachować synchronizację.

Krok 3. Skonfiguruj katalog biblioteki

każda wersja kodu źródłowego wtyczki zależy od bibliotek i zależności, które nie są przechowywane w Git. Zamiast tego nasze narzędzia do tworzenia kopiują te biblioteki na komputer z miejsca przechowywania w Internecie.

zanim uruchomisz kompilację, musisz określić lokalizację na komputerze, w której ma ona być przechowywana i uzyskiwać dostęp do tych bibliotek.

• Utwórz zmienną środowiskową o nazwie SR_LIB_DIR. Ustaw jego wartość na dowolny pusty katalog na komputerze, do którego chcesz skopiować biblioteki.

Krok 4. Zbuduj

Jeśli dołączasz wtyczkę c/c++ do silnika lub edytora, zbuduj ją, uruchamiając skryptmake.rb w katalogu głównym tego repozytorium.

> ruby make.rb

To polecenie:

• automatycznie aktualizuje katalog biblioteki o poprawne wersje wszystkich bibliotek potrzebnych do kompilacji.
• generuje i buduje rozwiązania Visual Studio dla silnika Stingray i narzędzi do edycji.
• oferuje kilka parametrów, których możesz użyć do kontrolowania tego, co zostanie zbudowane i jak. Wywołaj go z parametrem wiersza poleceń--help, aby uzyskać listę wszystkich dostępnych parametrów.

UWAGA: Jeśli pojawi się błąd dotyczący weryfikacji certyfikatu, może być konieczne zainstalowanie tej poprawki SSL dla RubyGems

wyniki kompilacji

domyślnie skrypt zapisuje wszystkie skompilowane .pliki dll do katalogu plugin/binaries w katalogu głównym, w którym sklonowano kod źródłowy Stingray.

Możesz również użyć rozwiązań Visual Studio wygenerowanych w folderachbuild/engine Ibuild/editor do pracy z kodem źródłowym i odbudowy bibliotek.

Tutorial!

Zobacz tutorial na wiki, który krok po kroku przeprowadzi Cię przez proces tworzenia wtyczki, która rozszerza zarówno silnik, jak i edytor.

struktura katalogów

• build: różne wyjścia kompilacji (np. rozwiązania generowane przez CMake)
• cmake: Skrypty pomocnicze CMake pobrane przez spm
• editor: folder, w którym można umieścić kod C/C++ rozszerzający edytor.
• engine: folder, w którym można umieścić kod C / C++, który rozszerza silnik runtime.
• plugin: inne źródła wtyczek (deskryptor wtyczki, rozszerzenie edytora, skompilowany edytor i rozszerzenia silnika itp.)
• stingray_sdk: edytor Stingray i pakiet SDK wtyczki oparty na nagłówku C/C++ pobrany przezspm.
• tools : Różne narzędzia do budowania pobrane przez spm.
• make.rb: Zbuduj skrypt interfejsu. Wykonaj make.rb --help, aby zobaczyć wszystkie opcje.

Po pomyślnym zbudowaniu wtyczki Stingray możesz spakować folderplugin i rozpowszechnić swoją wtyczkę. Aby uzyskać pomoc na początku korzystania z zestawu SDK Stingray, Zobacz filmy instruktażowe i tematy w głównej pomocy zestawu SDK Stingray.

struktura wtyczki

• stingray-example.plugin: początkowy deskryptor wtyczki. Zdecydowanie zaleca się zmianę nazwy pliku tego pliku.
• sample_project/: przykładowy projekt pokazujący działanie wtyczki.

więcej pomocy

aby uzyskać więcej informacji na temat pracy z wtyczkami, dokumentacji referencyjnej API i nie tylko, zobacz Pomoc SDK Stingray.

bądź w kontakcie!

twoja opinia jest niezbędna, aby ten produkt odniósł sukces. Prosimy o pomoc, dzieląc się swoimi opiniami na temat wszystkich rzeczy, które robimy źle na forum użytkowników Stingray lub na forach użytkowników w portalu Autodesk beta. Inżynierowie i projektanci Autodesk są aktywnie zaangażowani w wątki na forum, dzięki czemu możesz sprawić, by twój głos był słyszalny głośno i wyraźnie oraz uzyskać pomoc bezpośrednio ze źródła.