Übermittlung an die Bestandsbibliothek

Einführung

Diese Anleitung soll als Leitfaden dienen, wie Sie Ihre eigenen Assets bei der Godot Bestandsbibliothek einreichen und mit der Godot-Gemeinschaft teilen können.

Wie im Dokument Verwenden der Bestandsbibliothek erwähnt, müssen Sie über ein registriertes Konto verfügen und angemeldet sein, um Inhalte an die Bestandsbibliothek senden zu können.

Übergaberichtlinien

Stellen Sie vor dem Einreichen Ihres Assets sicher, dass alle Anforderungen erfüllt sind, und beachten Sie auch die Empfehlungen.

Voraussetzungen

Im Allgemeinen werden die meisten Assets akzeptiert, die von Personen an die Bestandsbibliothek gesendet werden. Damit Ihr Asset akzeptiert werden kann, müssen jedoch einige Anforderungen erfüllt sein, damit es genehmigt werden kann.

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

Empfehlungen

Diese Dinge sind nicht erforderlich, damit Ihr Asset genehmigt wird. Wenn Sie jedoch diese Empfehlungen befolgen, können Sie dazu beitragen, die Bestandsbibliothek für alle Benutzer zu einem besseren Ort zu machen.

  • 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 GDScript Stil-Richtlinien or the C# Stil-Richtlinien.

  • Wenn Sie Screenshots in Ihrer Sammlung haben, platzieren Sie diese in einem eigenen Unterordner und fügen Sie eine .gdignore-Datei im selben Ordner hinzu (Hinweis: gd, nicht git). Dies verhindert, dass Godot Ihre Screenshots importiert. Öffnen Sie unter Windows eine Eingabeaufforderung im Projektordner und führen Sie type nul> .gdignore aus, um eine Datei zu erstellen, deren Name mit einem Punkt beginnt.

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

Einreichen

Sobald Sie angemeldet sind, können Sie zur Seite "Assets Submit" der AssetLib wechseln, die folgendermaßen aussieht:

image0

Es sieht zwar nach viel aus (und es gibt noch mehr, wenn Sie nach unten scrollen), aber zu jedem Feld wird beschrieben, was Sie eingeben sollten. Wir werden jedoch auch hier auf das eingehen, was im Einreichungsformular erforderlich ist.

  • Asset Name:

    Der Name Ihres Assets, es sollte ein eindeutiger, beschreibender Titel sein.

  • Category:

    Die Kategorie, zu der Ihr Inhalt gehört und die in den Suchergebnissen angezeigt wird. Die Kategorie ist in Addons und Projekte unterteilt. Im Editor werden Assets des Projekttyps (Vorlagen, Demos, Projekte) nur angezeigt, wenn die AssetLib im Projektmanager angezeigt wird, während Assets des Addon-Typs nur innerhalb eines Projekts sichtbar sind.

  • Godot version:

    Die Version der Engine, mit der das Asset arbeitet. Derzeit ist es nicht möglich, dass ein einzelner Asset-Eintrag Downloads für mehrere Engine-Versionen enthält. Daher müssen Sie das Asset möglicherweise mehrmals mit einem Eintrag für jede unterstützte Godot-Version erneut senden. Dies ist besonders wichtig, wenn Sie sich mit Hauptversionen der Engine wie Godot 2.x und Godot 3.x befassen.

  • Version:

    Die Versionsnummer des Assets. Sie können zwar ein beliebiges Versionsschema auswählen und verwenden, sollten jedoch möglicherweise etwas wie SemVer verwenden, damit das Versionsschema Ihres Assets klar und konsistent sein soll. Beachten Sie, dass es auch eine interne Versionsnummer gibt, die jedes Mal erhöht wird, wenn die URL zum Herunterladen von Assets geändert oder aktualisiert wird.

  • Repository host:

    In die AssetLib hochgeladene Assets werden nicht direkt darauf gehostet. Stattdessen verweisen sie auf Repositorys, die auf Git-Anbietern von Drittanbietern wie GitHub, GitLab oder Bitbucket gehostet werden. Hier wählen Sie aus, welchen Anbieter Ihr Asset verwendet, damit die Site den endgültigen Download-Link berechnen kann.

  • Repository URL:

    Die URL zu den Dateien/Webseiten Ihres Assets. Dies hängt von Ihrer Wahl des Anbieters ab, sollte jedoch ähnlich wie https://github.com/<user>/<project> aussehen.

  • Issues URL:

    Die URL zum Problem-Tracker Ihres Assets. Dies unterscheidet sich wiederum von Repository-Host zu Repository-Host, sieht jedoch wahrscheinlich ähnlich aus wie https://github.com/<user>/<project>/issues. Sie können dieses Feld leer lassen, wenn Sie den Problem-Tracker Ihres Providers verwenden und er Teil desselben Repositorys ist.

  • Download bestätigen:

    Das Commit des Assets, zum Beispiel b1d3172f89b86e52465a74f63a74ac84c491d3e1. Die Webseite berechnet daraus die tatsächliche Download-URL.

  • Icon URL:

    Die URL zum Symbol Ihres Assets (das als Miniaturbild in den AssetLib-Suchergebnissen und auf der Seite des Assets verwendet wird) sollte ein Bild im PNG oder JPG Format sein.

  • License:

    Die Lizenz unter der Sie den Asset vertreiben. Die Liste enthält eine Vielzahl von kostenlosen und Open-Source-Softwarelizenzen wie GPL (v2 und v3), MIT, BSD und Boost Software License. Sie können OpenSource.org besuchen, um eine detaillierte Beschreibung jeder der aufgelisteten Lizenzen zu erhalten.

  • Beschreibung (Description):

    Schließlich können Sie das Feld Beschreibung für eine Textübersicht Ihres Assets, seiner Funktionen und seines Verhaltens, eines Änderungsprotokolls usw. verwenden. In Zukunft wird die Formatierung mit Markdown unterstützt. Derzeit ist Ihre einzige Option nur Klartext.

Sie können auch bis zu drei Video- und/oder Bildvorschauen einfügen, die unten auf der Asset-Seite angezeigt werden. Verwenden Sie das Kontrollkästchen "Aktivieren" in jedem der Vorschau-Übermittlungsfelder, um sie zu aktivieren.

  • Type:

    Entweder ein Bild oder ein Video.

  • Bild/YouTube URL:

    Entweder ein Verweis auf ein Bild oder ein Video, gehostet auf YouTube.

  • Miniaturbild (Thumbnail) URL:

    Eine URL zu einem Bild, das als Miniaturbild für die Vorschau verwendet wird. Diese Option wird eventuell entfernt und stattdessen werden automatisch Miniaturansichten berechnet.

Wenn Sie fertig sind, klicken Sie auf Senden. Ihr Asset wird in die ausstehende Warteschlange eingetragen, die Sie in der Bestandsbibliothek hier . aufrufen können. Der Genehmigungsprozess ist manuell und es kann bis zu einigen Tagen dauern, bis Ihr Addon akzeptiert (oder abgelehnt) wird. Bitte haben Sie etwas Geduld! Sie werden informiert, wenn Ihr Asset überprüft wurde. Wenn es abgelehnt wurde, wird Ihnen mitgeteilt, warum dies möglicherweise der Fall war, und Sie können es mit den entsprechenden Änderungen erneut einreichen. Möglicherweise haben Sie etwas Glück und können den Genehmigungsprozess beschleunigen, indem Sie den Moderatoren/Assetlib-Überprüfern im IRC (dem Kanal #godotengine-atelier "auf Freenode) oder dem offiziellen Discord-Server eine Nachricht senden.