Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.3 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.3 KB

lyrics.chrissx.de

Let's face it: Sites for viewing lyrics are kinda crappy. Let's fix it!

You can license the code (src/*) under the terms of the GPLv2. The lyrics file (albums.yaml) is copyrighted and not licensed to you.

albums.yaml

This file contains all the lyrics in Genius format. As the extension implies, it is written in a YAML-based format. That will be detailed here to aid both with editing it and making tools that consume it.

The root is a [album].

album

  • name: string
  • upc?: number (missing if it has not been released commercially)
  • artists: [string]
  • release: string
  • cover?: string (missing if it has not been released commercially)
  • link?: string (missing if it has not been released commercially)
  • tracks: [track]

track

  • name: string
  • isrc?: string (missing if it has not been released commercially)
  • length: number | string
  • lyrics?: string (missing if it doesn't have lyrics or they haven't been transcribed)
  • artists?: [string] (missing if it has the same as the album)

lyrics

The actual lyrics are formatted very similar to Genius's, a more detailed guide is to be written.