Template:Infobox/World/doc: Difference between revisions

From VRChat Wiki
(added documentation by maebbie to proper page)
No edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>[[Category:Template Documentation]]</noinclude>
{{Infobox/World
{{Infobox/World
|name=Treehouse in the Shade
|name= Example World
|developer=1001
|image= VrcHomeThumb.png
|platform= PC
|author= Example Author
|link={{World link|wrld_551c30cb-0e56-4c69-9176-10e259a89e2a|Treehouse in the Shade}}
|developers= ExampleDev1, ExampleDev2
|published=Nov 09 2018
|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.
==Example==
 
Fields without contents will not show up on the infobox.
 
Usage:
 
<pre>
<pre>
<nowiki>{{</nowiki>Infobox/World
<nowiki>{{</nowiki>Infobox/World
|name=
|name= Example World
|image=
|image= VrcHomeThumb.png
|imagecaption=
|author= Example Author
|developer=
|developers= ExampleDev1, ExampleDev2
|publisher=
|capacity= 80 (40)
|designer=
|platforms= PC, Android, iOS
|gen=
|tags= tag1, tag2, tag3, tag4, tag5
|platform=
|languages= English, Japanese, French
|languages=
|id= wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|themes=
|labs=Jan 1 2024
|link=
|published=Jan 1 2024
|labs=
|published=
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>
 
==TemplateData Documentation==
==Parameters==
<templatedata>
;name
{
: The name of the VRChat world.
"params": {
 
"name": {
;image
"label": "World Name",
: An image representing the world.
"description": "The name of the VRChat world.",
 
"type": "string",
;imagecaption
"required": true
: A caption for the image.
},
 
"image": {
;developer
"label": "World Image",
: The developer of the VRChat world.
"description": "The image used for the thumbnail of the world.",
 
"example": "thumbnail.webp",
;publisher
"type": "wiki-file-name",
: The publisher of the VRChat world.
"required": true
 
},
;designer
"author": {
: The designer of the VRChat world.
"label": "World Author",
 
"description": "The user who has the VRChat world published to their account.",
;gen
"example": "AuthorName",
: The generation of the VRChat world.
"type": "string",
 
"required": true
;platform
},
: The platforms on which the VRChat world is available.
"developers": {
 
"label": "Developers",
;languages
"description": "The main developer(s) of the VRChat world. This field is optional if the publisher is the sole developer.",
: Languages used or available inside the VRChat world.
"example": "ExampleDev1, ExampleDev2",
 
"type": "string",
;themes
"suggested": true
: The themes of the VRChat world.
},
 
"capacity": {
;link
"label": "World Capacity",
: The link to the VRChat world. Consider using [[Template:World link]].
"description": "The user capacity of the VRChat world, followed by its recommended capacity in parentheses.",
 
"example": "80 (40)",
;labs
"type": "number",
: Indicates if the world is part of the Community Labs.
"suggested": true
 
},
;published
"platforms": {
: The date when the VRChat world was published.
"label": "Platforms",
 
"description": "The platforms on which the VRChat world is available. PC, Android and/or iOS.",
==Example==
"example": "PC, Android, iOS",
<pre>
"suggested": true
<nowiki>{{</nowiki>VRChat world
},
|name=Example World
"tags": {
|image=ExampleImage.jpg
"label": "Tags",
|imagecaption=An example VRChat world
"description": "The tags of the VRChat world.",
|developer=Example Developer
"example": "tag1, tag2, tag3, tag4, tag5",
|publisher=Example Publisher
"type": "string",
|designer=Example Designer
"suggested": true
|gen=1st Generation
},
|platform=PC, VR
"languages": {
|languages=English, Spanish
"label": "Available Languages",
|themes=Adventure, Exploration
"description": "Languages used or available inside the VRChat world.",
|link=https://vrchat.com/home/world/wrld_example
"example": "English, Japanese, French",
|labs=Yes
"type": "string",
|published=2024-01-01
"suggested": true
<nowiki>}}</nowiki>
},
</pre>
"id": {
<noinclude>[[Category:Template Documentation]]</noinclude>
"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"