f2e-spec icon indicating copy to clipboard operation
f2e-spec copied to clipboard

Feature/commenttag

Open Baklap4 opened this issue 1 year ago • 5 comments

What does this PR do?

Trying to introduce new (hopefully) standardized fields. This helps in distinguishing where the mapped file came from and which program made it at which version. Aside from this #COMMENT is sometimes used which is now also supported

Closes Issue(s)

None

Motivation

I'm trying to get a couple new standardized fields into the ultrastar format. This allows hosting websites to add their name to song files whilst creator tools like composer add their specific version and appname.

This way everyone knows where the txt came from and which program is used to create it.

Since the varying sources of which you can download songs from differ in quality this is a nicely added bonus to see where it came from.

Might be a niche for just me, but if everyone opts in it'd make for a way better system and maybe even a newly introduced system which combines all the sources out there.... (that's my endgoal)

Testing

You can test this by adding the following tags:

#SOURCE:USDB
#APP:Composer
#APPVERSION:1.0.0
#COMMENT:Some comment

All tags are opt in. But if everyone plays by the rules every txt will have these fields eventually

The tags are shown within the webserver-ui: Playlist and search screen. All extra tags are seperated by the | symbol. And the popup if you click a song also mentions the tags + content if they're there.

Meanwhile...

Meanwhile i'm trying to convince other karaoke creators and downloadable websites to implement this for every song txt they have. But currently everyone is against it....

Baklap4 avatar Jun 12 '23 12:06 Baklap4

Still a draft since i haven't tested it yet

Baklap4 avatar Jun 12 '23 12:06 Baklap4

Undrafted this. Ready for review :) Also updated the Original post

Baklap4 avatar Jul 03 '23 19:07 Baklap4

Waiting for finalizing: https://github.com/UltraStar-Deluxe/format/issues/35

Baklap4 avatar Oct 05 '23 18:10 Baklap4

The gods have decided. A new tag is introduced to credit hosting website. The key is: #PROVIDEDBY

See: https://github.com/UltraStar-Deluxe/format/issues/35#issuecomment-1819221345

Will fix this in a next commit

Baklap4 avatar Nov 20 '23 21:11 Baklap4

Was replaced by https://github.com/performous/performous/pull/975 since github didn't let me refresh this PR.... kind of weird...

Baklap4 avatar Mar 01 '24 15:03 Baklap4