Template:Infobox/World/doc: Difference between revisions

From VRChat Wiki
(refactored documentation to match parameter rework)
No edit summary
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>[[Category:Template Documentation]]</noinclude>
{{Infobox/World
{{Infobox/World
|name= Example World
|name= Example World
|image= VrcHomeThumb.png
|image= VrcHomeThumb.png
|publisher= Example Publisher
|author= Example Author
|developers= ExampleDev1, ExampleDev2
|developers= ExampleDev1, ExampleDev2
|capacity= 80 (40)
|capacity= 80 (40)
Line 8: Line 9:
|tags= tag1, tag2, tag3, tag4, tag5
|tags= tag1, tag2, tag3, tag4, tag5
|languages= English, Japanese, French
|languages= English, Japanese, French
|link= {{World link|wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd|VRChat Home}}
|id= wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|labs= Jan 1 2024
|labs= Jan 1 2024
|published= 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.
==Example==
 
Fields without contents will not show up on the infobox.
 
Usage:
 
<pre>
<pre>
<nowiki>{{</nowiki>Infobox/World
<nowiki>{{</nowiki>Infobox/World
|name=
|image=
|publisher=
|developers=
|capacity=
|platforms=
|tags=
|languages=
|link=
|labs=
|published=
<nowiki>}}</nowiki>
</pre>
==Parameters==
;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.
;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.
;link
: The link to the VRChat world. Consider using [[Template:World link]].
;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>
<nowiki>{{</nowiki>VRChat world
|name= Example World
|name= Example World
|image= VrcHomeThumb.png
|image= VrcHomeThumb.png
|publisher= Example Publisher
|author= Example Author
|developers= ExampleDev1, ExampleDev2
|developers= ExampleDev1, ExampleDev2
|capacity= 80 (40)
|capacity= 80 (40)
Line 76: Line 24:
|tags= tag1, tag2, tag3, tag4, tag5
|tags= tag1, tag2, tag3, tag4, tag5
|languages= English, Japanese, French
|languages= English, Japanese, French
|link={{World link|wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd|VRChat Home}}
|id= wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|labs=Jan 1 2024
|labs=Jan 1 2024
|published=Jan 1 2024
|published=Jan 1 2024
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>
<noinclude>[[Category:Template Documentation]]</noinclude>
==TemplateData Documentation==
<templatedata>
{
"params": {
"name": {
"label": "World Name",
"description": "The name of the VRChat world.",
"type": "string",
"required": true
},
"image": {
"label": "World Image",
"description": "The image used for the thumbnail of the world.",
"example": "thumbnail.webp",
"type": "wiki-file-name",
"required": true
},
"author": {
"label": "World Author",
"description": "The user who has the VRChat world published to their account.",
"example": "AuthorName",
"type": "string",
"required": true
},
"developers": {
"label": "Developers",
"description": "The main developer(s) of the VRChat world. This field is optional if the publisher is the sole developer.",
"example": "ExampleDev1, ExampleDev2",
"type": "string",
"suggested": true
},
"capacity": {
"label": "World Capacity",
"description": "The user capacity of the VRChat world, followed by its recommended capacity in parentheses.",
"example": "80 (40)",
"type": "number",
"suggested": true
},
"platforms": {
"label": "Platforms",
"description": "The platforms on which the VRChat world is available. PC, Android and/or iOS.",
"example": "PC, Android, iOS",
"suggested": true
},
"tags": {
"label": "Tags",
"description": "The tags of the VRChat world.",
"example": "tag1, tag2, tag3, tag4, tag5",
"type": "string",
"suggested": true
},
"languages": {
"label": "Available Languages",
"description": "Languages used or available inside the VRChat world.",
"example": "English, Japanese, French",
"type": "string",
"suggested": true
},
"id": {
"label": "World ID",
"description": "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",
"example": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
"type": "string",
"required": true
},
"labs": {
"label": "Community Labs publish date",
"description": "The date the VRChat world was published to Community Labs.",
"example": "Jan 1 2024",
"type": "date",
"suggested": true
},
"published": {
"label": "Publish Date",
"description": "The date the VRChat world was published/released from Community Labs.",
"example": "Jan 1 2024",
"type": "date",
"suggested": true
}
},
"description": "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.\n\nFields without contents will not show up on the Infobox.",
"paramOrder": [
"name",
"image",
"author",
"developers",
"capacity",
"platforms",
"tags",
"languages",
"id",
"labs",
"published"
]
}
</templatedata>

Latest revision as of 16:26, 9 April 2025

Example

{{Infobox/World
|name= Example World
|image= VrcHomeThumb.png
|author= Example Author
|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
}}

TemplateData Documentation

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. Fields without contents will not show up on the Infobox.

Template parameters

ParameterDescriptionTypeStatus
World Namename

The name of the VRChat world.

Stringrequired
World Imageimage

The image used for the thumbnail of the world.

Example
thumbnail.webp
Filerequired
World Authorauthor

The user who has the VRChat world published to their account.

Example
AuthorName
Stringrequired
Developersdevelopers

The main developer(s) of the VRChat world. This field is optional if the publisher is the sole developer.

Example
ExampleDev1, ExampleDev2
Stringsuggested
World Capacitycapacity

The user capacity of the VRChat world, followed by its recommended capacity in parentheses.

Example
80 (40)
Numbersuggested
Platformsplatforms

The platforms on which the VRChat world is available. PC, Android and/or iOS.

Example
PC, Android, iOS
Unknownsuggested
Tagstags

The tags of the VRChat world.

Example
tag1, tag2, tag3, tag4, tag5
Stringsuggested
Available Languageslanguages

Languages used or available inside the VRChat world.

Example
English, Japanese, French
Stringsuggested
World IDid

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

Example
wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
Stringrequired
Community Labs publish datelabs

The date the VRChat world was published to Community Labs.

Example
Jan 1 2024
Datesuggested
Publish Datepublished

The date the VRChat world was published/released from Community Labs.

Example
Jan 1 2024
Datesuggested
Retrieved from "https://wiki.vrchat.com/index.php?title=Template:Infobox/World/doc&oldid=29210"