Template:Infobox/Asset/doc: Difference between revisions

From VRChat Wiki
Patroll (talk | contribs)
Add TemplateData
 
Hackebein (talk | contribs)
add docs for license
Line 1: Line 1:
<noinclude>[[Category:Template Documentation]]</noinclude>
<noinclude>[[Category:Template Documentation]]</noinclude>
{{Infobox/Asset
{{Infobox/Asset
|name=Cyan Trigger
|name=MyC00l VRChat Asset
|image=[[File:CyanTrigger.png]]
|image=[[File:CyanTrigger.png]]
|youtube=xRha7-qE1vg
|youtube=xRha7-qE1vg
|author=cyanlaser
|author=VRChat
|author_1=VRRat
|author_1=VRRat
|author_2=VRCat
|author_2=VRCat
|documentation=https://protv.dev/
|documentation=https://docs.vrchat.com
|github=CyanLaser/CyanTrigger
|license=Proprietary
|gitlab=techanon/protv
|vpm=https://vrchat.github.io/packages/index.json
|booth=3194594
|booth=123456
|gumroad=protv
|gumroad=vrchat
|vpm=https://cyanlaser.github.io/CyanTrigger}}
|github=vrchat/packages
|gitlab=vrchat/packages}}
==TemplateData Documentation==
==TemplateData Documentation==
<templatedata>
<templatedata>
{
{
"params": {
"params": {
"name": {
"label": "Name",
"example": "My Asset Name",
"type": "string",
"required": true
},
"image": {
"label": "Image",
"example": "CyanTrigger.png",
"type": "wiki-file-name",
"required": true
},
"youtube": {
"youtube": {
"label": "YouTube",
"label": "YouTube",
"description": "YouTube video ID",
"description": "YouTube video ID",
"example": "xRha7-qE1vg",
"example": "xRha7-qE1vg",
"type": "string"
},
"author": {
"label": "Author",
"example": "VRChat",
"type": "string"
"type": "string"
},
},
Line 26: Line 44:
"label": "Author 1",
"label": "Author 1",
"example": "VRRat",
"example": "VRRat",
"type": "string"
},
"author": {
"label": "Author",
"example": "cyanlaser",
"type": "string"
"type": "string"
},
},
Line 41: Line 54:
"label": "Author 3",
"label": "Author 3",
"example": "VRBat",
"example": "VRBat",
"type": "string"
},
"documentation": {
"label": "documentation",
"description": "Documentation URL",
"example": "https://docs.vrchat.com/",
"type": "url"
},
"license": {
"label": "License",
"description": "License of the Package",
"example": "MIT",
"type": "string"
"type": "string"
},
},
Line 46: Line 71:
"label": "VPM",
"label": "VPM",
"description": "VRChat Package Manager URL",
"description": "VRChat Package Manager URL",
"example": "https://cyanlaser.github.io/CyanTrigger",
"example": "https://packages.vrchat.com/official?download",
"type": "url"
"type": "url"
},
},
Line 52: Line 77:
"label": "Booth ID",
"label": "Booth ID",
"description": "Booth ID",
"description": "Booth ID",
"example": "3194594",
"example": "1234567",
"type": "string"
"type": "string"
},
},
Line 58: Line 83:
"label": "Gumroad",
"label": "Gumroad",
"description": "Gumroad ID",
"description": "Gumroad ID",
"example": "protv",
"example": "vrchat",
"type": "string"
"type": "string"
},
},
Line 64: Line 89:
"label": "GitHub",
"label": "GitHub",
"description": "GitHub <user>/<repo>",
"description": "GitHub <user>/<repo>",
"example": "CyanLaser/CyanTrigger",
"example": "vrchat/packages",
"type": "string"
"type": "string"
},
},
Line 70: Line 95:
"label": "GitLab",
"label": "GitLab",
"description": "GitLab <user>/<repo>",
"description": "GitLab <user>/<repo>",
"example": "techanon/protv",
"example": "vrchat/packages",
"type": "string"
"type": "string"
},
"name": {
"label": "Name",
"example": "Cyan Trigger",
"type": "string",
"required": true
},
"image": {
"label": "Image",
"example": "CyanTrigger.png",
"type": "wiki-file-name",
"required": true
},
"documentation": {
"label": "documentation",
"description": "Documentation URL",
"example": "https://protv.dev/",
"type": "url"
}
}
},
},
Line 101: Line 108:
"author_3",
"author_3",
"documentation",
"documentation",
        "license",
"vpm",
"vpm",
"booth",
"booth",

Revision as of 17:26, 25 May 2025

TemplateData Documentation

No description.

Template parameters

ParameterDescriptionTypeStatus
Namename

no description

Example
My Asset Name
Stringrequired
Imageimage

no description

Example
CyanTrigger.png
Filerequired
YouTubeyoutube

YouTube video ID

Example
xRha7-qE1vg
Stringoptional
Authorauthor

no description

Example
VRChat
Stringoptional
Author 1author_1

no description

Example
VRRat
Stringoptional
Author 2author_2

no description

Example
VRCat
Stringoptional
Author 3author_3

no description

Example
VRBat
Stringoptional
documentationdocumentation

Documentation URL

Example
https://docs.vrchat.com/
URLoptional
Licenselicense

License of the Package

Example
MIT
Stringoptional
VPMvpm

VRChat Package Manager URL

Example
https://packages.vrchat.com/official?download
URLoptional
Booth IDbooth

Booth ID

Example
1234567
Stringoptional
Gumroadgumroad

Gumroad ID

Example
vrchat
Stringoptional
GitHubgithub

GitHub <user>/<repo>

Example
vrchat/packages
Stringoptional
GitLabgitlab

GitLab <user>/<repo>

Example
vrchat/packages
Stringoptional