(create documentation for song template) |
mNo edit summary |
||
(26 intermediate revisions by 2 users not shown) | |||
Line 1:
{{Documentation subpage}}
{{Lua|Module:Infobox song}} {{Cargo|songs}}
== Parameters ==
<templatedata>
{
"params": {
"bg color": {
"example": "#000000",
"type": "string",
"label": "Background color",
"default": "#000000",
"description": "The background color of the headers. Overrides the colors associated with units if specified."
},
"text color": {
"label": "Text color",
"example": "#FFFFFF",
"type": "string",
"default": "#FFFFFF",
"description": "The text color of the text inside headers. Overrides text colors associated with units if specified."
},
"romaji": {
"label": "Romaji",
"suggested": true,
"example": "Miku Miku ni Shite Ageru♪ (Shite Yan yo) ",
"type": "string",
"description": "The romanized version of the Japanese song title."
},
"english": {
"label": "English",
"suggested": true,
"example": "I'll Miku-Miku You♪ (For Reals) ",
"type": "string",
"description": "The official English song title."
},
"bpm": {
"label": "BPM",
"type": "number",
"suggested": true,
"description": "The BPM of the song. Use https://twitter.com/MaengZombie/status/1384862015156482052 as reference.",
"example": "160"
},
"duration": {
"label": "Duration",
"type": "number",
"suggested": true,
"description": "The length of the full song.",
"example": "308"
},
"easy difficulty": {
"label": "Easy difficulty",
"type": "number",
"example": "7",
"description": "The difficulty of the easy chart.",
"required": true
},
"normal difficulty": {
"label": "Normal difficulty",
"type": "number",
"example": "12",
"description": "The difficulty of the normal chart.",
"required": true
},
"hard difficulty": {
"label": "Hard difficulty",
"type": "number",
"example": "17",
"description": "The difficulty of the hard chart.",
"required": true
},
"expert difficulty": {
"label": "Expert difficulty",
"type": "number",
"example": "24",
"description": "The difficulty of the expert chart.",
"required": true
},
"master difficulty": {
"label": "Master difficulty",
"type": "number",
"example": "28",
"description": "The difficulty of the master chart.",
"required": true
},
"easy notes": {
"label": "Easy notes",
"example": "139",
"description": "The number of notes in the easy chart.",
"type": "number",
"required": true
},
"normal notes": {
"label": "Normal notes",
"example": "339",
"description": "The number of notes in the normal chart.",
"type": "number",
"required": true
},
"hard notes": {
"label": "Hard notes",
"type": "number",
"example": "439",
"description": "The number of notes in the hard chart.",
"required": true
},
"expert notes": {
"label": "Expert notes",
"example": "739",
"type": "number",
"description": "The number of notes in the expert chart.",
"required": true
},
"master notes": {
"label": "Master notes",
"example": "939",
"type": "number",
"description": "The number of notes in the master chart.",
"required": true
},
"japanese": {
"label": "Japanese",
"description": "The official Japanese song title.",
"example": "みくみくにしてあげる♪【してやんよ】 ",
"type": "string",
"suggested": true
},
"song id": {
"label": "Song ID",
"description": "The internal ID of the song.",
"example": "124",
"type": "number",
"required": true
},
"date": {
"label": "Release Date",
"description": "The date that the song was released in game. Use format YYYY/MM/DD",
"example": "2021/03/09",
"type": "date",
"required": true
},
"3d mv": {
"label": "3D MV",
"description": "Whether or not the song has a 3D MV. Use \"yes\" or \"no\".",
"type": "boolean",
"example": "No",
"required": true
},
"2d mv": {
"description": "Whether or not the song has a 2D MV. Use \"yes\" or \"no\".",
"type": "boolean",
"label": "2D MV",
"example": "No",
"required": true
},
"original mv": {
"label": "Original MV",
"type": "boolean",
"description": "Whether or not the song has an original MV. Use \"yes\" or \"no\".",
"example": "No",
"required": true
},
"song name": {
"label": "Song name",
"description": "The song name. Defaults to the page title if none given.",
"example": "Miku Miku ni Shite Ageru ♪ 【Shiteyanyo】",
"type": "string",
"required": true
},
"jacket": {
"label": "Jacket",
"description": "The jacket for the song.",
"example": "Jacket001.png",
"type": "string",
"default": "Dummyalbumart.png",
"suggested": true
},
"jacket alt": {
"label": "Jacket (alt)",
"description": "Alternative jacket for the song",
"example": "Jacket001 (alt).png",
"type": "string"
},
"jacket alt 2": {
"label": "Jacket (alt 2)",
"description": "Alternative jacket for the song",
"type": "string"
},
"type": {
"label": "Song type",
"description": "The type of song. Can be one of \"Pre-existing\", \"Commissioned\", or \"Contest winner\".",
"example": "no",
"type": "string",
"suggested": true
},
"game duration": {
"label": "Duration (game-size)",
"description": "The length of the song in game. Does not include beginning silence.",
"example": "101",
"type": "number",
"required": true
},
"singers": {
"label": "Original singer(s)",
"description": "The original singer(s) of the song, separated by commas.",
"example": "Hatsune MIku",
"type": "string",
"suggested": true
},
"producers": {
"label": "Producer(s)",
"description": "The producer(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"required": true
},
"composers": {
"label": "Composer(s)",
"description": "The composer(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"suggested": true
},
"arrangers": {
"label": "Arranger(s)",
"description": "The arranger(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"suggested": true
},
"lyricists": {
"label": "Lyricist(s)",
"description": "The lyricist(s) of the song, separated by commas.",
"example": "ika",
"type": "string",
"suggested": true
},
"units": {
"label": "Unit categories",
"description": "The category that this song belongs to. Options are \"VIRTUAL SINGER\", \"Leo/need\", \"MORE MORE JUMP!\", \"Vivid BAD SQUAD\", \"Wonderlands×Showtime\", \"25-ji, Nightcord de.\", and \"Other\"",
"example": "VIRTUAL SINGER",
"type": "string",
"suggested": true
},
"unlock": {
"label": "Unlock method",
"description": "The way this song is unlocked. Is one of the options: \"Automatically unlocked\", \"Music Shop\", \"Present Box\", or \"Main Story\"",
"type": "string",
"required": true
}
},
"paramOrder": [
"bg color",
"text color",
"song id",
"song name",
"jacket",
"jacket alt",
"jacket alt 2",
"japanese",
"romaji",
"english",
"singers",
"producers",
"duration",
"composers",
"arrangers",
"lyricists",
"units",
"unlock",
"type",
"bpm",
"game duration",
"3d mv",
"2d mv",
"original mv",
"date",
"easy difficulty",
"normal difficulty",
"hard difficulty",
"expert difficulty",
"master difficulty",
"easy notes",
"normal notes",
"hard notes",
"expert notes",
"master notes"
],
"description": "Infobox song for displaying song information.",
"format": "block"
}
</templatedata>
==
<pre>
{{Infobox song
| song id =
| song name =
| jacket =
| jacket alt =
| jacket alt 2 =
| japanese =
| romaji =
| english =
| singers =
| producers =
| duration =
| units =
| unlock =
| arrangers =
| composers =
| lyricists =
| type =
| bpm =
| game duration =
| date =
| 3d mv =
| 2d mv =
| original mv =
| easy difficulty =
| normal difficulty =
| hard difficulty =
| expert difficulty =
| master difficulty =
| easy notes =
| normal notes =
| hard notes =
| expert notes =
| master notes =
}}
</pre>
==
{{Infobox song
| song id = 1
| song name = Tell Your World
| jacket = Jacket001.png
| singers = Hatsune Miku
| producers = kz (livetune)
| duration = 257
| arrangers = kz (livetune)
| composers = kz (livetune)
| lyricists = kz (livetune)
| units = VIRTUAL SINGER
| unlock = Automatically unlocked
| type = Pre-existing
| bpm = 150
| game duration = 123
| date = 2020/09/30
| 3d mv = Yes
| 2d mv = No
| original mv = No
| easy difficulty = 5
| normal difficulty = 10
| hard difficulty = 16
| expert difficulty = 22
| master difficulty = 26
| easy notes = 220
| normal notes = 492
| hard notes = 719
| expert notes = 961
| master notes = 1147
}}
<pre>
{{Infobox song
| song id = 1
| song name = Tell Your World
| jacket = Jacket001.png
| singers = Hatsune Miku
| producers = kz (livetune)
| duration = 257
| arrangers = kz (livetune)
| composers = kz (livetune)
| lyricists = kz (livetune)
| units = VIRTUAL SINGER
| unlock = Automatically unlocked
| type = Pre-existing
| bpm = 150
| game duration = 123
| date = 2020/09/30
| 3d mv = Yes
| 2d mv = No
| original mv = No
| easy difficulty = 5
| normal difficulty = 10
| hard difficulty = 16
| expert difficulty = 22
| master difficulty = 26
| easy notes = 220
| normal notes = 492
| hard notes = 719
| expert notes = 961
| master notes = 1147
}}
</pre>
{{clear}}
{{Infobox song
|bg color = #FFFFA8
|text color = #000000
|song name = Sweet Magic
|japanese = スイートマジック
|romaji = Sweet Magic
|english = Sweet Magic
|producer = Junky
|units = Wonderlands×Showtime
|bpm = 123
|game duration = 149
|3d mv = Yes
}}
<pre>
{{Infobox
|bg color
|text color = #000000
|song
|japanese = スイートマジック
|romaji = Sweet Magic
|
|
|units = Wonderlands×Showtime
|
|game duration = 149
|3d mv = Yes
}}
</pre>
<includeonly>[[Category:Infobox templates]]</includeonly>
|
Latest revision as of 22:41, 28 April 2023
This is a documentation subpage for Template:Infobox song. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template uses the following Cargo tables: |
Parameters[edit source]
Infobox song for displaying song information.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Background color | bg color | The background color of the headers. Overrides the colors associated with units if specified.
| String | optional |
Text color | text color | The text color of the text inside headers. Overrides text colors associated with units if specified.
| String | optional |
Song ID | song id | The internal ID of the song.
| Number | required |
Song name | song name | The song name. Defaults to the page title if none given.
| String | required |
Jacket | jacket | The jacket for the song.
| String | suggested |
Jacket (alt) | jacket alt | Alternative jacket for the song
| String | optional |
Jacket (alt 2) | jacket alt 2 | Alternative jacket for the song | String | optional |
Japanese | japanese | The official Japanese song title.
| String | suggested |
Romaji | romaji | The romanized version of the Japanese song title.
| String | suggested |
English | english | The official English song title.
| String | suggested |
Original singer(s) | singers | The original singer(s) of the song, separated by commas.
| String | suggested |
Producer(s) | producers | The producer(s) of the song, separated by commas.
| String | required |
Duration | duration | The length of the full song.
| Number | suggested |
Composer(s) | composers | The composer(s) of the song, separated by commas.
| String | suggested |
Arranger(s) | arrangers | The arranger(s) of the song, separated by commas.
| String | suggested |
Lyricist(s) | lyricists | The lyricist(s) of the song, separated by commas.
| String | suggested |
Unit categories | units | The category that this song belongs to. Options are "VIRTUAL SINGER", "Leo/need", "MORE MORE JUMP!", "Vivid BAD SQUAD", "Wonderlands×Showtime", "25-ji, Nightcord de.", and "Other"
| String | suggested |
Unlock method | unlock | The way this song is unlocked. Is one of the options: "Automatically unlocked", "Music Shop", "Present Box", or "Main Story" | String | required |
Song type | type | The type of song. Can be one of "Pre-existing", "Commissioned", or "Contest winner".
| String | suggested |
BPM | bpm | The BPM of the song. Use https://twitter.com/MaengZombie/status/1384862015156482052 as reference.
| Number | suggested |
Duration (game-size) | game duration | The length of the song in game. Does not include beginning silence.
| Number | required |
3D MV | 3d mv | Whether or not the song has a 3D MV. Use "yes" or "no".
| Boolean | required |
2D MV | 2d mv | Whether or not the song has a 2D MV. Use "yes" or "no".
| Boolean | required |
Original MV | original mv | Whether or not the song has an original MV. Use "yes" or "no".
| Boolean | required |
Release Date | date | The date that the song was released in game. Use format YYYY/MM/DD
| Date | required |
Easy difficulty | easy difficulty | The difficulty of the easy chart.
| Number | required |
Normal difficulty | normal difficulty | The difficulty of the normal chart.
| Number | required |
Hard difficulty | hard difficulty | The difficulty of the hard chart.
| Number | required |
Expert difficulty | expert difficulty | The difficulty of the expert chart.
| Number | required |
Master difficulty | master difficulty | The difficulty of the master chart.
| Number | required |
Easy notes | easy notes | The number of notes in the easy chart.
| Number | required |
Normal notes | normal notes | The number of notes in the normal chart.
| Number | required |
Hard notes | hard notes | The number of notes in the hard chart.
| Number | required |
Expert notes | expert notes | The number of notes in the expert chart.
| Number | required |
Master notes | master notes | The number of notes in the master chart.
| Number | required |
Quick copy[edit source]
{{Infobox song | song id = | song name = | jacket = | jacket alt = | jacket alt 2 = | japanese = | romaji = | english = | singers = | producers = | duration = | units = | unlock = | arrangers = | composers = | lyricists = | type = | bpm = | game duration = | date = | 3d mv = | 2d mv = | original mv = | easy difficulty = | normal difficulty = | hard difficulty = | expert difficulty = | master difficulty = | easy notes = | normal notes = | hard notes = | expert notes = | master notes = }}
Examples[edit source]
{{Infobox song | song id = 1 | song name = Tell Your World | jacket = Jacket001.png | singers = Hatsune Miku | producers = kz (livetune) | duration = 257 | arrangers = kz (livetune) | composers = kz (livetune) | lyricists = kz (livetune) | units = VIRTUAL SINGER | unlock = Automatically unlocked | type = Pre-existing | bpm = 150 | game duration = 123 | date = 2020/09/30 | 3d mv = Yes | 2d mv = No | original mv = No | easy difficulty = 5 | normal difficulty = 10 | hard difficulty = 16 | expert difficulty = 22 | master difficulty = 26 | easy notes = 220 | normal notes = 492 | hard notes = 719 | expert notes = 961 | master notes = 1147 }}
Sweet Magic | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Japanese | スイートマジック | ||||||||||||||||||||||||||||
Romaji | Sweet Magic | ||||||||||||||||||||||||||||
English | Sweet Magic | ||||||||||||||||||||||||||||
Song Information | |||||||||||||||||||||||||||||
Producers | ? (edit) | ||||||||||||||||||||||||||||
In-game Information | |||||||||||||||||||||||||||||
Song ID | ? (edit) | ||||||||||||||||||||||||||||
Unit category |
| ||||||||||||||||||||||||||||
How to unlock | ? (edit) | ||||||||||||||||||||||||||||
Type | ? (edit) | ||||||||||||||||||||||||||||
BPM | 123 | ||||||||||||||||||||||||||||
Duration (game) | 2:29 | ||||||||||||||||||||||||||||
Release date | ? (edit) | ||||||||||||||||||||||||||||
Music Video | |||||||||||||||||||||||||||||
3D | 2D | Original | |||||||||||||||||||||||||||
✓ | ? (edit) | ? (edit) | |||||||||||||||||||||||||||
Difficulties | |||||||||||||||||||||||||||||
Easy | Normal | Hard | |||||||||||||||||||||||||||
? (edit) | ? (edit) | ? (edit) | |||||||||||||||||||||||||||
Expert | Master | Append | |||||||||||||||||||||||||||
? (edit) | ? (edit) | N/A | |||||||||||||||||||||||||||
Notes | |||||||||||||||||||||||||||||
Easy | Normal | Hard | |||||||||||||||||||||||||||
? (edit) | ? (edit) | ? (edit) | |||||||||||||||||||||||||||
Expert | Master | Append | |||||||||||||||||||||||||||
? (edit) | ? (edit) | N/A | |||||||||||||||||||||||||||
{{Infobox song |bg color = #FFFFA8 |text color = #000000 |song name = Sweet Magic |japanese = スイートマジック |romaji = Sweet Magic |english = Sweet Magic |producer = Junky |units = Wonderlands×Showtime |bpm = 123 |game duration = 149 |3d mv = Yes }}