Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Submitting to the Asset Library

Introdução

This tutorial aims to serve as a guide on how you can submit your own assets to the Godot Asset Library and share them with the Godot community.

Como mencionado no documento Using the Asset Library, para poder enviar recursos para a Biblioteca de recursos, você vai precisar ter uma conta registrada e estar logado.

Diretrizes de submissão

Before submitting your asset, please ensure it follows all of the requirements, and also consider following the recommendations.

Requisitos

Generally speaking, most assets people submit to the asset library are accepted. However, in order for your asset to be accepted, there are a few requirements your asset needs to meet to be approved.

• 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.

• A licença precisa ser a certa. A licença listada na biblioteca de recursos precisa corresponder a licença do repositório. O repositório precisa ter um arquivo de licença, chamado "LICENSE" ou "LICENSE.md". Este arquivo precisa conter o texto da licença que inclua o(s) ano(s) e uma declaração do detentor dos direitos autorais.

• 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.

• O link para o ícone precisa ser um link direto. Para links hospedados no GitHub, o link precisa começar com "raw.githubusercontent.com", não com "github.com".

Recomendações

Estas coisas não são requisito para que seus recursos sejam aprovados, porém, se você seguir estás recomendações você pode ajudar a fazer da biblioteca de recursos um lugar melhor para todos.

• When creating non-project assets, it is common practice to place your files inside of an addons/asset_name/ folder. Do this to avoid having your files clash with other assets, or with the files of users installing your asset. This folder will not be automatically generated when a user installs your asset.

• Corrija ou oculte todos os alertas do script. O sistema de alerta está lá para ajuda-lo a identificar problemas no seu código , porém, pessoas usando seus recursos não precisam vê-los.

• 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 Guia de Estilo GDScript or the Guia de Estilo C#.

• If you have screenshots in your repo, place them in their own subfolder and add an empty .gdignore file in the same folder (note: gd, not git). This prevents Godot from importing your screenshots. On Windows, open a command prompt in the project folder and run type nul > .gdignore to create a file whose name starts with a period.

• Se os recursos da sua biblioteca interagirem com outros arquivos, considere incluir arquivos de exemplo.

• 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, preventing them from being downloaded by the asset library users. These are common examples of .gitattributes:

  Projects / TemplatesAddons / Asset Packs

  # Normalize line endings for all files that Git considers text files.
  * text=auto eol=lf
  

• 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).

• 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.

Enviando

Once you are logged in, you will be able to head over to the "Submit Assets" page of the AssetLib, which will look like this:

Embora possa parecer que haja muito (e há mais à medida que vai descendo a página), cada campo é intuitivo sobre o que deve se preencher. No entanto, vamos também rever aqui o que é necessário em cada campo do formulário de envio.

• Nome do Recurso:

  O nome do seu arquivo. Deve ser único, um titulo que descreva o que seu arquivo é.

• Categoria:

  The category that your asset belongs to, and will be shown in search results. The category is split into Addons and Projects. In-editor, assets of the Project type (Templates, Demos, Projects) only show up when viewing the AssetLib from the Project Manager, while assets of the Addon type will only be visible from inside a project.

• Versão da Godot:

  A versão da engine com a qual o recurso é compatível. Atualmente, não é possível que um único recurso inclua downloads para várias versões da engine, por isso, poderá ser necessário reenviar o recurso várias vezes, com uma entrada para cada versão do Godot que ele suporta. Isto é particularmente importante quando se trata de versões principais da engine, como o Godot 2.x e o Godot 3.x.

• Versão:

  The version number of the asset. While you are free to choose and use any versioning scheme that you like, you may want to look into something such as SemVer if you want your asset's versioning scheme to be clear and consistent. Note that there is also an internal version number, incremented every time the asset download URL is changed or updated.

• Host do repositório:

  Assets uploaded to the AssetLib are not hosted on it directly. Instead, they point to repositories hosted on third-party Git providers, such as GitHub, GitLab or Bitbucket. This is where you choose which provider your asset uses, so the site can compute the final download link.

• URL do repositório:

  The URL to your asset's files/webpage. This will vary based on your choice of provider, but it should look similar to https://github.com/<user>/<project>.

• URL de problemas:

  The URL to your asset's issue tracker. Again, this will differ from repository host to repository host, but will likely look similar to https://github.com/<user>/<project>/issues. You may leave this field empty if you use your provider's issue tracker, and it's part of the same repository.

• Baixar Commit:

  The commit of the asset. For example, b1d3172f89b86e52465a74f63a74ac84c491d3e1. The site computes the actual download URL from this.

• URL do ícone:

  O URL do ícone do seu recurso (que será utilizado como miniatura nos resultados de pesquisa da AssetLib e na página do recurso). Deve ser uma imagem no formato PNG ou JPG.

  The icon must be square (1:1 aspect ratio). It should have a minimum resolution of 128×128 pixels.

Nota

For icons hosted on GitHub, URLs must be provided in the form of https://raw.githubusercontent.com/<user>/<project>/<branch>/Icon.png.

• Licença:

  The license under which you are distributing the asset. The list includes a variety of free and open source software licenses, such as GPL (v2 and v3), MIT, BSD and Boost Software License. You can visit OpenSource.org for a detailed description of each of the listed licenses.

• Descrição:

  Finally, you can use the Description field for a textual overview of your asset, its features and behavior, a changelog, et cetera. In the future, formatting with Markdown will be supported, but currently, your only option is plain text.

You may also include up to three video and/or image previews, which will be shown at the bottom of the asset page. Use the "Enable" checkbox on each of the preview submission boxes to enable them.

• Tipo:

  Either an image, or a video.

• Image/YouTube URL:

  Ou um link para a imagem, ou para um vídeo, hospedado no YouTube.

• URL da Thumbnail:

  Uma URL para uma imagem que será usada como thumbnail para a pré-visualização. Esta opção será removida eventualmente, e as thumbnail serão automaticamente computadas.

Uma vez que terminar, aperte "Enviar". Seu recurso(asset) será enviado para a fila de análise. Você pode checar todos os assets que estão em espera na fila aqui . O processo de aprovação é manual e pode levar até alguns dias para que seu recurso seja aceito (ou rejeitado), então por favor tenha paciência!

Você será informado quando seu asset for revisado. Se ele foi rejeitado, você receberá um porque disso, e você poderá mandá-lo novamente com as mudanças apropriadas.