View source for Template:ObbyGameInfobox/doc

{{Documentation|synced=true}}
{{Documentation/usage
| name = ObbyGameInfobox
| description = The largest and most important infobox of the Obby Wiki, responsible for rendering the infobox display on every obby page and categorizing them automatically.
| when = On every single obby page.
| where = Absolute top of page, before the lead
| usage = {{Tl|ObbyGameInfobox|...}} (see below)
}}
{{Tl|ObbyGameInfobox}} is a large and complex template (which invokes [[Module:ObbyGameInfobox]]). Please refer to the below documentation about how each parameter is used.

Please note that only the <code>root_place_id</code> and <code>name</code> parameters are truly required for an ideal template. Most information is automatically fetched based on the place id. The root place id should be the number/id in the url when you open the game.

== Usage ==

New contributors should utilize the Article Flow tool, found at the top left of the page (the plus button), as it guides you through making a new article, as well as automating some tedious tasks. Currently, this infobox only supports obbies on Roblox.

At the bare minimum, the below parameters are required to produce an infobox.

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
| name = {{PAGENAME}} <!-- Automatically fills in the name of the obby with the page's name (default) -->
| root_place_id = 1818 <!-- The root place ID of a game, also referred to as the start place ID. Typically, this is found with-in the numbers part of a Roblox game URL (e.g., https://www.roblox.com/games/1818/...) -->
}}
</syntaxhighlight>

Supply the suggested parameters for the ideal output from the template:

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
| name = {{PAGENAME}}
| image = UploadedFileName.webp <!-- The name of an uploaded file/image on the ObbyWiki. WebP is recommended, as it is also the default file type from Roblox. This should be a game's thumbnail, ideally. -->
| root_place_id = 1818
| developer = @UsernameOrGroupName <!-- This may be confusing, but this is only the uploader/owner of the game, such as the name displayed after 'By ...' on the game's page. This can be an @Username (must be prefixed with an @ symbol if the developer is a user), or just a Group Name. -->
| subgenre = stage_tower_obby <!-- See https://obby.wiki/Help:Supported_obby_genres -->
| maturity = minimal

<!-- The date the obby was released or created (the release date takes precendent, if known). -->
| year = 2023
| month = 04
| day = 27

| avatar_type = r6 <!-- r6/r15/choice -->

| verified = true <!-- See https://obby.wiki/Obby_Wiki:Playability -->
}}
</syntaxhighlight>

While additional parameters can help, these are the ones you should focus on supplying. 

For collection and organization purposes, such as displaying contributed obbies on a developer's wiki page, you can use the <code>developers</code> parameter to attach it to them (note: this is distinct from the <code>developer</code> parameter).

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
<!-- ... -->
| developers = @Username1,@Username2,@Username3 <!-- @Usernames only, entries are separated by a comma (,) and no spaces. -->
<!-- ... -->
}}
</syntaxhighlight>

You can also use the <code>contributors</code> parameter if the contributor is not a core developer.

Optional device parameters may also be used, if known:

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
<!-- ... -->
| pc = true
| tablet = true
| phone = true
| vr = true
| console = true
<!-- ... -->
}}
</syntaxhighlight>

Some parameters have <code>_total</code> counterparts. This is useful for obbies that have stages, but have not finished them yet. Instead of just displaying <code>Stages: 30</code>, the infobox can display <code>Stages: 30 (of 40)</code> instead.

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
<!-- ... -->
| stages = 30
| stages_total = 40
<!-- ... -->
}}
</syntaxhighlight>

This goes for many different sub-genre-specific parameters, such as <code>difficulties</code> or <code>towers</code>.

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
<!-- ... -->
| towers = 1
| towers_total = 2

| difficulties = 10
| difficulties_total = 12
<!-- ... -->
}}
</syntaxhighlight>

While a parameter and its <code>_total</code> counterpart can have an equal value, this behavior is not widely used.

As well as genre-specific parameters, which you can find below.

=== Examples ===

Here are some examples for what you can directly use on a page:

<tabber>
|-|Classic Obby=

A Classic Obby is a bland obby with no applicable sub-genre. As such, it has no genre-specific parameters.

