Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugin info in repository #4

Open
geraintluff opened this issue Nov 20, 2024 · 3 comments
Open

Plugin info in repository #4

geraintluff opened this issue Nov 20, 2024 · 3 comments

Comments

@geraintluff
Copy link
Collaborator

The repository currently just lists plugin IDs (e.g. com.u-he.Zebra2). FlatHub has short descriptions and screenshots - ReaPack has something similar as well.

Should there be some equivalent in the WCLAP repos? The helper tool can populate basic info from clap_plugin_descriptor (e.g. name, description).

@abique
Copy link
Contributor

abique commented Nov 21, 2024

Yes we should allow more attributes.
We could even have links to audio or video demos?

Question: how to moderate if a plugin has mature content in its screenshots?

@geraintluff
Copy link
Collaborator Author

geraintluff commented Nov 21, 2024

how to moderate if a plugin has mature content in its screenshots?

The same way we make sure the plugin name/description isn't a list of racial slurs, I guess. 🤷‍♂️ Linking a repo from the official CLAP registry is a reputational risk, so it would only include developers we trust.

Third-party registries can (and should!) proliferate, and the official registry might only exist as a convenience so people aren't faced with an empty list when first opening the official bridge plugin.

However, we should make sure that any content is displayed alongside its source (registry/repo name and domain) so that it doesn't look like a CLAP endorsement.

@geraintluff
Copy link
Collaborator Author

geraintluff commented Nov 21, 2024

My original concern was that the repo only contained IDs, and I think they should be objects based on a JSON translation of the clap_plugin_descriptor struct:

{
	"name": "Official u-he repository",
	"logoUrl": "https://u-he.com/wclap/logo.png",
	"modules": [
		{
			"name": "u-he Zebra2",
			"url": "https://u-he.com/wclap/Zebra2-X.Y.Z.wclap.tar.gz",
			"plugins":[
				{
					"id": "com.u-he.Zebra2",
					"name": "Zebra2",
					"version": "X.Y.Z"
					"vendor": ...,
				}
			]
		}
	]
}

(Note the top-level list is named "modules", and "version" is now attached to the individual plugins.)

Any extra fields for screenshots could also go in that "plugins" entry:

{
	"id": "com.u-he.Zebra2",
	... // and other clap_plugin_descriptor fields
	"links": [
		{
			"rel": "icon",
			"href": "https://u-he.com/wclap/Zebra2-X.Y.Z/icon.png",
			"type": "image/png", // optional
			"title": "TITLE" // optional
		},
		{"rel": "attachment", "href": "https://u-he.com/wclap/Zebra2-X.Y.Z/screenshot.png"},
		...
	]
}

The rel/title/type fields here are pretty generic (matching the attributes of RFC 5988, the HTML DOM <link> object, and the JSON Hyper-Schema "Link Description Object").

We could recommend some rel values to support, while still allowing the whole extensible taxonomy. I think "attachment" is a reasonable rel value for screenshots/videos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants