AutodeskGames / stingray-plugin

Este repositorio proporciona una forma sencilla de empezar a crear nuevos complementos para Autodesk Stingray 1.9.

Encontrará un complemento de muestra que ya está configurado con contenido básico y un marco en el que puede crear:

• Un ejemplo .archivo descriptor stingray_plugin, que le dice a Stingray qué es su complemento y qué hace.
• Varios componentes que amplían el entorno de rayas:
  • Recursos de contenido que el complemento pone a disposición de todos los proyectos Stingray que abra en el editor.
  • Código C / C++ que amplía el motor de tiempo de ejecución con nuevas funcionalidades.
  • Código C / C++ que extiende el entorno JavaScript del editor con hooks a funciones implementadas en código nativo.
  • Módulos JavaScript que amplían el editor de rayas con nuevos paneles, menús y comandos.
  • Un proyecto de contenido de rayas que los usuarios del complemento verán en la pestaña Plantillas del Administrador de proyectos.
• Todo lo que necesita para crear código de complemento de C / C++.archivos dll listos para que el motor y el editor carguen:
  • make.rb inicia el sistema de compilación del complemento.
  • spm.rb obtiene e instala paquetes de compilación y bibliotecas externas. Se llama internamente por make.rb, pero también puede usarlo por sí solo si su complemento tiene otras dependencias que desea descargar automáticamente.
  • cmake genera y compila soluciones de Visual Studio para las extensiones de plug-in nativas.

Para obtener más información sobre los complementos, cómo funcionan y qué puede hacer con ellos, consulte la ayuda del SDK de Stingray.

Paso 1. Requisitos previos de instalación

Necesitará un cliente Git para clonar el contenido de este repositorio en su computadora.

Si desea que su complemento incluya bibliotecas de C/C++ que amplíen el editor o el motor, también necesitará:

• Ruby 2.0 o posterior.

• Nodo 6.11.2 LTS o posterior.

• Visual Studio 2015 con actualización 3 & Parche KB3165756.

Paso 2. Obtenga una copia local de la fuente

Necesitará obtener el contenido de este repositorio en su computadora para que pueda trabajar con él.

IMPORTANTE: ¡Necesita obtener la versión de este repositorio que corresponda a la versión de Stingray con la que usará su complemento! Esto es especialmente cierto si su complemento usará un C / C++ .dll para ampliar el motor o editor, ya que necesitará versiones compatibles de los archivos de encabezado del SDK de Stingray para compilar su complemento.

• La rama master siempre está sincronizada con la última versión de Stingray. Esta es la rama predeterminada que obtendrá si clona este repositorio. Úselo si desea que su complemento funcione con la versión actual de Stingray.

• Si quieres configurar tu complemento para que funcione con una versión anterior de Stingray, puedes obtener una versión de este repositorio que coincida con una etiqueta de lanzamiento o descargando el código fuente de la pestaña Lanzamientos en GitHub.

Si tiene acceso al código fuente de Stingray:

• Si está utilizando la rama develop del repositorio del motor Stingray para recoger los últimos y más grandes cambios y correcciones de errores, use la rama develop de este repositorio para crear su complemento.

• Si desea que su complemento admita una próxima versión que aún no esté disponible públicamente, pero que tenga su propia rama release en el repositorio del motor Stingray, use la rama release de este repositorio para mantenerse sincronizado.

Paso 3. Configurar el directorio de la biblioteca

Cada revisión del código fuente del complemento depende de bibliotecas y dependencias que no están almacenadas en Git. En su lugar, nuestras herramientas de compilación copian estas bibliotecas en su computadora desde una ubicación de almacenamiento en Internet.

Antes de ejecutar una compilación, debe especificar una ubicación en el equipo en la que desea que la compilación almacene y acceda a estas bibliotecas.

• Cree una variable de entorno llamada SR_LIB_DIR. Establezca su valor en cualquier directorio vacío de su equipo en el que desee copiar las bibliotecas.

Paso 4. Compilar

Si está incluyendo un complemento de C / C++ para el motor o el editor, compílelo ejecutando el script make.rb en el directorio raíz de este repositorio.

> ruby make.rb

Este comando:

• actualiza automáticamente el directorio de la biblioteca con las versiones correctas de todas las bibliotecas necesarias para su compilación.
• genera y construye soluciones de Visual Studio para el motor Stingray y las herramientas de edición.
• ofrece varios parámetros que puede usar para controlar lo que se construye y cómo. Llámelo con el parámetro de línea de comandos --help para obtener una lista de todos los parámetros disponibles.

NOTA: Si obtiene un error sobre la verificación de certificados, es posible que deba instalar esta corrección SSL para RubyGems

Resultados de compilación

De forma predeterminada, el script escribe todo lo compilado .archivos dll en el directorio plugin/binaries en el directorio raíz en el que clonó el código fuente de Stingray.

También puede utilizar las soluciones de Visual Studio generadas en las carpetas build/engine y build/editor para trabajar con el código fuente y reconstruir sus bibliotecas.

Tutorial!

Vea el wiki para ver un tutorial que lo guía paso a paso a través del proceso de hacer un plug-in que extienda tanto el motor como el editor.

Estructura de directorios

• build: Varias salidas de compilación (es decir, soluciones generadas por CMake)
• cmake: Scripts de ayuda CMake descargados por spm
• editor: Una carpeta donde puede poner código C/C++ que extiende el editor.
• engine: Una carpeta donde puede poner código C / C++ que extiende el motor de tiempo de ejecución.
• plugin : Otras fuentes de complementos (descriptor de complemento,extensión de editor, editor compilado y extensiones de motor, etc.)
• stingray_sdk: SDK de plugin basado en encabezado de C/C++ del editor y motor Stingray descargado por spm.
• tools: Varias herramientas de compilación descargadas por spm.
• make.rb: Script de interfaz de compilación. Ejecute make.rb --help para ver todas las opciones.

Una vez que haya creado correctamente el complemento Stingray, puede comprimir la carpeta plugin y distribuir su complemento. Para obtener ayuda para comenzar con el SDK de Stingray, consulte los vídeos tutoriales y los temas de la Ayuda principal del SDK de Stingray.

Estructura del complemento

• stingray-example.plugin: Descriptor inicial del complemento. Se recomienda encarecidamente cambiar el nombre del archivo de este archivo.
• sample_project/: Proyecto de ejemplo que demuestra cómo funciona tu plugin.

Más ayuda

Consulte la ayuda del SDK de Stingray para obtener más información sobre cómo trabajar con complementos, documentación de referencia de API y mucho más.

¡Mantente en contacto!

Sus comentarios son esenciales para hacer de este producto un éxito. Ayúdenos compartiendo sus opiniones sobre todas las cosas que estamos haciendo mal en el foro de usuarios de Stingray o en los foros de usuarios del portal beta de Autodesk. Los ingenieros y diseñadores de Autodesk participan activamente en los hilos del foro, para que pueda hacer que su voz se escuche fuerte y clara y obtener ayuda directamente de la fuente.