-
-
Notifications
You must be signed in to change notification settings - Fork 468
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
.music files should have an "author" entry. #2617
Comments
In my opinion, this attribution should show up when hovering over |
I'm not sure. |
While im not sure if it should be in the file itself there should at least be a spot in the credits for all the music and who made it.
If it can be pulled off i think it would be cool. |
Should they have to only note that? If necessary, they could provide more details about the music file. |
True. |
This field will be later used to display the author of music files in the level editor.
I started work on this issue in the branch 2617-music-author of my fork. |
This field will be later used to display the author of music files in the level editor.
This field will be later used to display the author of music files in the level editor.
Personally, I like how this first design looks. Only thing I'm not sure is needed is the music filename being listed in the description, despite it already being used for the menu item text. |
I also felt that repeating the music filename at the bottom could be extraneous, but there is one reason why we may want it there. With the music filename at the bottom, the user can keep their eyes focused only at the help text at the bottom as they navigate the menu with the up and down arrow keys. Without the filename there, the user may have to move their eyes back and forth between the middle and bottom of the screen more often. Also, there is also a case where only "by AUTHOR" appears in the text, which may be a bit too terse and confusing without the added context of the music filename. The music filename does look a bit weird on its own line. If we keep it, I will add emphasis (use blue font or some other method) so it looks like the subject of the help box. |
Was thinking that, because usually, help texts are used to add additional information, which extends what the menu item text says. Kind of like a title and a description. |
This field will be later used to display the author of music files in the level editor.
I tried a UI design where the filename was emphasized using a big font and activetextcolor (blue stroke). But I see your point @Vankata453, it may be better to be more consistent with the rest of the app by not repeating the menu item text. I think I'll take your suggestion @Vankata453, and remove the music filename headline from the hover help text. In the case where a song has no title (or unknown title) but does have a known author, we can display the base filename in place of the song title like this example: "jewels by Test Author" Here is the UI design I tested today: When the song has no title, but does have an author: |
Sounds good to me! |
Thanks @Vankata453! That should settle all the UI requirements (so no filename headline in the hover text). Now I will start the real implementation of this. I anticipate reporting back with a pull request sometime next week. |
Great work man 💪 |
Take this song title as an example:
It contains:
It's better to not fully rely on filenames to provide an accurate song title. Yes, they could closely represent it, if the exact name has forbidden characters, but to provide an accurate song title in all cases, an additional string in the Additionally, the point @tylerandari13 brought up about level compatibility in relation to main game music is fair and shows that renaming the current main game music files is not worth it. |
This to me just seems like excuses and being complicit with a lazy file naming system :/ EDIT: there is also a degree in "so what" about point 2 - a lot of older levels are heavily broken anyway, like ones from decade old addons or whatever. a few even have missing music anyway! and by my estimates its easy to fix once we change. |
i think your suggestion will make it quite unintuitive for the devs and the end user. It's defined once, it's defined forever, all of this just so you don't have to open the file? |
As accurate as possible, yes. But not exact in all cases, that's why levels have display names, saved in the file.
A lot of older maps are likely to never be updated to the new naming, which means a good portion of levels will not have music, unless they are edited by the player one by one.
This change also breaks levels as recent as 0.6.3/Nightlies. Also, why should we break them further, instead of try to not cause such issues?
I wouldn't really care about a music/sounds naming system change, if it wasn't for the drawbacks listed above. |
Its not unintuitive to call a file name for a song called "evil penguin march" as "evil_penguin_march.ogg" And its not about opening one file, if you don't know that "evil penguin march" corresponds to "arctic 2.ogg" or some random shit like that, you have to open multiple to sift through and eventually find it. THAT is more unintuitive. |
I agree with your point of as accurate as possible music filenames, but only if that wouldn't cause major drawbacks with existing levels. All new music should definitely follow this naming though, in my opinion. |
I'm not convinced by "major drawbacks". I think you're having a bit of PTSD from the tileset PR haha. I genuinely think its not that trivial to fix should this change occur... but for the map maker that is. If you're fixing a map that isnt yours... Perhaps you may miss a line of code. But you could also have a checklist of songs to crtl+F in the txt version of the level... wouldnt be hard to replace. Again, would take like 30 minutes (~25ish level map). For a map like TCC (47) which is bigger, maybe an hour. |
Read what Vankata said here. |
Honestly i just don't think it's worth the effort, to have every single level have to be slightly changed for the sake of organization and stuff. Like yes; it's not that hard to fix, but every single level and worldmap would have to be changed. And it's not even improving stuff that much. |
My main thought on this was that no matter how many levels have their music fixed, there will still be a lot left that will not have any music and just feel very empty (you know, levels with no music are half the fun) 😅. This could be avoided if we preserve the file naming, and instead use the |
My intention for the title field is to display the artist's original song title in the hover help text for music in the level editor file browser. This way, we attribute the song to the original work by title and author, so a user can find the original source of the music. I think that a discussion about renaming the music files as @Alasdairbugs proposed can happen in a new issue after this issue gets PR approved, merged and complete. That new issue can take advantage of the title field that I added to the music files (for most files, where I could find it). As we discussed, this renaming would have the advantage of being simpler (only one name for songs, not two, a filename and a song title), but also the disadvantage of migrating all references (levels) to the new file naming scheme and some cases where the SuperTux filename was easier for users to remember than the title field name, such as the song titled "Riding the Wind" with the filename "forest3.ogg" (the later shows that it is used in forest levels). |
Author of salcon.ogg is DJ Gentoo, based on the original by Mystical (aka Asbjorn Andersen). cave_old and fortress_old are mine (same license as the others). |
Thanks @wansti for the data and all your music! It's added to the PR now. The remaining list of missing music fields is:
I'm not blocked by this missing data, but adding it where we find it is great. |
This field will be later used to display the author of music files in the level editor.
This field will be later used to display the author of music files in the level editor.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
My pull request #2674 is ready for review! This pull request also includes a separate commit that fixes the display of long help texts (>4 lines) that occur for song music files. This commit changes the alignment of the menu item help text display to anchor at the bottom of the screen, preventing the help text from growing past the bottom of the screen. |
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.
Presently, the identity of the composer behind the game's soundtrack might pose as an enigma. Simplifying matters, it would be highly convenient to incorporate an author designation. This could take the form of something like:
(supertux-music
(file "forest-cave.ogg")
(author "Marek Moeckel")
(loop-begin 0)
(loop-at 149)
)
The text was updated successfully, but these errors were encountered: