Template:GameInfobox/doc

From Codex Gamicus
Jump to: navigation, search


Template-info.png Documentation

GameInfobox is the over-aching template used for games, video games, expansion packs, and downloadable content. The following is a description of each variable that can be called from Template:GameInfobox.

The following is a pre-made example of what the template should look like; this can be copied and pasted into a new article, and sections that are not used can be deleted.

{{GameInfobox
| image         = 
| type          = 
| developer     = 
| publisher     = 
| edition       = 
| na_rel        = 
| eu_rel        = 
| jp_rel        = 
| au_rel        = 
| engines       = 
| series        = 
| franchise     = 
| features      = 
| license       = 
| genre         = 
| platforms     = 
| media         = 
| input         = 
}}

To call a variable, please do so as follows:

| <variable> = <data>

In order to make data human-readable, it is strongly suggested to maintain spacing between variables and data.

name

If different to the page name, {{{name}}} will automatically append the title on the Infobox to the input, and will also use DISPLAYNAME to alter the name of the game as it appears.

displayname

This just changes the name as it shows on the Infobox. Nothing else is changed.

image

The physical name of the image on the wiki. There is no need to append Image: or File: to the beginning, as the File: namespace is automatically specified in the template

caption

This is where an explanation or description of {{{image}}} can be given. It will be shown under the image in italics.

image2

The physical name of a second image on the wiki. There is no need to append Image: or File: to the beginning, as the File: namespace is automatically specified in the template

caption2

This is where an explanation or description of {{{image2}}} can be given. It will be shown under the image in italics.

image3

The physical name of a third image on the wiki. There is no need to append Image: or File: to the beginning, as the File: namespace is automatically specified in the template

caption3

This is where an explanation or description of {{{image3}}} can be given. It will be shown under the image in italics.

type

If this is not entered, it defaults to Video Game. The full list of acceptable criteria is found at Template:PageTypeSwitch.

developer

This is the developer(s) of a given game title. Multiple entries are permitted, separated by a comma (,) for each additional entry.

publisher

This is the publisher(s) of a given game title. Multiple entries are permitted, separated by a comma (,) for each additional entry.

distributor

This is for the company or companies involved in distributing the game (back when Publishers did not handle distribution). This is for companies that handle distribution of physical media only. Actual platforms such as Steam, etc, use the variable {{{dplatform}}}.

manufacturer

game

This is where we define the game that downloadable content is for.

published

status

Used to describe the status of the development of the game, eg. released, early access, cancelled.

license

This is for listing the licenses a game is released under. The full list of acceptable criteria is found at Template:LicenseSwitch.

edition

This is to be used if the game is a special edition, or something akin to that. The full list of acceptable criteria is found at Template:GameEditionSwitch.

franchise

This is the franchise that a given game title belongs to. It will automatically append (franchise) to the article target, and use the variable name as the wikilink name, for example Mario. Multiple entries are permitted, separated by a comma (,).

series

This is the series that a given game title belongs to. It will automatically append (series) to the article target, and use the variable name as the wikilink name, for example Mario Golf. Multiple entries are permitted, separated by a comma (,).

predecessor

This allows us to directly link to the direct predecessor of a game.

successor

This allows us to directly link to the direct successor of a game.

first_patch

successor_expansion

successor_series

predecessor_expansion

predecessor_series

genre

This is for the genre(s) that a game can be considered to be in. We operate with a few in mind:
  • Action
  • Adventure
  • Business simulation
  • Casual
  • First-person shooter
  • Free-to-Play
  • Indie
  • MMO
  • Platform
  • Puzzle
  • Racing
  • RPG
  • Sci-fi
  • Shooter
  • Simulation
  • Sports
  • Strategy
  • Turn-based strategy

Action and Adventure are separate genres, and are not to be combined. This list is not exhaustive. Multiple entries are permitted, separated by a comma (,). The full list of acceptable criteria is found at Template:GenreSwitch.

paymodel

The full list of acceptable criteria is found at Template:PaymentSwitch.

purchases

The full list of acceptable criteria is found at Template:InAppPurchasesSwitch.

discs

media

This is what the game was made available on, such as cartridges, optical discs, or digital download. The full list of acceptable criteria is found at Template:MediaSwitch.

input

The full list of acceptable criteria is found at Template:InputSwitch.

arch

The full list of acceptable criteria is found at Template:ArchSwitch.

platforms

This is where we inform the reader what platform (and/or operating system) a game was released for. Multiple entries are permitted, separated by a comma (,). Some platforms have different names between territories, e.g. Genesis and Mega Drive were used in the United States, and the Rest of the World respectively. In this case, if a game had only a US release, Genesis is to be used. If it had a release only outside of the US, use Mega Drive. Where where was a release in both territories, use both terms. The full list of acceptable criteria is found at Template:PlatformSwitch/doc.

