Template:Infobox/World/doc: Difference between revisions

From VRChat Wiki
Created page with "== Documentation == This is an infobox to be used for VRChat worlds. === Example Usage === <nowiki>{{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/user/8JoV9XEdpo vrchat]|Cross-Platform|335m~|113k~|16|8|Sep 30 2022|CW=VRRat Presence|link=https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd}}</nowiki> will make the infobox to the right of this page. {{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/us..."
 
Hackebein (talk | contribs)
update docs
 
(22 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Documentation ==
{{Infobox/World
This is an infobox to be used for VRChat worlds.
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
=== Example Usage ===
}}
<nowiki>{{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/user/8JoV9XEdpo vrchat]|Cross-Platform|335m~|113k~|16|8|Sep 30 2022|CW=VRRat Presence|link=https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd}}</nowiki>
==Usage==
Paste this template at the top of a world page with the world ID. Most infobox fields are filled automatically from live world data. While that data is still loading, a infobox placeholder is shown.


will make the infobox to the right of this page.
'''Required:'''
{{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/user/8JoV9XEdpo vrchat]|Cross-Platform|335m~|113k~|16|8|Sep 30 2022|CW=VRRat Presence|link=https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd}}
* <code>id</code> — the world's VRChat ID (e.g. <code>wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd</code>)


=== Template parameters ===
'''Optional (manual only):'''
{| class="wikitable"
* <code>developers</code> — additional developers not covered by the API author field
|+ Parameters
* <code>languages</code> — languages used or available inside the world
|-
 
! Name !! Variable !! Description
==Example==
|-
Minimal usage:
| World Name || <code>1</code>|| Name of the world on VRChat
<pre>
|-
<nowiki>{{</nowiki>Infobox/World
| Thumbnail || <code>2</code> || Thumbnail of the world (should be 256x192)
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|-
<nowiki>}}</nowiki>
| Creator || <code>3</code> || Creator, often should link to the creator's user page if possible.
</pre>
|-
 
| Platforms || <code>4</code> || Which platforms the world is available on.
With optional manual fields:
|-
<pre>
| Visits || <code>5</code> || Roughly the number of visits.
<nowiki>{{</nowiki>Infobox/World
|-
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
| Favorites || <code>6</code> || Roughly the number of favorites.
|developers=ExampleDev1, ExampleDev2
|-
|languages=English, Japanese, French
| Max Capacity || <code>7</code> || Max that it can stretch to for extra friends.
<nowiki>}}</nowiki>
|-
</pre>
| Base Capacity || <code>8</code> || Max amount of users that can fit.
==TemplateData Documentation==
|-
<templatedata>
| Published || <code>9</code> || When the world was originally published. (ex: Sep 30 2022)
{
|-
"params": {
| Content Warnings || <code>CW=</code> || Content labels a world has. ''(Optional)''
"id": {
|-
"label": "World ID",
| Link to world || <code>link=</code> || Link to the world. ''(Optional)''
"description": "The VRChat world ID.",
|}
"example": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
"type": "string",
"required": true
},
"developers": {
"label": "Developers",
"description": "Optional. Additional developer(s) for the wiki article.",
"example": "ExampleDev1, ExampleDev2",
"type": "string"
},
"languages": {
"label": "Available Languages",
"description": "Optional. Languages used or available inside the world.",
"example": "English, Japanese, French",
"type": "string"
}
},
"paramOrder": [
"id",
"developers",
"languages"
]
}
</templatedata>
 
<includeonly>[[Category:Infobox templates{{#translation:}}]]</includeonly>
<noinclude>[[Category:Template documentation{{#translation:}}]]</noinclude>

Latest revision as of 14:33, 13 July 2026

Usage

Paste this template at the top of a world page with the world ID. Most infobox fields are filled automatically from live world data. While that data is still loading, a infobox placeholder is shown.

Required:

  • id — the world's VRChat ID (e.g. wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd)

Optional (manual only):

  • developers — additional developers not covered by the API author field
  • languages — languages used or available inside the world

Example

Minimal usage:

{{Infobox/World
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
}}

With optional manual fields:

{{Infobox/World
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|developers=ExampleDev1, ExampleDev2
|languages=English, Japanese, French
}}

TemplateData Documentation

No description.

Template parameters

ParameterDescriptionTypeStatus
World IDid

The VRChat world ID.

Example
wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
Stringrequired
Developersdevelopers

Optional. Additional developer(s) for the wiki article.

Example
ExampleDev1, ExampleDev2
Stringoptional
Available Languageslanguages

Optional. Languages used or available inside the world.

Example
English, Japanese, French
Stringoptional