Template:Infobox/Official World/doc: Difference between revisions

From VRChat Wiki
No edit summary
Hackebein (talk | contribs)
update docs
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Infobox/Official World
{{Infobox/Official World
|name=VRChat Home
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image=
|imagecaption=
|developer=VRChat
|platform= PCVR, Android
|link={{VRC link|https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd|VRChat Home}}
|published=Sep 30 2022
}}
}}
==Usage==
Paste this template at the top of an official 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.


Usage:
'''Required:'''
* <code>id</code> — the world's VRChat ID (e.g. <code>wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd</code>)


'''Optional (manual only):'''
* <code>developers</code> — additional developers not covered by the API developer field
* <code>languages</code> — languages used or available inside the world
==Example==
Minimal usage:
<pre>
<pre>
<nowiki>{{</nowiki>VRChat world
<nowiki>{{</nowiki>Infobox/Official World
|name=
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image=
|imagecaption=
|developer=
|publisher=
|designer=
|gen=
|platform=
|themes=
|link=
|labs=
|published=
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>


==Parameters==
With optional manual fields:
;name
: The name of the VRChat world.
 
;image
: An image representing the world.
 
;imagecaption
: A caption for the image.
 
;developer
: The developer of the VRChat world.
 
;publisher
: The publisher of the VRChat world.
 
;designer
: The designer of the VRChat world.
 
;gen
: The generation of the VRChat world.
 
;platform
: The platforms on which the VRChat world is available.
 
;themes
: The themes of the VRChat world.
 
;link
: The link to the VRChat world.
 
;labs
: Indicates if the world is part of the Community Labs.
 
;published
: The date when the VRChat world was published.
 
==Example==
<pre>
<pre>
<nowiki>{{</nowiki>VRChat world
<nowiki>{{</nowiki>Infobox/Official World
|name=Example World
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image=ExampleImage.jpg
|developers=ExampleDev1, ExampleDev2
|imagecaption=An example VRChat world
|languages=English, Japanese, French
|developer=Example Developer
|publisher=Example Publisher
|designer=Example Designer
|gen=1st Generation
|platform=PC, VR
|themes=Adventure, Exploration
|link=https://vrchat.com/home/world/wrld_example
|labs=Yes
|published=2024-01-01
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>
<noinclude>[[Category:Template Documentation]]</noinclude>
==TemplateData Documentation==
<templatedata>
{
"params": {
"id": {
"label": "World ID",
"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 15:25, 13 July 2026

Usage

Paste this template at the top of an official 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 developer field
  • languages — languages used or available inside the world

Example

Minimal usage:

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

With optional manual fields:

{{Infobox/Official 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