bcplatforms

This is for backward compatible platforms. The full list of acceptable criteria is found at Template:BCPlatformSwitch.

bundleplatforms

This is for bundle release platforms.

bundledplatforms

This is for bundle digital release platforms.

canplatforms

This is for explicitly listing platforms that were planned for a release of that game, but were ultimately cancelled.

cplatforms

This is for compiled platforms; these are platforms that can be compiled for the game to run on, but are not offered as official released by the developers. The full list of acceptable criteria is found at Template:CPlatformSwitch.

dplatforms

This is for digital platforms, such as Steam. The full list of acceptable criteria is found at Template:DPlatformSwitch.

eplatforms

This is for emulated platforms. The full list of acceptable criteria is found at Template:EPlatformSwitch.

enplatforms

This is for enhanced platforms. The full list of acceptable criteria is found at Template:EnhancedPlatformSwitch.

splatforms

This is for subscription platforms. The full list of acceptable criteria is found at Template:SPlatformSwitch.

gog

The full list of acceptable criteria is found at Template:GOGPlatformSwitch.

origin

The full list of acceptable criteria is found at Template:OriginPlatformSwitch.

steam

The full list of acceptable criteria is found at Template:SteamPlatformSwitch.

vcplatforms

This is for virtual console platforms. The full list of acceptable criteria is found at Template:VCPlatformSwitch.

vrplatforms

This is for VR platforms. The full list of acceptable criteria is found at Template:VRPlatformSwitch.

features

Inspired by the game features that can be found on Steam, this is an indication of important features that the game supports, or takes advantage of. A complete list is available at Template:FeatureSwitch. Multiple entries are permitted, separated by a comma (,).

android_features

This is an indication of important features that the game supports, or takes advantage of, on Android. The full list of acceptable criteria is found at Template:AndroidFeatureSwitch.

gog_features

This is an indication of important features that the game supports, or takes advantage of, on GOG.com. The full list of acceptable criteria is found at Template:GOGFeatureSwitch.

ios_features

This is an indication of important features that the game supports, or takes advantage of, on iOS. The full list of acceptable criteria is found at Template:iOSFeatureSwitch.

mss_features

This is an indication of important features that the game supports, or takes advantage of, on Microsoft Store. The full list of acceptable criteria is found at Template:MSSFeatureSwitch.

origin_features

This is an indication of important features that the game supports, or takes advantage of, on Origin. The full list of acceptable criteria is found at Template:OriginFeatureSwitch.

psn_features

This is an indication of important features that the game supports, or takes advantage of, on PSN. The full list of acceptable criteria is found at Template:PSNFeatureSwitch.

steam_features

This is an indication of important features that the game supports, or takes advantage of, on Steam. The full list of acceptable criteria is found at Template:SteamFeatureSwitch.

uplay_features

This is an indication of important features that the game supports, or takes advantage of, on Uplay. The full list of acceptable criteria is found at Template:UplayFeatureSwitch.

vc_features

This is an indication of important features that the game supports, or takes advantage of, on Virtual Console. The full list of acceptable criteria is found at Template:VCFeatureSwitch.

xbl_features

This is an indication of important features that the game supports, or takes advantage of, on Xbox Live. The full list of acceptable criteria is found at Template:XBLFeatureSwitch.

ratings

This is for listing the ratings granted to a game. If different platforms were given different ratings, these may be documented here, too. Example of ratings would be ESRB-T, PEGI-16, USK-18, BBFC-15, CERO-A, etc. The full list of acceptable criteria is found at Template:RatingSwitch.

pegiadd

Content descriptors for PEGI ratings.

esrbadd

Content descriptors for ESRB ratings.

ceroadd

Content descriptors for CERO ratings.

grbadd

Content descriptors for GRB ratings.

krsadd

Content descriptors for KRS ratings.

osrs

Content descriptors for OSRS ratings.

basegame

Base game, if the subject of the page is DLC or an expansion pack.

gameversions

cgameversion

players

playtime

ages

mechanics

addsoft

Additional software required to run the game.

aspectratio

Supported aspect ratios.

definition

resolutions

Supported resolutions.

pictureformat

version

patch_version

ps3_version

ps4_version

stable

unstable

versions

<platform>-<region>

Catalogue number for given platform.
Acceptable platforms are:
  • gb - Game Boy
  • gbc - Game Boy Color
  • gc - GameCube
  • n3ds - New Nintendo 3DS
  • 3ds - Nintendo 3DS
  • ds - Nintendo DS
  • nsw - Nintendo Switch
  • ps1 - PlayStation
  • ps2 - PlayStation 2
  • ps3 - PlayStation 3
  • ps4 - PlayStation 4
  • psp - PlayStation Portable
  • psvita - PlayStation Vita
  • wii - Wii
  • wiiu - Wii U
  • xbox - Xbox
  • x360 - Xbox 360
  • xb1 - Xbox One
