diff --git a/readme.md b/readme.md index c9adb58..3dfdfde 100644 --- a/readme.md +++ b/readme.md @@ -8,6 +8,10 @@ If you do wish to use this data for your own purposes, i.e: to make a custom pla ```yaml required: [ version, songs ] +$defs: + GWRadioURI: + type: uri + description: 'A URI that points to the source file. See `GWMediaPlayer.fromURIToAbsolute()` for how to convert to a URL' properties: version: { type: integer } songs: @@ -17,9 +21,33 @@ properties: id: type: string tags: - description: 'A list of tags used for filtering. Entries are arbitrary, see latest songs list.' + description: 'A list of tags used for filtering.' type: array - items: [ { type: string } ] + items: + - const: sus + description: >- + Media information will render in the Among Us Font. + In imposter mode, only songs tagged with sus will be in shuffle + - const: niggers + description: >- + Media that was originally available through the now-defunct nigge.rs online radio. + Tagged items may contain the original _nigid and/or _nigkey as metadata + $seeAlso: + - '#/properties/songs/items/properties/metadata/properties/_nigid' + - '#/properties/songs/items/properties/metadata/properties/_nigkey' + - const: splash-song + description: >- + Media that can play on the Glowers Club splash page. + - const: misc + description: 'Media that does not significantly contain music.' + - const: moonman + description: 'Moonman songs' + - regex: '^radio\-media\-style\-[a-z\-]+' + description: 'Custom style information. i.e: to remove the album art box or disable background blur' + - type: string + description: >- + Tags may also be arbitrary + metadata: required: [ title, artist ] properties: @@ -30,10 +58,12 @@ properties: type: string format: url _nigid: - description: 'The original song id from nigge.rs. Do not use for nigge.rs detection, use the "niggers" tag instead' + $seeAlso: '#/properties/songs/items/properties/tags/items/1' + description: 'The original song id from nigge.rs.' type: string _nigkey: - description: 'Content of _id from the original nigge.rs song entry. Do not use for nigge.rs detection, use the "niggers" tag instead' + $seeAlso: '#/properties/songs/items/properties/tags/items/1' + description: 'Content of _id from the original nigge.rs song entry.' type: string sources: type: array @@ -41,9 +71,7 @@ properties: - required: [ type, url ] properties: type: { type: string, format: mimetype } - uri: - description: 'A URI that points to the source file. See `GWMediaPlayer.fromURIToAbsolute()` for how to convert to a URL' - type: string + uri: { "$ref": "#/$defs/GWRadioURI" } previews: description: >- This is an array so GWMediaPlayer can better display videos being played as audio only. @@ -54,7 +82,8 @@ properties: display_type: description: 'Used to determine how the media should be displayed. See GWMediaPlayer.EDisplayType' type: string - uri: { "$ref": "#/properties/songs/items/properties/sources/items/properties/uri" } + uri: { "$ref": "#/$defs/GWRadioURI" } type: { type: string, format: mimetype } size: { type: string } ``` +