Template:Video game series reviews/sandbox/doc

This is a documentation subpage for Template:Video game series reviews/sandbox.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Video game series reviews (sandbox)

{{Video game series reviews}} is a template which presents review aggregator review scores for multiple video game articles in a series. It supports a series' reception section.

Things to remember:

This template is not required.
This template supplements the reception section; it does not replace it.
Famitsu score is only for Japanese series.
This template makes use of Wikidata to supplement missing or omitted fields.

Guidelines

{{Video game series reviews}} is not required: This template acts as a quick snapshot of aggregator scores for games in a series. Reception sections should consider using additional reviews for each game.
All reviews must be referenced: Proper citation from each review must be populated.
GameRankings should be omitted unless it adds value on top of Metacritic.: If included, GameRankings scores should be rounded to the nearest whole number.; See WP:VGAGG for more detail.
Famitsu should be omitted unless this is a Japanese series.: Famitsu is used for Japanese series that may have not seen an English release, and therefore lack Metacritic or GameRanking scores.

Usage

All of the following fields are optional:

title*: Can be used to provide a custom title for the table; otherwise, it will chose a default based on the fields in use.
updated*: Used to denote the last time scores and citations were updated.
sales*: Determines whether or not to display the sales column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. Sales data is not populated from Wikidata.
fam*: Determines whether or not to display the Famitsu column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. Famitsu reviews are pulled from Wikidata if unspecified.
gr*: Determines whether or not to display the GameRankings column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. GameRankings will be pulled from Wikidata if this is set to yes. Otherwise, Wikidata will not be used. See WP:VGAGG for further information.
mc*: Determines whether or not to display the MetaCritic column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. MetaCritic reviews are pulled from Wikidata if unspecified.
sales_title*: Can be used to provide a custom title for the sales column; otherwise, the default will be used.
fam_title*: Can be used to provide a custom title for the Famitsu column; otherwise, the default will be used.
gr_title*: Can be used to provide a custom title for the GameRankings column; otherwise, the default will be used.
mc_title*: Can be used to provide a custom title for the MetaCritic column; otherwise, the default will be used.
seriesQid*: Used to specify the Wikidata QID for this series. This should be omitted except in rare cases such as testing or displaying a series on a page other than its own.

Game parameters

The following are repeatable fields for specifying the games to display in the table. If all of the fields are omitted, the template will try to pull the list of games for this series from Wikidata and auto-populate the table. If any of these fields have been specified, even if some games are omitted, the template will not query Wikidata.

qid_n*: Specifies the Wikidata QID for this game. This is required if scores will be pulled from Wikidata. If omitted, only local scores will be used.
game_n*: Specifies the name of the game. This should be a Wikilink to the game's article. Italics will be added automatically. If qid_n has been specified, this can be omitted.

Review parameters

The following are repeatable fields for specifying the review scores of a game to display in the table. If qid_n has been specified, these will be populated from Wikidata where possible. If specified, Wikidata will not be used.

year_n*: Specifies the year that the game was released. If omitted and qid_n has been specified, Wikidata will be used if available.
sales_n*: Specifies the sales data for this game. If omitted, it will be blank, Wikidata will not be used. (Future enhancement)
fam_n*: Specifies the Famitsu review score for this game. A reference should be included. If omitted and qid_n has been specified, Wikidata will be used if available.
gr_n*: Specifies the GameRankings review score for this game. A reference should be included. If omitted and both gr=yes and qid_n have been specified, Wikidata will be used if available.
mc_n*: Specifies the Metacritic review score for this game. A reference should be included. If omitted and qid_n has been specified, Wikidata will be used if available.

Examples

Example

Code

Display

