godot-asset-library-client 0.1.0

Interaction with the Godot Asset Library

godot-asset-library-client

Interact with the Godot Asset Library

This script retrieves all the information already available in the project to upload an Godot asset into the Godot asset library.

Features

• Smart metadata gathering: avoid duplicating information already there
• Smart behaviour with existing pending edits
• Smart behaviour with existing previews (still not working)
• Shortcuts for previews hosted youtube or the repository (still not working)

Install

pip install godot-asset-library-client

Usage

• Define GODOT_ASSET_LIB_USER and GODOT_ASSET_LIB_PASSWORD environment variables. You may use a .env file with them but consider security concerns.

• Write a yaml metadata file with content similar to this:

# asset-metadata.yaml

asset_id: '6666666' # You will obtain this id after the first publication by hand
repo_hosting: GitHub
repo: vokimon/godot-dice-roller
branch: main
category: "1" # 2D Tools
project_license: AGPLv3
previews:

# Shortcut for youtube previews
- youtube: AD8awHLpFxs

# Shortcut for media commited in the repository
- repoimage: /screenshots/example-landscape.png
  repothumb: /screenshots/example-landscape-thumb.jpg

# If not shortcutted the preview entry should look like this
- type: image
  link: https://raw.githubusercontent.com/vokimon/godot-dice-roller/refs/heads/main/screenshots/example-portrait.png
  thumbnail: https://raw.githubusercontent.com/vokimon/godot-dice-roller/refs/heads/main/screenshots/example-portrait-thumb.jpg

# These will be concatenated and processed as description
description_files:
- README.md
- CHANGES.md

Then, from the root of your project (where project.godot resides):

godot-asset-library-client asset-metadata.yaml

Check that the metadata is correct, and then add the option --do:

godot-asset-library-client asset-metadata.yaml --do

Smart metadata guessing

If not explicitly provided, it takes most metadata from existing files in your repository so you don't have to duplicate that.

From project.godot:

• Project name
• Project version
• Project description
• Project icon
• Godot version

From local git:

• Commit hash

TODO

Sure you can help with those:

• BUG: Previews are generated as json but the api returns a warning and ignores them
• Solve the emoji problem by not removing them. The blacklist is quite limited and fragile.
• Support first upload of a project
• Auto-identify license available in repository
• Auto-identify branch from current branch
• Auto-identify repo name from git remote
• Auto-identify repo hosting, first just check it is github
• Support for other repo hosting services