Template:Infobox/World/doc: Difference between revisions

From VRChat Wiki
(new example)
(changed "publisher" to "author")
(11 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{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.
Fields without contents will not show up on the infobox.


Usage:
Usage:


<pre>
<pre>
<nowiki>{{</nowiki>World
<nowiki>{{</nowiki>Infobox/World
|name=
|name=
|image=
|image=
|imagecaption=
|author=
|developer=
|developers=
|publisher=
|capacity=
|designer=
|platforms=
|gen=
|tags=
|platform=
|languages=
|themes=
|id=
|link=
|labs=
|labs=
|published=
|published=
Line 27: Line 35:


==Parameters==
==Parameters==
;name
<nowiki>*</nowiki> = Mandatory
 
;name*
: The name of the VRChat world.
: The name of the VRChat world.


;image
;image*
: An image representing the world.
: The image used for the thumbnail of the world.
 
;imagecaption
: A caption for the image.


;developer
;author*
: The developer of the VRChat world.
: The user who has the VRChat world published to their account.


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


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


;gen
;platforms
: The generation of the VRChat world.
: The platforms on which the VRChat world is available. PC, Android and/or iOS.


;platform
;tags
: The platforms on which the VRChat world is available.
: The tags of the VRChat world.


;themes
;languages
: The themes of the VRChat world.
: Languages used or available inside the VRChat world.


;link
;id*
: The link to the VRChat world. Consider using [[Template:World link]].
: 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
;labs
: Indicates if the world is part of the Community Labs.
: The date the VRChat world was published to Community Labs.


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


==Example==
==Example==
<pre>
<pre>
<nowiki>{{</nowiki>VRChat world
<nowiki>{{</nowiki>Infobox/World
|name=Example World
|name= Example World
|image=ExampleImage.jpg
|image= VrcHomeThumb.png
|imagecaption=An example VRChat world
|author= Example Author
|developer=Example Developer
|developers= ExampleDev1, ExampleDev2
|publisher=Example Publisher
|capacity= 80 (40)
|designer=Example Designer
|platforms= PC, Android, iOS
|gen=1st Generation
|tags= tag1, tag2, tag3, tag4, tag5
|platform=PC, VR
|languages= English, Japanese, French
|themes=Adventure, Exploration
|id= wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd
|link=https://vrchat.com/home/world/wrld_example
|labs=Jan 1 2024
|labs=Yes
|published=Jan 1 2024
|published=2024-01-01
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>
<noinclude>[[Category:Template Documentation]]</noinclude>
<noinclude>[[Category:Template Documentation]]</noinclude>

Revision as of 13:22, 24 August 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.

Fields without contents will not show up on the infobox.

Usage:

{{Infobox/World
|name=
|image=
|author=
|developers=
|capacity=
|platforms=
|tags=
|languages=
|id=
|labs=
|published=
}}

Parameters

* = Mandatory

name*
The name of the VRChat world.
image*
The image used for the thumbnail of the world.
author*
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

{{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
}}