Presentando a la Biblioteca de Activos

Introducción

Este tutorial tiene como objetivo servir de guía sobre cómo puede presentar sus propios bienes a la Biblioteca de Recursos Godot y compartirlos con la comunidad Godot.

Como se menciona en el documento Uso de la biblioteca de activos, para poder presentar los recursos a la AssetLib, es necesario tener una cuenta registrada y estar conectado.

Directrices de presentación

Antes de presentar su recurso, por favor asegúrese de que cumple con todos los requisitos, y también considere seguir las recomendaciones.

Requerimientos

En términos generales, la mayoría de los bienes que la gente presenta a la biblioteca de bienes son aceptados. Sin embargo, para que su recurso sea aceptado, hay algunos requisitos que tu recurso que deben cumplirse para ser aprobado.

  • El recurso debe funcionar. Si el recurso no se ejecuta o no funciona en la versión especificada de Godot, entonces será rechazado.

  • El recurso debe tener un archivo .gitignore adecuado. Es importante mantener los datos redundantes fuera del repositorio. "Aquí hay una plantilla. <https://github.com/github/gitignore/blob/master/Godot.gitignore>`_

  • No hay submódulos, o cualquier submódulo debe ser no esenciales. GitHub no incluye submódulos en el archivo ZIP descargado, por lo que si el activo necesita el contenido del submódulo, tu recurso no funcionará.

  • La licencia tiene que ser correcta. La licencia que aparece en la biblioteca de recursos debe coincidir con la licencia del repositorio. El repositorio DEBE tener un archivo de licencia, llamado "LICENSE" o "LICENSE.md". Este archivo debe contener el texto de la licencia en sí y una declaración de copyright que incluya el año o años y el titular del copyright.

  • Use el inglés apropiado para el nombre y la descripción de tu recurso. Esto incluye el uso correcto de las mayúsculas y el uso de frases completas en la descripción.

  • El enlace del icono debe ser un enlace directo. Para los iconos alojados en GitHub, el enlace debe comenzar con "raw.githubusercontent.com", no con "github.com".

Recomendaciones

Estas cosas no son necesarias para que su recurso sea aprobado, pero si sigue estas recomendaciones, puede ayudar a que la biblioteca de recursos sea un lugar mejor para todos los usuarios.

  • Arregle o suprima todas las advertencias del script. El sistema de advertencias está ahí para ayudar a identificar problemas con su código, pero la gente que usa tu activo no necesita verlos.

  • Haz que tu código se ajuste a las guías de estilo oficiales. Tener un estilo consistente ayuda a otras personas a leer tu código, y también ayuda si otras personas desean contribuir a tu recurso. Ver: la Guía de estilo de GDScript o la Guía de estilo de C#.

  • Si tiene capturas de pantalla en su repo, colóquelas en su propia subcarpeta y añada un archivo .gdignore en la misma carpeta (nota: gd, no git). Esto evita que Godot importe tus capturas de pantalla. En Windows, abra un símbolo del sistema en la carpeta de proyectos y ejecute type nul > .gdignore para crear un archivo cuyo nombre comience con un punto.

  • Si tu recurso es una biblioteca para trabajar con otros archivos, considere la posibilidad de incluir archivos de ejemplo en el recurso.

  • El icono debe ser un cuadrado, su relación de aspecto debe ser 1:1. También debería tener una resolución mínima de 64x64 píxeles.

  • Aunque la biblioteca de recursos permite más que sólo GitHub, considera alojar el código fuente de tu recurso en GitHub. Otros servicios pueden no funcionar de forma fiable, y la falta de familiaridad puede ser una barrera para los colaboradores.

Presentando

Una vez que haya iniciado sesión, podrá dirigirse a la página "Enviar Recursos" de la AssetLib, que se verá así:

|imagen0|