With no parameters, relying entirely on Wikidata. (Note, we use seriesQid here because we are not at the series' page.)

{{Template:Video game series reviews/sandbox
| seriesQid = Q20874570
}}

Aggregate review scores
Game	Year	Metacritic
Demon's Souls	2009	89/100^[1]
Dark Souls	2011	PC: 85/100^[2] PS3: 89/100^[3] X360: 89/100^[4]
Dark Souls II	2014	PC: 91/100^[5] PS3: 91/100^[6] X360: 91/100^[7]
Bloodborne	2015
Bloodborne: The Old Hunters	2015
Dark Souls III	2016	PC: 89/100^[8] PS4: 89/100^[9] XONE: 87/100^[10]
Dark Souls: Remastered	2018	NS: 83/100^[11] PC: 84/100^[12] PS4: 84/100^[13] XONE: 87/100^[14]
Sekiro: Shadows Die Twice	2019	91/100^[16] PS4: 90/100^[17] XONE: 91/100^[18]
Demon's Souls	2020	92/100^[15]
Elden Ring	2022

With qid_n specified, allowing all other data to be pulled from Wikidata. The QIDs in use in this example are from the Souls series.

{{Template:Video game series reviews/sandbox
| qid1 = Q1153708
| qid2 = Q1166232
| qid3 = Q3702740
| qid4 = Q20112508
}}

Aggregate review scores
Game	Year	Metacritic
Demon's Souls	2009	89/100^[1]
Dark Souls	2011	PC: 85/100^[2] PS3: 89/100^[3] X360: 89/100^[4]
Dark Souls II	2014	PC: 91/100^[5] PS3: 91/100^[6] X360: 91/100^[7]
Dark Souls III	2016	PC: 89/100^[8] PS4: 89/100^[9] XONE: 87/100^[10]

Using QIDs as above, with gr=yes.

{{Template:Video game series reviews/sandbox
| gr = yes
| qid1 = Q1153708
| qid2 = Q1166232
| qid3 = Q3702740
| qid4 = Q20112508
}}

Aggregate review scores
Game	Year	GameRankings	Metacritic
Demon's Souls	2009	90%^[19]	89/100^[1]
Dark Souls	2011	PC: 85%^[20] PS3: 88%^[21] X360: 88%^[22]	PC: 85/100^[2] PS3: 89/100^[3] X360: 89/100^[4]
Dark Souls II	2014		PC: 91/100^[5] PS3: 91/100^[6] X360: 91/100^[7]
Dark Souls III	2016		PC: 89/100^[8] PS4: 89/100^[9] XONE: 87/100^[10]

Overriding Wikidata by specifying scores.

{{Template:Video game series reviews/sandbox
| qid1 = Q1153708
| mc1 = MC1 override
| gr1 = GR1 override
| qid2 = Q1166232
| qid3 = Q3702740
| mc3 = MC3 override
| qid4 = Q20112508
}}

Aggregate review scores
Game	Year	GameRankings	Metacritic
Demon's Souls	2009	GR1 override	MC1 override
Dark Souls	2011	PC: 85%^[20] PS3: 88%^[21] X360: 88%^[22]	PC: 85/100^[2] PS3: 89/100^[3] X360: 89/100^[4]
Dark Souls II	2014		MC3 override
Dark Souls III	2016		PC: 89/100^[8] PS4: 89/100^[9] XONE: 87/100^[10]

Manual specification of fields, with no Wikidata auto-population.

{{Template:Video game series reviews/sandbox
| updated = July 5, 2015
| fam    = yes
| sales  = yes
| game1  = [[Valkyrie Profile]]
| sales1 = 709,000
| fam1   = 35/40
| mc1    = 81/100
| year1  = 2000
| game2  = Valkyrie Profile: Lenneth
| sales2 = 248,000
| fam2   = -
| mc2    = 80/100
| year2  = 2001
| game3  = [[Valkyrie Profile 2: Silmeria]]
| sales3 = 400,000 (JP)
| fam3   = 34/40
| mc3    = 84/100
| game4  = [[Valkyrie Profile: Covenant of the Plume]]
| sales4 = 230,000
| fam4   = 32/40
| mc4    = 74/100
}}

Sales and review scores
*As of July 5, 2015.*
Game	Year	Units sold	Famitsu	Metacritic
Valkyrie Profile	2000	709,000	35/40	81/100
Valkyrie Profile: Lenneth	2001	248,000	-	80/100
Valkyrie Profile 2: Silmeria		400,000 (JP)	34/40	84/100
Valkyrie Profile: Covenant of the Plume		230,000	32/40	74/100

^ ^a ^b ^c "Demon's Souls for PlayStation 3 Reviews". Metacritic. Retrieved January 28, 2010.
^ ^a ^b ^c ^d "Dark Souls: Prepare to Die Edition for PC Reviews". Metacritic. Retrieved December 23, 2013.
^ ^a ^b ^c ^d "Dark Souls for PlayStation 3 Reviews". Metacritic. Retrieved December 19, 2011.
^ ^a ^b ^c ^d "Dark Souls for Xbox 360 Reviews". Metacritic. Retrieved December 19, 2011.
^ ^a ^b ^c "Dark Souls II for PC Reviews". Metacritic. Retrieved April 25, 2014.
^ ^a ^b ^c "Dark Souls II for PlayStation 3 Reviews". Metacritic. Retrieved March 11, 2014.
^ ^a ^b ^c "Dark Souls II for Xbox 360 Reviews". Metacritic. Retrieved March 11, 2014.
^ ^a ^b ^c ^d "Dark Souls III for PC Reviews". Metacritic. Paramount Streaming. Retrieved September 29, 2016.
^ ^a ^b ^c ^d "Dark Souls III for PlayStation 4 Reviews". Metacritic. Paramount Streaming. Retrieved April 18, 2016.
^ ^a ^b ^c ^d "Dark Souls III for Xbox One Reviews". Metacritic. Paramount Streaming. Retrieved May 27, 2016.
^ "Dark Souls Remastered for Nintendo Switch Reviews". Metacritic. Retrieved June 21, 2019.
^ "Dark Souls Remastered for PC Reviews". Metacritic. Retrieved July 24, 2018.
^ "Dark Souls Remastered for PlayStation 4 Reviews". Metacritic. Retrieved June 21, 2019.
^ "Dark Souls Remastered for Xbox One Reviews". Metacritic. Retrieved June 21, 2019.
^ "Demon's Souls for PlayStation 5". Metacritic. Retrieved November 15, 2020.
^ "Sekiro: Shadows Die Twice for PC Reviews". Retrieved March 30, 2019.
^ "Sekiro: Shadows Die Twice for PlayStation 4 Reviews". Retrieved March 30, 2019.
^ "Sekiro: Shadows Die Twice for PlayStation 4 Reviews". Retrieved March 30, 2019.
^ "Demon's Souls for PlayStation 3". GameRankings. Retrieved January 28, 2010.
^ ^a ^b "Dark Souls: Prepare to Die Edition for PC". GameRankings. Retrieved June 24, 2016.
^ ^a ^b "Dark Souls for PlayStation 3". GameRankings. Retrieved June 24, 2016.
^ ^a ^b "Dark Souls for Xbox 360". GameRankings. Retrieved June 24, 2016.