AutodeskGames / stingray-plugin

toto úložiště poskytuje snadný způsob, jak začít vytvářet nové plug-iny pro Autodesk Stingray 1.9.

najdete ukázkový plug-in, který je již nastaven s nějakým základním obsahem, a rámec, na kterém můžete stavět:

• vzorek .soubor deskriptoru stingray_plugin, který říká Stingray, co je váš plug-in a co dělá.
• různé komponenty, které rozšiřují prostředí Rejnoka:
  • obsahové zdroje, které váš plug-in zpřístupní všem projektům Stingray, které otevřete v editoru.
  • C / C++ kód, který rozšiřuje runtime engine o nové funkce.
  • C / C++ kód, který rozšiřuje JavaScript prostředí editoru s háčky na funkce implementované v nativním kódu.
  • JavaScript moduly, které rozšiřují Editor Stingray o nové panely, nabídky a příkazy.
  • projekt obsahu Rejnoka, který uživatelé plug-inu uvidí na kartě šablony správce projektu.
• vše, co potřebujete k sestavení c/c++ plug-in kódu do .soubory dll připravené pro načtení motoru a editoru:
  • make.rb spustí systém plug-in build.
  • spm.rb načte a nainstaluje sestavení balíčků a externích knihoven. Interně se nazývá make.rb, ale můžete jej také použít samostatně, pokud má váš plug – in jiné závislosti, které chcete stáhnout automaticky.
  • cmake generuje a kompiluje řešení Visual Studio pro nativní rozšíření plug-in.

Další informace o plug-inech, jak fungují a co s nimi můžete dělat, naleznete v nápovědě Stingray SDK.

Krok 1. Instalace předpokladů

k klonování obsahu tohoto repo do počítače budete potřebovat klienta Git.

Pokud chcete, aby váš plug-in zahrnoval knihovny C / C++, které rozšiřují editor nebo motor, budete také potřebovat:

• Ruby 2.0 nebo novější.

• uzel 6.11.2 LTS nebo novější.

• Visual Studio 2015 s aktualizací 3 & Patch KB3165756.

Krok 2. Získejte místní kopii zdroje

budete muset získat obsah tohoto repo do počítače, abyste s ním mohli pracovat.

důležité: musíte získat verzi tohoto repo, která odpovídá verzi Stingray, se kterou budete plug-in používat! To platí zejména v případě, že váš plug-in bude používat C / C++ .dll rozšířit motor nebo editor, protože budete potřebovat kompatibilní verze souborů záhlaví Stingray SDK zkompilovat plug-in proti.

• větev master je vždy synchronizována s nejnovější verzí Stingray. Toto je výchozí větev, kterou získáte, pokud klonujete toto repo. Použijte jej, pokud chcete, aby váš plug-in pracoval s aktuální verzí Stingray.

• Pokud chcete nastavit plug-in pro práci s předchozí verzi Stingray, můžete získat verzi tohoto repo zápas o kontrolu z vydání tag, nebo stahování zdroj od Vydání karty na GitHub.

Pokud máte přístup ke zdrojovému kódu Rejnoka:

• Pokud jste pomocí develop pobočka Stingray engine repo, aby vyzvednout nejnovější a největší změny a opravy chyb, použijte develop pobočka této repo budovat svůj plug-in.

• Pokud chcete, aby vaše plug-in na podporu nadcházející verzi, která není zatím veřejně k dispozici, ale která má vlastní release pobočky v Stingray engine úložiště, použijte odpovídající release pobočka této repo udržet v synchronizaci.

Krok 3. Nastavte adresář knihovny

každá revize zdrojového kódu pluginu závisí na knihovnách a závislostech, které nejsou uloženy v Gitu. Místo toho naše nástroje pro sestavení zkopírují tyto knihovny do počítače z úložiště na internetu.

před spuštěním sestavení musíte v počítači určit umístění, kam chcete sestavení uložit a přistupovat k těmto knihovnám.

• Vytvořte proměnnou prostředí s názvem SR_LIB_DIR. Nastavte jeho hodnotu na libovolný prázdný adresář v počítači, kam chcete kopírovat knihovny.

Krok 4. Vybudovat

Pokud jste, včetně C/C++ modul plug-in pro motor nebo editor, vytvořit spuštěním make.rb skript v kořenovém adresáři tohoto úložiště.

> ruby make.rb

Tento příkaz:

• automaticky aktualizuje adresář knihovny správnými verzemi všech knihoven potřebných pro sestavení.
• generuje a vytváří řešení Visual Studio Pro Stingray engine a editační nástroje.
• nabízí několik parametrů, které můžete použít k ovládání toho, co se staví a jak. Zavolejte jej pomocí parametru příkazového řádku --help a získejte seznam všech dostupných parametrů.

POZNÁMKA: Pokud se zobrazí chybová zpráva o ověření certifikátu, možná budete muset nainstalovat tento SSL fix pro RubyGems

Vytvořit výsledky

ve výchozím nastavení, scénář píše všechny sestaven .soubory dll do adresáře plugin/binaries pod kořenovým adresářem, ve kterém jste klonovali zdrojový kód Stingray.

můžete také použít Visual Studio řešení vytvořené v build/enginebuild/editor složky pro práci se zdrojovým kódem a obnovit své knihovny.

Tutorial!

viz wiki pro tutoriál, který vás krok za krokem provede procesem vytváření plug-in, který rozšiřuje jak motor, tak editor.

adresářová struktura

• build: různé výstupy sestavení (tj. řešení generovaná CMake)
• cmake: CMake pomocné skripty stažené pomocí spm
• editor: složky, kde si můžete dát C/C++ kód, který rozšiřuje editor.
• engine: složka, do které můžete vložit kód C / C++, který rozšiřuje runtime engine.
• plugin: další zdroje pluginů (deskriptor pluginů, rozšíření editoru, kompilované rozšíření editoru a motoru atd.)
• stingray_sdk: Stingray editor a engine C/C++ záhlaví založené plugin SDK stáhnout pomocí spm.
• tools: Různé nástroje pro sestavení stažené pomocí spm.
• make.rb: vytvořit skript rozhraní. Spustit make.rb --help Chcete-li zobrazit všechny možnosti.

Jakmile jste úspěšně postavil Stingray plugin, můžete zip plugin složky a distribuovat plugin. Pro pomoc Začínáme s Stingray SDK, viz výuková videa a témata v hlavní nápovědě Stingray SDK.

struktura pluginu

• stingray-example.plugin: počáteční deskriptor pluginu. Důrazně doporučujeme přejmenovat název souboru tohoto souboru.
• sample_project/: příklad projektu, který ukazuje, jak váš plugin funguje.

další nápověda

Další podrobnosti o práci s plug-iny, referenční dokumentací API a další naleznete v nápovědě Stingray SDK.

Zůstaňte v kontaktu!

vaše zpětná vazba je nezbytná pro úspěch tohoto produktu. Prosím, pomozte nám sdílet své názory na všechny věci, které děláme špatně v uživatelském fóru Stingray nebo v uživatelských fórech na portálu Autodesk beta. Inženýři a návrháři společnosti Autodesk se aktivně podílejí na vláknech fóra, takže můžete hlas slyšet hlasitě a jasně a získat pomoc přímo ze zdroje.