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.

  • The asset must work. If the asset doesn't run or otherwise doesn't work in the specified Godot version, then it will be rejected.

  • The asset must have a proper .gitignore file. It's important to keep redundant data out of the repository. Here's a template.

  • No submodules, or any submodules must be non-essential. GitHub does not include submodules in the downloaded ZIP file, so if the asset needs the contents of the submodule, your asset won't work.

  • The license needs to be correct. The license listed on the asset library must match the license in the repository. The repo MUST have a license file, called either "LICENSE" or "LICENSE.md". This file must contain the license text itself and a copyright statement that includes the year(s) and copyright holder.

  • Use proper English for the name and description of your asset. This includes using correct capitalization, and using full sentences in the description. You can also include other languages, but there should at least be an English version.

  • The icon link must be a direct link. For icons hosted on GitHub, the link must start with "raw.githubusercontent.com", not "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.

  • Fix or suppress all script warnings. The warning system is there to help identify issues with your code, but people using your asset don't need to see them.

  • Make your code conform to the official style guides. Having a consistent style helps other people read your code, and it also helps if other people wish to contribute to your asset. See: the Guía de estilo de GDScript or the 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.

  • If your asset is a library for working with other files, consider including example files in the asset.

  • Consider adding a .gitattributes file to your repo. This file allows giving extra instructions to Git, such as specifying line endings and listing files not required for your asset to function with the export-ignore directive. This directive removes such files from the resulting ZIP file and prevents them from being downloaded by the asset library users. For a typical plugin .gitattributes may look like this:

    # Normalize EOL for all files that Git considers text files.
    * text=auto eol=lf
    
    # Ignore some files when exporting to a ZIP.
    /.gitattributes     export-ignore
    /.gitignore         export-ignore
    /LICENSE            export-ignore
    /LICENSE.md         export-ignore
    /README.md          export-ignore
    /project.godot      export-ignore
    /icon.png           export-ignore
    /icon.svg           export-ignore
    

    Other types of assets may require a different configuration (e.g. a project template requires project.godot).

  • If you are submitting a plugin, add a copy of your license and readme to the plugin folder itself. This is the folder that users are guaranteed to keep with their project, so a copy ensures they always have those files handy (and helps them fulfill your licensing terms).

  • The icon should be a square, its aspect ratio should be 1:1. It should also ideally have a minimum resolution of 64x64 pixels.

  • While the asset library allows more than just GitHub, consider hosting your asset's source code on GitHub. Other services may not work reliably, and a lack of familiarity can be a barrier to contributors.

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.