Template:Infobox/World/doc: Difference between revisions

From VRChat Wiki
(Created page with "== Documentation == This is an infobox to be used for VRChat worlds. === Example Usage === <nowiki>{{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/user/8JoV9XEdpo vrchat]|Cross-Platform|335m~|113k~|16|8|Sep 30 2022|CW=VRRat Presence|link=https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd}}</nowiki> will make the infobox to the right of this page. {{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/us...")
 
(changed "publisher" to "author")
 
(17 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Documentation ==
{{Infobox/World
This is an infobox to be used for VRChat worlds.
|name= Example World
=== Example Usage ===
|image= VrcHomeThumb.png
<nowiki>{{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/user/8JoV9XEdpo vrchat]|Cross-Platform|335m~|113k~|16|8|Sep 30 2022|CW=VRRat Presence|link=https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd}}</nowiki>
|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
}}
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.


will make the infobox to the right of this page.
Fields without contents will not show up on the infobox.
{{Infobox/World|VRChat Home|Worldplaceholder.webp|[https://vrchat.com/home/user/8JoV9XEdpo vrchat]|Cross-Platform|335m~|113k~|16|8|Sep 30 2022|CW=VRRat Presence|link=https://vrchat.com/home/world/wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd}}


=== Template parameters ===
Usage:
{| class="wikitable"
 
|+ Parameters
<pre>
|-
<nowiki>{{</nowiki>Infobox/World
! Name !! Variable !! Description
|name=
|-
|image=
| World Name || <code>1</code>|| Name of the world on VRChat
|author=
|-
|developers=
| Thumbnail || <code>2</code> || Thumbnail of the world (should be 256x192)
|capacity=
|-
|platforms=
| Creator || <code>3</code> || Creator, often should link to the creator's user page if possible.
|tags=
|-
|languages=
| Platforms || <code>4</code> || Which platforms the world is available on.
|id=
|-
|labs=
| Visits || <code>5</code> || Roughly the number of visits.
|published=
|-
<nowiki>}}</nowiki>
| Favorites || <code>6</code> || Roughly the number of favorites.
</pre>
|-
 
| Max Capacity || <code>7</code> || Max that it can stretch to for extra friends.
==Parameters==
|-
<nowiki>*</nowiki> = Mandatory
| Base Capacity || <code>8</code> || Max amount of users that can fit.
 
|-
;name*
| Published || <code>9</code> || When the world was originally published. (ex: Sep 30 2022)
: The name of the VRChat world.
|-
 
| Content Warnings || <code>CW=</code> || Content labels a world has. ''(Optional)''
;image*
|-
: The image used for the thumbnail of the world.
| Link to world || <code>link=</code> || Link to the world. ''(Optional)''
 
|}
;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==
<pre>
<nowiki>{{</nowiki>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
<nowiki>}}</nowiki>
</pre>
<noinclude>[[Category:Template Documentation]]</noinclude>

Latest 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
}}
Retrieved from "https://wiki.vrchat.com/index.php?title=Template:Infobox/World/doc&oldid=5423"