[Spec] List the NoteTypes

[Baklap4]

As the format has been out there for quite some time we've kinda settled on some NoteTypes to use. Let's try to come up with a definitive list of all the NoteTypes (Normal, Golden, Rap, Freestyle, Break, etc) out there This way we can go through them one by one and eventually attach them to a versioning strategy.

To help...

@rakuri255 already created a great overview of tags and note types. Linked repository: https://github.com/rakuri255/Ultrastar_txt_documentation

Todo

• [x] List all the NoteTypes
• [x] Describe the function of the NoteType
• [ ] Optional: Describe where the NoteType came from.

Out of scope

• Adding a version to each NoteType

[Baklap4]

@bohning and @rakuri255 did a great inventarisation already. I'm currently wondering how to add this to the repository in a way that's easy to maintain and build upon

For now here's a little screencap:

[rakuri255]

Should we include the software version number of the product? The games could all get an update and support something new. Or someone wants to use an old version.

[Baklap4]

That'd make for a 3d spreadsheet.. would be nice, but is harder to project to the enduser in an easy overview on our website Any idea to tackle that @rakuri255 ?

I do like the idea to include the software version as it shows exactly what is and what is not supported which is a great piece of info

[marwin89]

Maybe something like this??

@rakuri255 , @Baklap4 if you ask me, basically its a good idea to include software versions, however its a lot work... usdx for instance has 5 releases in 2023 so far and melody mania more than 5 updates (updates automatically via steam).

What do you think... Maybe we only list the two lastest versions? Maybe its good to have strong limits?

[rakuri255]

@marwin89 We should keep it as simple as possible and show a maximum of 2 versions. I would say we version only the status change. If V1.0 is red and the newer versions are still red, then we just leave V1.0 or update to the new version by demand. But do not show the old versions. It is to be expected that the old versions are also red. Or write <V3.0.

If V4.0 changes to green, then we show the latest version which has been red and then update on demand always the green one. It is to be expected with green that all new versions continue to function. e.g. <V3.0 red and >V4.0 green.

So you save the update effort.

[rakuri255]

@marwin89 We need also a comment section for special cases. e.g. Vocaluxe supports Rap notes but only displays it as freestyle.

[marwin89]

@marwin89 We need also a comment section for special cases. e.g. Vocaluxe supports Rap notes but only displays it as freestyle.

definitely - we need a comment section, I'm thinking about how to best display tables in on the website (incl. mobile view). Tables don't respond to the width if there are many columns. oh but now I see there seems to be a class in bootstrap 3... for responsive tables..

[marwin89]

@rakuri255 , we just talked in discord with nianna and asgard about versions. We agreed together on: the easiest solution is to write the lowest version that supports a particular tag like

>=v.3.1.0

[Baklap4]

Through the help of git we can identify the lowest version if support for a tag is deleted/deprecated it needs to be mentioned in maybe a comment section @rakuri255 already mentioned :)

[rakuri255]

Sure. Sounds good!

[marwin89]

According to the meta-tag & note-tag spreadsheet

This task seems to be done ✅ 🎈 please re-open if needed.