Example from [[Obby Creator]].

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
| name = Obby Creator
| image = Obby_creator_thumb_1.webp
| root_place_id = 2913303231
| developer = Whirlpool Studio
| publisher = Whirlpool Studio
| subgenre = Obby
| maturity = minimal
| year = 2019
| month = 03

| obbies = 1000000 <!-- Could be 'stages', alternatively -->

| avatar_type = r6
| verified = true
| ai = none

| peak_ccu = 0

| pc = true
| tablet = true
| phone = true
| vr = true
| console = true
}}
</syntaxhighlight>
|-|Difficulty Chart Obby=
A [[Difficulty Chart Obby]] needs a few specific and unique aspects added, such as the <code>difficulties</code> parameter.

Example from [[Star's Difficulty Chart Obby]].

<syntaxhighlight lang="wikitext">
{{ObbyGameInfobox
| name = Star's Difficulty Chart Obby
| image = Star's Difficulty Chart Obby v3 thumb upsell.png
| root_place_id = 10384955640
| developer = Kiwi's Obbies
| developers = @Wolf1te,@ActuallyAKiwi,@or_ob,@MohoOoPvP
| contributors = @TheAvsar,@Sylv0791
| subgenre = dco
| maturity = minimal
| year = 2022
| month = 07
| stages = 260
| avatar_type = r6
| tier = 9 <!-- See https://obby.wiki/Tiers -->
| verified = true

| system = WOS v0.8.5 Premium (modified) <!-- This is completely optional, as many developers hide their obby system today -->

| peak_ccu = 1100

| pc = true
| tablet = true
| phone = true
| vr = true
| console = true
}}
</syntaxhighlight>

</tabber>

<hr />

== Related ==
* [[Help:Supported_obby_genres]] - lists official supported sub-genres and shorthands
* [[OW:Playability]] - reference on what to mark as playable and what to not
* [[Special:MyLanguage/Tiers|Tiers]] - what are tiers
* [[Blog:Create_an_obby_article_easily]] - make an obby article boilerplate semi-automatically

The config reference of this template is provided below. This reference is also accessible via the Visual Editor when editing a page.

<hr />

== Template Data ==

<templatedata>
{
	"params": {
		"name": {
			"label": "Obby Name",
			"autovalue": "{{PAGENAME}}",
			"description": "The actual name of the Obby. Do not include updates or markers like [NEW] or [DCO].",
			"type": "string",
			"example": "{{PAGENAME}}",
			"suggestedvalues": [
				"{{PAGENAME}}"
			],
			"default": "{{PAGENAME}}",
			"required": true
		},
		"image": {
			"aliases": [
				"thumb"
			],
			"label": "Image",
			"description": "Provides the main thumbnail image by name of the file. Do not include markdown.",
			"example": "thumbnail.webp",
			"type": "wiki-file-name",
			"default": "standard169placeholder.webp",
			"suggested": true
		},
		"root_place_id": {
			"label": "Root Place ID",
			"description": "(aka. Start Place ID) is required for the infobox to function and is the standard. You can grab this from the numbers in the URL of the game's page on Roblox.",
			"example": "1818",
			"type": "number",
			"required": true
		},
		"developer": {
			"label": "Developer",
			"description": "The developer of the obby, either an @username or a Group Name. Will be used as a fallback.",
			"example": "My Group Name",
			"type": "string",
			"suggested": true
		},
		"publisher": {
			"label": "Publisher",
			"description": "The publisher of the game. Leave blank if none or unknown.",
			"type": "string"
		},
		"subgenre": {
			"label": "Sub-genre",
			"description": "The sub-genre of the Obby. See a list of supported sub-genres and shorthands at https://obbywiki.com/wiki/Help:Supported_obby_genres",
			"example": "classic_obby",
			"type": "string",
			"suggested": true
		},
		"maturity": {
			"label": "Maturity Rating",
			"description": "The age/maturity rating provided by Roblox.",
			"example": "minimal",
			"type": "string",
			"suggestedvalues": [
				"minimal",
				"na",
				"unrated",
				"none",
				"mild",
				"mature",
				"restricted"
			],
			"default": "na"
		},
		"year": {
			"label": "Release Year",
			"description": "The year the obby was released. If true release year is known, use that. Otherwise, use the game's creation date. (20xx - ''will only be valid if at or above 2008 and below or at the current year or up to 2 years ahead'')",
			"type": "number",
			"suggestedvalues": [
				"2026"
			],
			"suggested": true
		},
		"month": {
			"label": "Release Month",
			"description": "The month the obby was released; 1-12 only.",
			"type": "number",
			"suggestedvalues": [
				"1",
				"2",
				"3",
				"4",
				"5",
				"6",
				"7",
				"8",
				"9",
				"10",
				"11",
				"12"
			],
			"suggested": true
		},
		"stages": {
			"aliases": [
				"levels"
			],
			"label": "Stages",
			"description": "The amount of stages/checkpoints if applicable and with-in the game.",
			"example": "220",
			"type": "number",
			"default": "0"
		},
		"stages_total": {
			"label": "Stages (total/planned)",
			"description": "The total amount of stages that are planned, including ones that are unfinished or not in the game but will be. Requires `stages`.",
			"example": "300",
			"type": "number"
		},
		"difficulties": {
			"label": "Difficulties",
			"description": "Mainly referring to difficulties from the Difficulty Chart Obby sub-genre.",
			"type": "number",
			"example": "10"
		},
		"difficulties_total": {
			"label": "Difficulties (total/planned)",
			"description": "The total amount of difficulties total that are planned. Requires `difficulties`.",
			"type": "number",
			"example": "12"
		},
		"towers": {
			"label": "Towers",
			"description": "If the game is a tower obby or has bonus towers, fill in this field.",
			"example": "3",
			"type": "number"
		},
		"towers_total": {
			"label": "Towers (total/planned)",
			"description": "The amount of total planned towers and bonus towers. Requires `towers`.",
			"example": "5",
			"type": "number"
		},
		"avatar_type": {
			"label": "Avatar Type",
			"description": "The avatar type the obby allows. Typically R6.",
			"type": "string",
			"suggestedvalues": [
				"r6",
				"r15",
				"rthro",
				"choice"
			],
			"suggested": true
		},
		"verified": {
			"label": "Verified (playability)",
			"description": "The verified playability/completability of the obby's main progression. See [[Project:Playability]] for more information.",
			"type": "string",
			"suggestedvalues": [
				"true",
				"false",
				"broken",
				"does_not_load"
			],
			"default": "false"
		},
		"ai": {
			"label": "AI Usage",
			"description": "If known, this field discloses if AI was used during the games development or marketting.",
			"type": "string",
			"suggestedvalues": [
				"branding",
				"thumbnails",
				"icon",
				"identity",
				"stated_none",
				"description",
				"unknown"
			],
			"default": "unknown"
		},
		"is_public": {
			"label": "Public",
			"description": "If the obby is publicly playable. May fill automatically.",
			"example": "true",
			"type": "boolean",
			"default": "true",
			"autovalue": "true"
		},
		"unreleased": {
			"label": "Unreleased",
			"description": "If the game itself is unreleased and coming soon.",
			"type": "boolean",
			"default": "false",
			"autovalue": "false"
		},
		"visits": {
			"label": "Visits",
			"description": "The amount of total visits a obby has. Now filled and updated automatically.",
			"type": "number",
			"deprecated": true
		},
		"dislikes": {
			"label": "Dislikes",
			"description": "The amount of dislikes the obby has. Now filled and updated automatically.",
			"type": "number",
			"deprecated": true
		},
		"peak_ccu": {
			"label": "Peak CCU",
			"description": "The highest ever recorded CCU in the obby's lifespan.",
			"type": "number"
		},
		"twitter": {
			"aliases": [
				"x"
			],
			"label": "Twitter",
			"description": "The social media (Twitter) handle of the game, development group or owner's account, or attached social link.  Does not include an `@`.",
			"type": "string"
		},
		"bluesky": {
			"aliases": [
				"bsky"
			],
			"label": "BlueSky",
			"description": "The social media (BlueSky) handle of the game, development group or owner's account, or attached social link.  Does not include an `@`.",
			"type": "string"
		},
		"youtube": {
			"label": "YouTube",
			"description": "The social media (YouTube) handle of the game, development group or owner's account, or attached social link.  Does not include an `@`. Only supports handles. Does not support legacy YouTube username systems.",
			"type": "string"
		},
		"discord": {
			"label": "Discord",
			"description": "The invite code of the game, development group or owner's Discord server, or attached social link.  Does not include a url or anything before or after the code.",
			"type": "string"
		},
		"guilded": {
			"label": "Guilded",
			"description": "Deprecated (as Guilded was sunset). Still works for legacy support. May be removed shortly.",
			"type": "string",
			"deprecated": "Guilded was sunset in December 2025."
		},
		"website": {
			"label": "Website",
			"description": "The most prominent website related to the game or development studio/owner. Use the `wiki` field if appropriate.",
			"type": "string"
		},
		"wiki": {
			"label": "Wiki",
			"description": "If applicable, the game or community's wiki. Represented with a MediaWiki logo.",
			"type": "string"
		},
		"pc": {
			"label": "PC",
			"description": "If the game is compatible with PC/Desktop.",
			"type": "boolean"
		},
		"tablet": {
			"label": "Tablet",
			"description": "If the game is compatible with Tablet.",
			"type": "boolean"
		},
		"phone": {
			"label": "Phone",
			"description": "If the game is compatible with Phone.",
			"type": "boolean"
		},
		"vr": {
			"label": "VR",
			"description": "If the game is compatible with VR.",
			"type": "boolean"
		},
		"console": {
			"label": "Console",
			"description": "If the game is compatible with Console.",
			"type": "boolean"
		},
		"likes": {
			"label": "Likes",
			"description": "The amount of likes the obby has. Now filled and updated automatically.",
			"type": "number",
			"deprecated": true
		},
		"roblox": {
			"label": "Roblox",
			"description": "The username of the featured Roblox account/developer. Does not include an `@`.",
			"type": "string",
			"deprecated": "May not be supported in the future."
		},
		"system": {
			"label": "(Obby) System",
			"description": "If known, the underlying obby system the obby uses. Leave blank if unknown.",
			"type": "string"
		},
		"tier": {
			"label": "Tier",
			"description": "If known, the [[Special:MyLanguage/Tiers Obby Tier] of the obby. Leave at 0 or unfilled if unknown or unrated.",
			"type": "number",
			"suggestedvalues": [
				"0",
				"1",
				"2",
				"3",
				"4",
				"5",
				"6",
				"7",
				"8",
				"9",
				"10",
				"11",
				"12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18"
			],
			"default": "0"
		},
		"day": {
			"label": "Release Day",
			"description": "The day the obby was released on. Will be filled with creation date if invalid.",
			"type": "number",
			"suggestedvalues": [
				"1",
				"2",
				"3",
				"4",
				"5",
				"6",
				"7",
				"8",
				"9",
				"10",
				"11",
				"12",
				"13",
				"14",
				"15",
				"16",
				"17",
				"18",
				"19",
				"20",
				"21",
				"22",
				"23",
				"24",
				"25",
				"26",
				"27",
				"28",
				"29",
				"30",
				"31"
			]
		}
	},
	"paramOrder": [
		"name",
		"image",
		"root_place_id",
		"tier",
		"publisher",
		"subgenre",
		"maturity",
		"year",
		"month",
		"developer",
		"stages",
		"stages_total",
		"difficulties",
		"difficulties_total",
		"towers",
		"towers_total",
		"avatar_type",
		"verified",
		"ai",
		"is_public",
		"unreleased",
		"system",
		"visits",
		"likes",
		"dislikes",
		"peak_ccu",
		"twitter",
		"bluesky",
		"youtube",
		"roblox",
		"discord",
		"guilded",
		"website",
		"wiki",
		"pc",
		"tablet",
		"phone",
		"vr",
		"console",
		"day"
	],
	"description": "The main infobox for an obby game page. Requests live information and the correct universe ID automatically based on the root/start place ID provided. Requires '''name''', '''image''', and '''root_place_id''' at a minimum. Certain sub-genres may require more. Fill in every suggested response related to your sub-genre to ensure prefect functionality.",
	"format": "block"
}
</templatedata>