the3dfxdude / 7kaa

Seven Kingdoms: Ancient Adversaries - Go to the main source repository at https://sourceforge.net/projects/skfans/ for source code and builds
https://7kfans.com
Other
254 stars 72 forks source link

Added FreeDesktop.org shortcut and app store metadata #253

Closed Mailaender closed 1 year ago

Mailaender commented 2 years ago

Required for #183 and other Linux distribution packaging.

the3dfxdude commented 2 years ago

@lennyhans Please look at what would be proper integration for the desktop file into the Makefile that is not flatpak specific. I don't see a reason to merge in the flatpak app store meta data.

lennyhans commented 2 years ago

You mean generate the file?, it could be done, but I think that here the files are present to create a link between the flathub publication and the upstream package. It could be burdensome to maintain but there are pieces that can be glued to reduce the future work

Mailaender commented 2 years ago

That is a misunderstanding. https://freedesktop.org/software/appstream/docs/chap-Metadata.html is not just for Flatpak. The whole Unix infrastructure benefits because other Linux distribution app stores can read this file as well. As it is your project, you should have control over it.

Mailaender commented 2 years ago

The Open Age Rating might need an update as I mostly guessed it.

the3dfxdude commented 2 years ago

@lennyhans Yes, I am looking for integration ideas. It does not have to be generated on the fly. If we don't use it, then we should not provide them. So just thinking about what to do.

@Mailaender I was reading about how the meta data file is used. What you provided might be sufficient for what is used by flathub or where ever flatpaks are distributed. It might not be sufficient for others. I read that Debian aggregates the files for apt. And they attempt to upstream further modifications for Debian. This is quite telling the state of appstream data: https://appstream.debian.org/sid/main/index.html Ubuntu has different appstream results for the same(?) data. Also they seem to not actually need upstream to provide the files, and this is been true for a long time apparently.

I've long decided against providing unique files for packagers and their specific processes (especially if we don't use it), only to get each distro wanting to file change requests to the files to suit their purposes. Note rpm is a long time standard, but I noted differences between what distros did that warranted not even bothering. We aren't going to provide an app store or tweak the file for each variant of the standard. They can collect meta data and aggregate into their packaging system on their own. After reading what Debian wants for desktop or icon files, I don't want to start there either. Generating a file on the fly using Make might not be a bad idea, but since downstream managed on their own so far, I don't think we should start supporting them.

Mailaender commented 2 years ago

The metadata aggregation is different per distribution / packaging format. The source is the same. It also helps identify the software with a unique ID so GNOME Software or KDE Discover knows that the distribution package and the Flatpak are the same application just from different sources. Your argument that distributions might fight over it in your repository is not justified. The files are standardized and the ones I submitted passed the strict Flathub linter.

lennyhans commented 2 years ago

@Mailaender I think you're mostly correct, just mention that the application has never taken the "install-able" missing step, so provide a packaging relevant file (even if it is a standard and recommended way to describe an application) is unnecessary because packaging is not on the project scope.

@the3dfxdude I think that to take advantage of provide a .desktop file for linux distributions, a good approach could be to add an install step on the makefile, so it copies the data, the music and create the graphical application entry, that way the desktop file can be helpful and it is not tied to some external package manager or packaging system, what Mailaender did provided is (almost) the minimal standard that a desktop file can have to provide a useful graphical direct access to the application (if we go beyond, it can get translated to provide insightful description)

by the way thefreedesktop recommends add the metadata in some way to guide any appstream (even if it's not part of what the distribution that handles that package expect, they usually just apply their own patches)

tmr83 commented 2 years ago

Shouldn't "help" direct to the community tab of the website? I feel like I should web optimize the pdf if it won't be installed on people's systems.

Mailaender commented 2 years ago

First entry on https://www.7kfans.com/community.html is

Development Building From Source

which isn't all that useful if you already installed it pre-compiled.

tmr83 commented 2 years ago

It will have a lot of info in the future that will never make it into the manual tho, and I cannot guarantee the link will remain static or even if it is provided as a downloadable asset.

Mailaender commented 2 years ago

Please don't hesitate to replace it. After all, that is why this file should be maintained here.

tmr83 commented 1 year ago

@Mailaender For the Flathub package, can you install the pdf like the music? I'm wondering if that would be better. I'm hoping to integrate compiling the manual with autotools and make one of these days, so I'll be looking to install the pdf to a $DOC_DIR. Can the .desktop file also link to local documentation?

the3dfxdude commented 1 year ago

@tmr83 Let's push possible flatpak suggestions through lennyhans. The links in the flatpak should just be merged into a single "7kfans.com" because the landing page should have navigation needed rather than track individual pages. The doc still needs autotools integration, and I would like to do other things that would not have to need pushing changes into this meta data.

tmr83 commented 1 year ago

Okay. I'm just trying to be a little bit helpful. I actually don't use flatpaks. They just add to the problem they purport to solve.

Mailaender commented 1 year ago

For the Flathub package, can you install the pdf like the music?

The players won't be able to open the PDF unless you integrate a PDF viewer into the game. It is isolated in the sandbox.

Mailaender commented 1 year ago

Can the .desktop file also link to local documentation?

Please don't. These are reserved for applications.

Mailaender commented 1 year ago

I removed the link to the PDF now.

the3dfxdude commented 1 year ago

We will not add support for this in tree at this time. We have been using sourceforge for the main repository and release notification, so you might want to check on that. The github page may get archived.