Acceptable regions are:
  • pal - PAL
  • ntscj - NTSC-J

gwg

nitro

psplus

prime

director

These are the director(s) of a given game title. Multiple entries are permitted, separated by a comma (,) for each additional entry.

writer

These are the writer(s) of a given game title. Multiple entries are permitted, separated by a comma (,) for each additional entry.

artist

These are the artist(s) of a given game title. Multiple entries are permitted, separated by a comma (,) for each additional entry.

programmer

These are the programmer(s) of a given game title. Multiple entries are permitted, separated by a comma (,) for each additional entry.

producer

These are the producer(s) of a given game title. Multiple entries are permitted, separated by a comma (,) for each additional entry.

engines

This is for listing the game engines used by a game. The full list of acceptable criteria is found at Template:EnginesSwitch.

Common usage of Template:Release[edit source]

Template:Release allows us to categorise games based on when they were released. Where there was a release on one platform, Template:Release is to be called like this:

{{Release|Year|Month|Day|Region|Platform}}

Where there are multiple platforms and release dates, it is to be called like this:

'''<Platform 1>'''<br>{{Release|Year|Month|Day}}<br><br>'''<Platform 2>'''<br>{{Release|Year|Month|Day}}

Where some platforms share release dates, this can be handled as such:

'''<Platform 1>, <Platform 2> & <Platform 3>'''<br>{{Release|Year|Month|Day}}<br><br>'''<Platform 4> & <Platform 5>'''<br>{{Release|Year|Month|Day}}<br><br>'''<Platform 6>'''<br>{{Release|Year|Month|Day}}

na_rel

This is used to list the date(s) for the release of a game in North America (typically comprised of Canada, the United States of America, and Mexico).

us_rel

This is used to list the date(s) for the release of a game in the United States.

eu_rel

This is used to list the date(s) for the release of a game in Europe (typically comprised of countries inside the European Union, sometimes excluding ones with sometimes separate release and rating systems, like Germany and the United Kingdom).

as_rel

This is used to list the date(s) for the release of a game in Asia (typically comprised of the countries China, Japan, and South Korea).

sa_rel

This is used to list the date(s) for the release of a game in South America (typically comprised of the countries Argentina, Brazil, and Chile).

oc_rel

This is used to list the date(s) for the release of a game in Oceania (typically comprised of the countries Australia, and New Zealand).

jp_rel

This is used to list the date(s) for the release of a game in Japan.

au_rel

This is used to list the date(s) for the release of a game in Australia.

nz_rel

This is used to list the date(s) for the release of a game in New Zealand.

fr_rel

This is used to list the date(s) for the release of a game in France.

de_rel

This is used to list the date(s) for the release of a game in Germany.

es_rel

This is used to list the date(s) for the release of a game in Spain.

kr_rel

This is used to list the date(s) for the release of a game in South Korea.

uk_rel

This is used to list the date(s) for the release of a game in the United Kingdom.

ga_rel

This is used to list the date(s) for the release of a game in the Republic of Ireland.

br_rel

This is used to list the date(s) for the release of a game in Brazil.

za_rel

This is used to list the date(s) for the release of a game in South Africa.

ww_rel

This is used to list the date(s) for the International release of a game.

ru_rel

This is used to list the date(s) for the release of a game in Russia.

cz_rel

This is used to list the date(s) for the release of a game in the Czech Republic.

cn_rel

This is used to list the date(s) for the release of a game in the People's Republic of China.

tw_rel

This is used to list the date(s) for the release of a game in Taiwan.

th_rel

This is used to list the date(s) for the release of a game in Thailand.

vi_rel

This is used to list the date(s) for the release of a game in Vietnam.

my_rel

This is used to list the date(s) for the release of a game in Malaysia.

sg_rel

This is used to list the date(s) for the release of a game in Singapore.

in_rel

This is used to list the date(s) for the release of a game in India.

id_rel

This is used to list the date(s) for the release of a game in Indonesia.

ph_rel

This is used to list the date(s) for the release of a game in the Philippines.

mx_rel

This is used to list the date(s) for the release of a game in Mexico.

hk_rel

This is used to list the date(s) for the release of a game in Hong Kong.

option

By default, the links to "navigational" pages, such as Awards, Cheats, Codes, Covers, Credits, Ratings, Soundtrack, Patches, Videos, and Walkthrough are generated automatically with GameInfobox (and further linked to with Template:Navigation. If you want to create additional navigational pages, make sure you input the "|option =" and type in what you want (for example: |option = Characters, Costumes, Levels). However, priority for this section goes to the following:
  • Steam Achievements
  • Xbox Live Achievements
  • Trophies
  • Achievements
  • Steam Trading Cards

If further pages are needed for content, option2 is where they should be specified if any of the above exist.