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

Support for VERSION tag #961

Open
1 task
Baklap4 opened this issue Dec 13, 2023 · 0 comments
Open
1 task

Support for VERSION tag #961

Baklap4 opened this issue Dec 13, 2023 · 0 comments

Comments

@Baklap4
Copy link
Member

Baklap4 commented Dec 13, 2023

Suggestion

Within the Ultrastar community we've decided upon a common format. This can be found on our website.
One of the new tags introduced for compatibility reasons is the #VERSION tag.

We can use this tag to determine which features we want to use as dictated by the source.

As seen on the website:

The version attribute helps the game and apps to understand how uptodate a song file is and how it should be treated. Ideally all txt files will be upgraded to the latest version. The value are version numbers according to semantic versioning. Song Editors, Managing tools or txt-hostings should set this automatically.

Todo

Use case

  • Gradually introduce new features which come in new format versions
  • Have a standard way to determine what features to enable for the specific txt in question instead of best effort

Extra info/examples/attachments

Our versions will start with this structure
0.1.0 -> Bare Minimum, Minimum vial product (mvp)
0.2.0 -> Introduce the tags we currently have
0.3.0 -> Deprecate old # tags we don't wanna use (duplicates, technical not nessecary)
1.0.0 -> Removal of deprecated tags and final list of currently used tags (2023)
1.1.0 -> First new features we want to introduce, deprecated #mp3 and chaotic time units (2023)
~1.2.0 -> more new features (2024)
2.0.0 -> Removal of #MP3 and introduce unified time units (=doing breaking changes) (2025)

also linking the vocaluxe issue: Vocaluxe/Vocaluxe#628 just for reference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant