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

Package description #23

Closed
Wuzzy2 opened this issue Feb 27, 2021 · 3 comments · Fixed by #24
Closed

Package description #23

Wuzzy2 opened this issue Feb 27, 2021 · 3 comments · Fixed by #24

Comments

@Wuzzy2
Copy link
Contributor

@Wuzzy2 Wuzzy2 commented Feb 27, 2021

I think the package description is still a bit too long.
When I look in the game settings dialog, OpenSFX stands out for having a long description compared to OpenGFX and OpenMSX.

This is mainly because 3 license names are written out in full. I thought this is OK for consistency with OpenGFX and OpenMSX, which do the same thing. But it's a mouthful nonetheless. The current description:

OpenSFX sound replacement set for OpenTTD. Freely available under the terms of these licenses: Creative Commons Attribution-ShareAlike 3.0 Unported, GNU General Public License version 2 (or later) and Common Development and Distribution License 1.1. For full credits see "readme.txt". [VERSION]

Any idea what to do?

Here are possible ideas:

  • Shorten all license names to the common abbreviation. The full license name is given in the license file anyway
  • Drop the mention of licensing in the package description altogether. Again, we have the license file for that
  • Decide that the long OpenSFX description is not that big of a deal, and ignore it

Whatever is done to shorten the description in OpenSFX, it should also be done to OpenGFX and OpenMSX as well, simply because of consistency.

I think the 1st option is the better one since one could fully automatically replace the full license names with the abbreviations in all languages. Since the license names should be exactly the same in all language files, this might actually work.

The 2nd option has the major downside that we would have to reset all translations (again). Not an issue for OpenSFX now (the translations were just reset), but an issue for OpenGFX and OpenMSX. On the other hand, once the license info is removed from the description, we will never have to touch the description again in the unlikely even of yet another license change.

The 3rd option is certainly possible because the description is not seriously overlong, just a bit unusual. The game GUI does not break because of this.

@Wuzzy2
Copy link
Contributor Author

@Wuzzy2 Wuzzy2 commented Mar 1, 2021

Suggested descriptions:

  1. Shorten license names:

OpenSFX sound replacement set for OpenTTD. Freely available under the terms of these licenses: CC BY-SA 3.0, GPLv2 (or later) and CDDL 1.1. For credits see "readme.txt". [VERSION]

  1. Remove license names:

OpenSFX sound replacement set for OpenTTD. For licensing and credits see "readme.txt". [VERSION]

  1. Don't change anything:

OpenSFX sound replacement set for OpenTTD. Freely available under the terms of these licenses: Creative Commons Attribution-ShareAlike 3.0 Unported, GNU General Public License version 2 (or later) and Common Development and Distribution License 1.1. For full credits see "readme.txt". [VERSION]

@orudge
Copy link
Contributor

@orudge orudge commented Mar 1, 2021

Option 1 seems fine to me. I think you've probably still got room for "For full credits".

@Wuzzy2
Copy link
Contributor Author

@Wuzzy2 Wuzzy2 commented Mar 2, 2021

Note that all 3 descriptions have enough room. It's just that the current OpenSFX description is unusually long compared to OpenGFX and OpenMSX. So it's more about style than anything else.

@orudge orudge closed this as completed in #24 Mar 2, 2021
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

Successfully merging a pull request may close this issue.

2 participants