アセットライブラリへの送信

はじめに

このチュートリアルの目的は、Godotアセットライブラリに独自のアセットを送信してGodotコミュニティと共有する方法についてのガイドとなることです。

AssetLibの使用 ドキュメントで述べたように、AssetLibにアセットを送信できるようにするには、登録済みのアカウントが必要で、ログインする必要があります。

提出ガイドライン

アセットを送信する前に、すべての要件を満たしていることを確認し、推奨事項に従うことも検討してください。

必要条件

一般的に、アセットライブラリに送信するほとんどのアセットは受け入れられます。ただし、アセットが承認されるためには、アセットが承認されるために満たす必要がある要件がいくつかあります。

  • アセットは機能する必要があります。指定したGodotバージョンでアセットが実行されない、または機能しない場合、拒否されます。
  • The asset must have a proper .gitignore file. It's important to keep redundant data out of the repository. Here's a template.
  • サブモジュールがないか、サブモジュールは必須ではありません。 GitHubでは、ダウンロードしたZIPファイルにサブモジュールが含まれていないため、アセットにサブモジュールのコンテンツが必要な場合、アセットは機能しません。
  • ライセンスが正しい必要があります。アセットライブラリにリストされているライセンスは、リポジトリ内のライセンスと一致する必要があります。
  • アセットの名前と説明に適切な英語を使用してください。これには、正しい大文字の使用、および説明内の完全な文の使用が含まれます。
  • アイコンリンクは直接リンクである必要があります。 GitHubでホストされるアイコンの場合、リンクは "github.com" ではなく "raw.githubusercontent.com" で始まる必要があります。

推奨事項

これらはアセットの承認に必須ではありませんが、これらの推奨事項に従えば、すべてのユーザーにとってアセットライブラリをより良い場所にすることができます。

  • すべてのスクリプト警告を修正または抑制します。警告システムはコードの問題を特定するのに役立ちますが、アセットを使用している人はそれらを見る必要はありません。
  • コードを公式のスタイルガイドに準拠させます。一貫したスタイルを持つことは、他の人があなたのコードを読むのを助け、他の人があなたの資産に貢献したい場合にも役立ちます。GDScriptスタイルガイド または C#スタイルガイド を参照してください。
  • アセットが他のファイルを操作するためのライブラリである場合、サンプルファイルをアセットに含めることを検討してください。
  • アイコンは正方形で、アスペクト比は 1:1 でなければなりません。また、理想的な最小解像度は64x64ピクセルである必要があります。
  • アセットライブラリではGitHub以外にも使用できますが、GitHubでアセットのソースコードをホストすることを検討してください。他のサービスは確実に機能しない場合があり、親しみやすさの欠如は貢献者にとって障壁になる可能性があります。

提出する

ログインすると、AssetLibの ”Submit Assets" ページに移動できます。このページは次のようになります:

image0

これは項目が多いように見えるかもしれませんが(下にスクロールするほど多くあります)、各フィールドは、何を記入するべきかという観点から説明がされています。ですが、このチュートリアルでも提出フォームに必要なものを検討しましょう。

  • Asset Name:
    アセットの名前。アセットが何であるかを説明する一意のタイトルにする必要があります。
  • Category:
    アセットが属するカテゴリー。検索結果に表示されます。このカテゴリーは、Addons(アドオン)Projects(プロジェクト) に分かれています。エディタでは、プロジェクトマネージャーからAssetLibを表示するときにのみ、プロジェクトタイプ(テンプレート、デモ、プロジェクト)のアセットが表示されますが、アドオンタイプのアセットはプロジェクト内からのみ表示されます。
  • Godot version:
    アセットが機能するエンジンのバージョン。現在、単一のアセットエントリに複数のエンジンバージョンのダウンロードを含めることはできないため、サポートする各Godotバージョンのエントリを使用して、アセットを複数回再送信する必要があります。これは、Godot 2.xやGodot 3.xなどのエンジンのメジャーバージョンを扱う場合に特に重要です。
  • Version:
    アセットのバージョン番号。好きなバージョン管理スキームを自由に選択して使用できますが、アセットのバージョン管理スキームを明確で一貫性のあるものにしたい場合は、SemVer などを調べてください。アセットのダウンロードURLが変更または更新されるたびに増加する内部バージョン番号もあります。
  • Repository host:
    AssetLibにアップロードされたアセットは、AssetLib上で直接ホストされません。代わりに、GitHub、GitLab、BitbucketなどのサードパーティのGitプロバイダーでホストされているリポジトリを指します。ここで、アセットが使用するプロバイダーを選択するため、サイトは最終的なダウンロードリンクを計算できます。
  • Repository URL:
    アセットのファイル/ウェブページへのURL。これは、選択したプロバイダーによって異なりますが、https://github.com/<user>/<project> に似ているはずです。
  • Issues URL:
    アセットの問題(Issue)トラッカーへのURL。繰り返しますが、これはリポジトリホストごとに異なりますが、https://github.com/<user>/<project>/issues に似ている可能性があります。 プロバイダーの問題トラッカーを使用し、同じリポジトリの一部である場合は、このフィールドを空のままにしておくことができます。
  • Download Commit:
    The commit of the asset. For example, b1d3172f89b86e52465a74f63a74ac84c491d3e1. The site computes the actual download URL from this.
  • Icon URL:
    アセットのアイコンへのURL(AssetLibの検索結果およびアセットのページでサムネイルとして使用されます)。PNGまたはJPG形式の画像である必要があります。
  • License:
    アセットを配布するライセンス。リストには、GPL(v2およびv3)、MIT、BSD、Boost Software Licenseなど、さまざまな無料のオープンソースソフトウェアライセンスが含まれています。リストされている各ライセンスの詳細な説明については、OpenSource.org にアクセスしてください。
  • Description:
    最後に、説明フィールドを、アセットのテキストによる概要、その機能と動作、変更ログなどに使用できます。将来的には、Markdownを使用した書式設定がサポートされますが、現在のところ、唯一のオプションはプレーンテキストです。

アセットページの下部に表示される最大3つのビデオプレビューや画像プレビューを含めることもできます。プレビュー送信ボックスのそれぞれで ”Enable” チェックボックスを使用して、有効にします。

  • Type:
    画像または動画のいずれか。
  • Image/YouTube URL:
    YouTubeでホストされている画像または動画へのリンク。
  • Thumbnail URL:
    プレビューのサムネイルとして使用される画像へのURL。このオプションは最終的に削除され、代わりにサムネイルが自動的に計算されます。

Once you are done, hit Submit. Your asset will be entered into the pending queue, which you can visit on the AssetLib here . The approval process is manual and may take up to a few days for your addon to be accepted (or rejected), so please be patient! You will be informed when your asset is reviewed. If it was rejected, you will be told why that may have been, and you will be able to submit it again with the appropriate changes. You may have some luck accelerating the approval process by messaging the moderators/assetlib reviewers on IRC (the #godotengine-atelier channel on Freenode), or the official Discord server.