AutodeskGames / Stingray-plugin

este repositório oferece uma forma fácil de começar a criar novos plug-ins para o Autodesk Stingray 1.9.

Você vai encontrar um plugin de exemplo que já está configurado com algum conteúdo básico, e uma estrutura que você pode construir em:

• uma amostra .ficheiro descritor stingray_plugin, que diz ao Stingray o que é o seu plug-in e o que faz.vários componentes que estendem o ambiente de Stingray:
  • Recursos de conteúdo que o seu plugin disponibiliza a todos os projectos Stingray que abre no editor.
  • C / C++ code that extends the runtime engine with new functionality.
  • C / C++ code that extends the editor’s JavaScript environment with hooks to functions implemented in native code.módulos JavaScript que estendem o editor Stingray com novos painéis, menus e comandos.
  • um projecto de conteúdo de Stingray que os seus utilizadores do ‘plugin’ irão ver na página de modelos do Gestor de projectos.
• tudo o que necessita para criar o código de plugin C/C++.DLL files ready for the engine and editor to load:
  • make.rb launches the plug-in build system.
  • spm.rb obtém e instala pacotes de compilação e bibliotecas externas. Ele é chamado internamente por make.rb, mas você também pode usá-lo por conta própria, bem como se seu plug-in tem outras dependências que você deseja baixar automaticamente.
  • cmake gera e compila soluções de estúdio Visual para as extensões plug-in nativas.

Para mais informações sobre plug-ins, como eles funcionam, e o que você pode fazer com eles, consulte a ajuda SDK Stingray.

Passo 1. Instale pré-requisitos

você vai precisar de um cliente Git para clonar o conteúdo deste repo para o seu computador.

Se quiser que o seu ‘plugin’ inclua bibliotecas de C/C++ que extendam o editor ou o motor, também irá precisar de:

• Ruby 2.0 ou mais tarde.

• nó 6.11.2 LTS ou mais tarde.Visual Studio 2015 with Update 3 & Patch KB3165756.

Passo 2. Obtenha uma cópia local da fonte

você terá que obter o conteúdo deste repo para o seu computador para que você possa trabalhar com ele.

importante: você precisa obter a versão deste repo que corresponde à versão do Stingray que você vai usar seu plug-in com! Isto é especialmente verdadeiro se o seu plugin usar um C / C++ .dll para estender o motor ou editor, uma vez que você vai precisar de versões compatíveis dos arquivos de cabeçalho Stingray SDK para compilar seu plug-in Contra.

• omaster branch está sempre em sincronia com a última versão lançada do Stingray. Este é o ramo padrão que você vai obter se você clonar este repo. Use-o se quiser que o seu ‘plugin’ funcione com a versão actual do Stingray.

• Se você deseja configurar o plug-in para trabalhar com uma versão anterior do Stingray, você pode obter uma versão deste acordo de recompra para corresponder ao conferir o lançamento de uma versão de marca, ou baixar o código fonte do Lança guia no GitHub.

Se tiver acesso ao código-fonte para Stingray:

• Se estiver a usar odevelop ramo do repo do Motor Stingray para obter as últimas e Maiores alterações e correcções de erros, use odevelop ramo deste repo para criar o seu ‘plugin’.

• Se quiser que o seu ‘plugin’ suporte uma próxima versão que ainda não está disponível publicamente, mas que tem o seu próprio release ramificação no repositório de motores Stingray, use o correspondente release ramificação deste acordo para manter a sincronização.

Passo 3. Configure o seu directório de biblioteca

cada revisão do código fonte de plugin depende de bibliotecas e dependências que não são armazenadas no Git. Em vez disso, as nossas ferramentas de construção copiam estas bibliotecas para o seu computador a partir de um local de armazenamento na Internet.

Antes de executar uma compilação, tem de indicar uma localização no seu computador onde deseja que a compilação guarde e aceda a estas bibliotecas.

• crie uma variável de ambiente chamada SR_LIB_DIR. Configure o seu valor para qualquer pasta vazia no seu computador, onde deseja que as bibliotecas sejam copiadas.

Passo 4. Compilar

Se estiver a incluir um ‘plugin’ de C/C++ para o motor ou o editor, compila-o executando o ‘ ID ‘make.rb no directório raiz deste repositório.

> ruby make.rb

Este comando:

• actualiza automaticamente a sua pasta de biblioteca com as versões correctas de todas as bibliotecas necessárias para a sua compilação.
• gera e constrói soluções de estúdio Visual para o motor Stingray e ferramentas de edição.
• oferece vários parâmetros que você pode usar para controlar o que é construído e como. Chame – o com o parâmetro --help linha de comando para obter uma lista de todos os parâmetros disponíveis.

Nota: Se tiver um erro na verificação do certificado, poderá ter de instalar esta correcção SSL para RubyGems

construir resultados

por omissão, o programa escreve tudo compilado .ficheiros dll para oplugin/binaries directório sob a directoria root na qual clonou o código fonte do Stingray.

Você também pode usar o Visual Studio soluções geradas build/engine e build/editor pastas para trabalhar com o código-fonte e reconstruir suas bibliotecas.Tutorial!

veja o wiki para um tutorial que o acompanha passo a passo através do processo de fazer um plug-in que estende tanto o motor como o editor.

estrutura de pastas

• build: várias saídas de compilação (isto é, soluções geradas por CMake)
• cmake: Programas auxiliares do CMake transferidos por spm
• : uma pasta onde pode colocar o código C / C++ que estende o editor.
• engine: uma pasta onde pode colocar o código C/C++ que estende o motor de execução.
• plugin: outras fontes de plugin (descritor do plugin, extensão do editor, editor compilado e extensões do motor, etc.)
• stingray_sdk: editor de Stingray e plugin C/C++ baseado no cabeçalho SDK baixado por spm.
• : Várias ferramentas de compilação baixadas por spm.
• make.rb: Programa de interface de Compilação. Execute make.rb --help para ver todas as opções.

Depois de ter construído com sucesso o ‘plugin’ Stingray, poderá fechar a pastaplugin e distribuir o seu ‘plugin’. Para obter ajuda com o Stingray SDK, consulte os vídeos e tópicos do tutorial na Ajuda principal Stingray SDK.

estrutura do Plugin

• stingray-example.plugin: descritor inicial do plugin. É fortemente recomendado mudar o nome do ficheiro deste ficheiro.
• sample_project/: projecto de exemplo que demonstra como o seu plugin funciona.

mais ajuda

Por favor veja a ajuda SDK Stingray para mais detalhes sobre trabalhar com plug-ins, documentação de referência da API, e muito mais.Mantenha-se em contacto!

o seu feedback é essencial para fazer deste produto um sucesso. Por favor, ajude-nos compartilhando suas opiniões sobre todas as coisas que estamos fazendo de errado no fórum de usuários Stingray ou nos fóruns de usuários no portal beta Autodesk. Engenheiros e designers da Autodesk estão ativamente envolvidos nos tópicos do fórum, para que você possa fazer sua voz ouvir alto e claro e obter ajuda diretamente da fonte.