Aunque puede parecer mucho (y hay más a medida que se desplaza hacia abajo), cada campo se describe en términos de lo que se debe poner. No obstante, también repasaremos aquí lo que se requiere en el formulario de presentación.

  • Nombre del Recurso:

    El nombre de tu recurso. Debe ser un título único y descriptivo de lo que es tu recurso.

  • Categoría:

    La categoría a la que pertenece tu recurso, y se mostrará en los resultados de la búsqueda. La categoría se divide en Adjuntos y Proyectos. En el editor, los recursos del tipo Proyecto (Plantillas, Demostraciones, Proyectos) sólo se muestran cuando se visualiza la AssetLib desde el Administrador de Proyectos, mientras que los recursos del tipo Addon sólo serán visibles desde el interior de un proyecto.

  • Versión de Godot:

    La versión del motor con el que trabaja el recurso. Actualmente, no es posible tener una sola entrada de recurso que contenga descargas para múltiples versiones de motor, por lo que puede ser necesario volver a enviar el recurso varias veces, con una entrada para cada versión de Godot que soporte. Esto es particularmente importante cuando se trata de versiones principales del motor, como Godot 2.x y Godot 3.x.

  • Versión:

    El número de versión del recurso. Mientras que eres libre de elegir y utilizar cualquier esquema de versionado que te guste, puedes buscar algo como SemVer si quieres que el esquema de versionado de tu recurso sea claro y consistente. Tenga en cuenta que también hay un número de versión interno, que se incrementa cada vez que se cambia o actualiza la URL de descarga del recurso.

  • Anfitrión del repositorio:

    Los recursos subidos en la AssetLib no están alojados en ella directamente. En su lugar, apuntan a repositorios alojados en terceros proveedores de Git, como GitHub, GitLab o Bitbucket. Aquí es donde eliges qué proveedor utiliza tu recurso, para que el sitio pueda calcular el enlace de descarga final.

  • URL de Repositorio:

    La URL de los archivos/página web de tu recurso. Esto variará en función de su elección de proveedor, pero debe ser similar a "https://github.com/", "usuario" o "proyecto".

  • Problemas de URL:

    La URL del rastreador de problemas de tu recurso. De nuevo, esto diferirá de un host de repositorio a otro, pero probablemente se verá similar a https://github.com/<user>/<project>/issues. Puedes dejar este campo vacío si utilizas el rastreador de problemas de tu proveedor, y es parte del mismo repositorio.

  • Descargar el Commit:

    El commit del recurso. Por ejemplo, "b1d3172f89b86e52465a74f63a74ac84c491d3e1". El sitio calcula la URL de descarga real a partir de esto.

  • URL de Icono:

    La URL del icono de tu recurso (que se utilizará como miniatura en los resultados de búsqueda de AssetLib y en la página del recurso). Debe ser una imagen en formato PNG o JPG.

  • Licencia:

    La licencia bajo la cual está distribuyendo el recurso. La lista incluye una variedad de licencias de software libre y de código abierto, como la GPL (v2 y v3), MIT, BSD y Boost Software License. Puede visitar OpenSource.org para una descripción detallada de cada una de las licencias listadas.

  • Descripción:

    Por último, puede utilizar el campo Descripción para obtener una visión general textual de tu recurso, sus características y comportamiento, un registro de cambios, etc. En el futuro, se soportará el formato con Markdown, pero actualmente, su única opción es el texto sin formato.

También puede incluir hasta tres vistas previas de vídeo y/o imágenes, que se mostrarán en la parte inferior de la página del recurso. Utilice la casilla de verificación "Habilitar" en cada una de las cajas de presentación de vistas previas para habilitarlas.

  • Tipo:

    O una imagen o un video.

  • URL Imagen/Youtube:

    Un enlace a la imagen, o a un video, alojado en YouTube.

  • Url Miniatura:

    Una URL de una imagen que será usada como una miniatura para la vista previa. Esta opción será eliminada eventualmente, y las miniaturas serán computadas automáticamente en su lugar.

Una vez que hayas terminado, presiona Enviar. Tu recurso será introducido en la cola de espera, que puedes visitar en el AssetLib aquí . El proceso de aprobación es manual y puede tardar unos días para que tu addon sea aceptado (o rechazado), así que por favor, ¡ten paciencia! Se te informará cuando tu addon sea revisado. Si fue rechazado, se te dirá por qué puede haber sido, y podrá- presentarlo de nuevo con los cambios apropiados. Puede que tengas algo de suerte acelerando el proceso de aprobación enviando un mensaje a los moderadores/revisores de recursos en el IRC (el canal godotengine-atelier en Freenode), o al servidor oficial de Discord.