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

Store metadata within app package (feature request) #541

Open
nopid opened this issue Jun 14, 2024 · 0 comments
Open

Store metadata within app package (feature request) #541

nopid opened this issue Jun 14, 2024 · 0 comments

Comments

@nopid
Copy link

nopid commented Jun 14, 2024

The Pyxel application file (.pyxapp) provides a convenient way to distribute and play Pyxel applications. In practice, it is a zip archive of the application files with a special file pointing to the startup script.

For a convenient way to archive and manage a collection of application files, I would suggest adding a metadata file inside the application file (maybe something like pyxapp.toml? toml seems to be quite popular among Python developers these days) to provide some metadata about the application. I was thinking about:

  • title
  • author
  • description
  • webpage/url
  • version
  • license
  • screenshot/gif animation provided in the pyxapp file itself
  • etc

Of course the authors are free to provide whatever metadata they see fit. The point of specifying the format is to ensure compatibility and promote usage. The pyxel web player could then also display this information along with the application when playing it.

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

1 participant