Template:Infobox/World/doc: Difference between revisions

Latest revision as of 23:46, 17 October 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
}}

/* Neccessary for templatedata for visual editor */

Infobox used for world pages

Template parameters
Parameter		Description	Type	Status
World Name	`name`	The name of the VRChat world.	String	required
World Image	`image`	The image used for the thumbnail of the world. Example thumbnail.webp	File	required
World Author	`author`	The user who has the VRChat world published to their account. Example AuthorName	String	required
Developers	`developers`	The main developer(s) of the VRChat world. This field is optional if the publisher is the sole developer. Example ExampleDev1, ExampleDev2	String	suggested
World Capacity	`capacity`	The user capacity of the VRChat world, followed by its recommended capacity in parentheses. Example 80 (40)	Number	suggested
Platforms	`platforms`	The platforms on which the VRChat world is available. PC, Android and/or iOS. Example PC, Android, iOS	Unknown	suggested
Tags	`tags`	The tags of the VRChat world. Example tag1, tag2, tag3, tag4, tag5	String	suggested
Available Languages	`languages`	Languages used or available inside the VRChat world. Example English, Japanese, French	String	suggested
World ID	`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 Example wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd	String	required
Community Labs publish date	`labs`	The date the VRChat world was published to Community Labs. Example Jan 1 2024	Date	suggested
Publish Date	`published`	The date the VRChat world was published/released from Community Labs. Example Jan 1 2024	Date	suggested

@@ 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>
+/* Neccessary for templatedata for visual editor */
+<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": "Infobox used for world pages",
+	"paramOrder": [
+		"name",
+		"image",
+		"author",
+		"developers",
+		"capacity",
+		"platforms",
+		"tags",
+		"languages",
+		"id",
+		"labs",
+		"published"
+	]
+}
+</templatedata>

Anonymous

Search

Template:Infobox/World/doc: Difference between revisions

Namespaces

More

Page actions

Latest revision as of 23:46, 17 October 2024

Parameters

Example

Navigation

Navigation

Official Links

Official Guides

Community Content

Wiki tools

Wiki tools

Anonymous

Search

Template:Infobox/World/doc: Difference between revisions

Latest revision as of 23:46, 17 October 2024

Parameters

Example

Navigation

Wiki tools

Page tools

Categories