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

From VRChat Wiki
← Older edit
VisualWikitext
Patroll (talk | contribs)
automoderated, Community Moderators, Proofreaders
3,761 edits
Add TemplateData and removeParameters section
Hackebein (talk | contribs)
Community Moderators, Interface administrators
1,621 edits
update docs
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<noinclude>[[Category:Template Documentation]]</noinclude>
{{Infobox/Official World
{{Infobox/Official World
|name=VRChat Home
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image=VrcHomeThumb.png
|imagecaption=
|developer=VRChat
|platform= PC, Android
|link={{World link|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.
'''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==
==Example==
Minimal usage:
<pre>
<pre>
<nowiki>{{</nowiki>VRChat world
<nowiki>{{</nowiki>Infobox/Official World
|name=Example World
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image=ExampleImage.jpg
<nowiki>}}</nowiki>
|imagecaption=An example VRChat world
</pre>
|developer=Example Developer
 
|publisher=Example Publisher
With optional manual fields:
|designer=Example Designer
<pre>
|gen=1st Generation
<nowiki>{{</nowiki>Infobox/Official World
|platform=PC, VR
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|themes=Adventure, Exploration
|developers=ExampleDev1, ExampleDev2
|link=https://vrchat.com/home/world/wrld_example
|languages=English, Japanese, French
|labs=Yes
|published=2024-01-01
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>
Line 30: Line 32:
{
{
"params": {
"params": {
"name": {
"id": {
"label": "Name",
"label": "World ID",
"description": "The name of the VRChat world.",
"description": "The VRChat world ID.",
"example": "Example World",
"example": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
"type": "string",
"type": "string",
"required": true
"required": true
},
},
"image": {
"developers": {
"label": "Image",
"label": "Developers",
"description": "An image representing the world.",
"description": "Optional. Additional developer(s) for the wiki article.",
"example": "ExampleImage.jpg",
"example": "ExampleDev1, ExampleDev2",
"type": "wiki-file-name",
"required": true
},
"imagecaption": {
"label": "Image caption",
"description": "A caption for the image.",
"example": "An example VRChat world",
"type": "string"
},
"developer": {
"label": "Developer",
"description": "The developer of the VRChat world.",
"example": "Example Developer",
"type": "string"
},
"publisher": {
"label": "Publisher",
"description": "The publisher of the VRChat world.",
"example": "Example Publisher",
"type": "string"
},
"designer": {
"label": "Designer",
"description": "The designer of the VRChat world.",
"example": "Example Designer",
"type": "string"
"type": "string"
},
},
"gen": {
"languages": {
"label": "Generation",
"label": "Available Languages",
"description": "The generation of the VRChat world.",
"description": "Optional. Languages used or available inside the world.",
"example": "1st Generation",
"example": "English, Japanese, French",
"type": "string"
},
"platform": {
"label": "Platform",
"description": "The platforms on which the VRChat world is available.",
"example": "PC, Android, iOS",
"type": "string",
"suggestedvalues": [
"PC",
"Android",
"iOS"
],
"required": true
},
"themes": {
"label": "Themes",
"description": "The themes of the VRChat world.",
"example": "Adventure, Exploration",
"type": "string"
"type": "string"
},
"link": {
"label": "Link",
"description": "The link to the VRChat world.",
"example": "https://vrchat.com/home/world/wrld_example",
"type": "url"
},
"labs": {
"label": "Labs",
"description": "Indicates if the world is part of the Community Labs.",
"example": "Yes",
"type": "string",
"suggestedvalues": [
"Yes"
]
},
"published": {
"label": "Published",
"description": "The date when the VRChat world was published.",
"example": "2024-01-01",
"type": "date"
}
}
},
},
"paramOrder": [
"paramOrder": [
"name",
"id",
"image",
"developers",
"imagecaption",
"languages"
"developer",
"publisher",
"designer",
"gen",
"platform",
"themes",
"link",
"labs",
"published"
]
]
}
}
</templatedata>
</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
Retrieved from "https://wiki.vrchat.com/index.php?title=Template:Infobox/Official_World/doc&oldid=99106"