Skip to content

.lrc style guide and submission voting system #79

@samyarvahid

Description

@samyarvahid

In terms of formatting generally, I think it would be a benefit to everyone to have clear guidelines that people can refer to on how to write .lrcs. I was looking earlier today on the site for documentation, but I only found the api spec. Only while reading through issues did I learn about the MXM guidelines being de facto LRCLIB guidelines too.

I'd be happy to contribute some time to make a simple writeup detailing the expected format for LRCLIB .lrcs, but I think we should also take the time to discuss how strictly we want to adhere to MXM spec, if there are alternatives, etc. This not to mention other formats like elrc. Furthermore, there has been discussion of romanization #39, where MXM tells us to stick to the original script. However, there is no mention of stuff like furigana, which someone in that issue thread mentioned. Personally, I think furigana is unnecessary, but MXM offers no guidance on it. One potential solution is a fallback rendering of HTML Ruby text, where the ruby text is put into parenthesis next to the base text:

WWW (World Wide Web)

Generally, I would say furigana generates too much clutter in a plain text lyric file, no matter the implementation, and it's best to save it for the software that actually renders the lyrics with some postprocessing with linguistic Part-of-Speech analysers like mecab, that can disambiguate the characters in question. Plus, beyond writing in native script, adding parenthetical non-content goes against MXM guidelines anyway.

The last thing I'll say about style is that I think the topic warrants some discussion from the LRCLIB community before we write our own style guide.

On to my second point, I think we are starting to see that as this project grows in reach, there are more cases of low-quality submissions with no real way for the community to self-correct, and more broadly no resources on how to format correctly. I think a possible approach to pursue long-term for a robust and healthy database would be a voting system, perhaps tied to an account, a la musicbrainz, etc. This would be a significant investment in development time and project scope that I can understand being undesired and impossible for just the project maintainer alone.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions