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

Add more metadata fields to plugin.yml #254

Open
kevinjosethomas opened this issue Jan 30, 2021 · 9 comments
Open

Add more metadata fields to plugin.yml #254

kevinjosethomas opened this issue Jan 30, 2021 · 9 comments
Labels
Enhancement New feature, request, or thing Good First Issue Good for newcomers

Comments

@kevinjosethomas
Copy link
Contributor

Feature

Add more meta data fields to plugin.yml like -

  • name (required)
  • description
  • version (required)
  • author
  • license
  • website/docs?

Reason

Allows more customizability for the developer, easily provide information about the plugin in a command like /pl info? and much much more; no harm, most of it is optional

@kevinjosethomas kevinjosethomas added the Enhancement New feature, request, or thing label Jan 30, 2021
@Iapetus-11
Copy link
Member

@all-contributors add @trustedmercury ideas

@allcontributors
Copy link
Contributor

@Iapetus-11

I've put up a pull request to add @trustedmercury! 🎉

@Iapetus-11 Iapetus-11 added the Good First Issue Good for newcomers label Feb 2, 2021
@Sh-wayz Sh-wayz linked a pull request Feb 11, 2021 that will close this issue
@Sh-wayz
Copy link
Member

Sh-wayz commented Feb 25, 2021

Pretty sure this isn't something that needs any changes, all fields are loaded from the plugin.yml already afaik, it's up to the dev to include it.

@Sh-wayz Sh-wayz changed the title Add more meta data fields to plugin.yml Add more metadata fields to plugin.yml Feb 26, 2021
@Iapetus-11
Copy link
Member

Although, these fields (because they'll probably be used in something like a /plugins command), should be required, not up to the dev to add it. Changes for this will prob be made in pymine/api/__init__.py

@Sh-wayz
Copy link
Member

Sh-wayz commented Feb 26, 2021

Not all of them should be required though, I agree with @trustedmercury about which should be required and which shouldn't

@456dev
Copy link
Contributor

456dev commented Feb 26, 2021

(some of) The information from plugin file should be able to be dynamically modified.
Say there is a plugin that takes the git URL of a plugin, fetches the head or whatever, and finds a list of contributors and dynamicly adds it to the end.
Also suggestion: multiple author support
Able to define authors: [] as a list or authors
If you define both, author should be used as a shortened version in space dependant places ? (The456gamer + 25 more)?

Some info should be read-only however, like the plugin name, to prevent issues

@456dev
Copy link
Contributor

456dev commented Feb 26, 2021

For the plugin.yml, a new identifyer called dist-info or something, a list of meta tags set by the distributor (say pymine official plugin repository might add a tag called category etc

Might be better as a sidecar like file as this would break signing (code modified by distributor)

Use:: the distributor might provide a custom plugin that manages its own plugins, including custom auto updates, in-game plugin management (live reload, install, uninstall)

  • Display plugins in custom format. Would actually make more sense as a "dB"entry
    Say pluginman installs plugin, attaches tag saying it was installed by it, and offline versions of information in its API.

@Iapetus-11
Copy link
Member

Each plugin developer distributing an extra plugin for auto updates sounds like a mess, especially since that code has to be ingrained deep into the plugin loading process. We actually had plugin auto updating as a separate plugin a while ago, but it turned out to be a mess that was easily cleaned up by just making it a core part of PyMine.

@456dev
Copy link
Contributor

456dev commented Feb 26, 2021

i was more thinking plugin distributor, like spigotmc.org
and it was as an optional compliment to the built in updater

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature, request, or thing Good First Issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants