Template:Infobox/World/doc: Difference between revisions

From VRChat Wiki
← Older edit
VisualWikitext
m Text replacement - "\[\[(?!(Special:|File:|Media:))([^\|\]]+)\]\]" to "$2"
Hackebein (talk | contribs)
Community Moderators, Interface administrators
1,621 edits
update docs
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Infobox/World
{{Infobox/World
|name= Example World
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image= VrcHomeThumb.png
|publisher= Example Publisher
|developers= ExampleDev1, ExampleDev2
|capacity= 80 (40)
|platforms= PC, Android, iOS
|tags= tag1, tag2, tag3, tag4, tag5
|languages= English, Japanese, French
|id= wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|labs= Jan 1 2024
|published= Jan 1 2024
}}
}}
Paste this template into a World Page to have the infobox appear on the top right. It is recommended to paste and fill this out while in the Source editor, however this can also be done in the Visual editor. For more guidance on how to best use this, see how other World pages have implemented this infobox.
==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.


Fields without contents will not show up on the infobox.
'''Required:'''
* <code>id</code> — the world's VRChat ID (e.g. <code>wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd</code>)


Usage:
'''Optional (manual only):'''
* <code>developers</code> — additional developers not covered by the API author field
* <code>languages</code> — languages used or available inside the world


==Example==
Minimal usage:
<pre>
<pre>
<nowiki>{{</nowiki>Infobox/World
<nowiki>{{</nowiki>Infobox/World
|name=
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image=
|publisher=
|developers=
|capacity=
|platforms=
|tags=
|languages=
|id=
|labs=
|published=
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>


==Parameters==
With optional manual fields:
<nowiki>*</nowiki> = Mandatory
 
;name*
: The name of the VRChat world.
 
;image*
: The image used for the thumbnail of the world.
 
;publisher*
: The user who has the VRChat world published to their account.
 
;developers
: The main developer(s) of the VRChat world. This field is optional if the publisher is the sole developer.
 
;capacity
: The user capacity of the VRChat world, followed by its recommended capacity in parentheses.
 
;platforms
: The platforms on which the VRChat world is available. PC, Android and/or iOS.
 
;tags
: The tags of the VRChat world.
 
;languages
: Languages used or available inside the VRChat world.
 
;id*
: The VRChat world's ID used to link to it on the VRChat website, as well as identify it for other internal purposes. A world's ID can be found at the end of its URL on the VRChat website like so: https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
 
;labs
: The date the VRChat world was published to Community Labs.
 
;published
: The date the VRChat world was published/released from Community Labs.
 
==Example==
<pre>
<pre>
<nowiki>{{</nowiki>Infobox/World
<nowiki>{{</nowiki>Infobox/World
|name= Example World
|id=wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|image= VrcHomeThumb.png
|developers=ExampleDev1, ExampleDev2
|publisher= Example Publisher
|languages=English, Japanese, French
|developers= ExampleDev1, ExampleDev2
|capacity= 80 (40)
|platforms= PC, Android, iOS
|tags= tag1, tag2, tag3, tag4, tag5
|languages= English, Japanese, French
|id= wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|labs=Jan 1 2024
|published=Jan 1 2024
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>
<noinclude>[[Special:MyLanguage/Category:Template Documentation|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 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
Retrieved from "https://wiki.vrchat.com/index.php?title=Template:Infobox/World/doc&oldid=98918"