Template:Infobox/Asset/VPM/doc: Difference between revisions

From VRChat Wiki
Hackebein (talk | contribs)
Created page with "<noinclude>Category:Template Documentation</noinclude> {{Infobox/Asset/VPM |name=com.vrchat.worlds |version=Latest version}} ==TemplateData Documentation== <templatedata> { "params": { "name": { "label": "Name", "example": "com.vrchat.world", "description": "Package name", "type": "string", "required": true }, "version": { "label": "Version", "example": "3.8.1", "description": "semver or \"Latest version\"", "type":..."
 
Hackebein (talk | contribs)
Line 20: Line 20:
"type": "string",
"type": "string",
"required": true
"required": true
},
"title": {
"label": "Title",
            "description": "Overwrites Title. Default format `<name> v<version>`",
"type": "string"
},
"displayName": {
"label": "Displayname",
            "description": "Overwrites Displayname. ",
"type": "string"
},
},
"image": {
"image": {
Line 72: Line 62:
"description": "Documentation URL",
"description": "Documentation URL",
"example": "https://docs.vrchat.com/",
"example": "https://docs.vrchat.com/",
"type": "url"
},
"license": {
"label": "License",
"description": "License of the Package",
"example": "MIT",
"type": "string"
},
"vpm": {
"label": "VPM",
"description": "VRChat Package Manager URL",
"example": "https://packages.vrchat.com/official?download",
"type": "url"
"type": "url"
},
},
Line 109: Line 87:
"example": "vrchat/packages",
"example": "vrchat/packages",
"type": "string"
"type": "string"
},
"title": {
"label": "Title",
            "description": "Overwrites Title. Default format `<name> v<version>`",
"type": "string"
},
"displayName": {
"label": "Displayname",
            "description": "Overwrites Displayname. ",
"type": "string"
},
"license": {
"label": "License",
"description": "Overwrites License.",
"example": "MIT",
"type": "string"
},
"vpm": {
"label": "VPM",
"description": "Overwrites VPM URL",
"example": "https://packages.vrchat.com/official?download",
"type": "url"
}
}
},
},
Line 114: Line 114:
"name",
"name",
         "version",
         "version",
        "title",
        "displayName",
"image",
"image",
"youtube",
"youtube",
Line 124: Line 122:
"status",
"status",
"documentation",
"documentation",
"license",
"vpm",
"booth",
"booth",
"gumroad",
"gumroad",
"github",
"github",
"gitlab"
"gitlab",
        "title",
        "displayName",
"license",
"vpm"
]
]
}
}
</templatedata>
</templatedata>

Revision as of 03:46, 29 May 2025


TemplateData Documentation

No description.

Template parameters

ParameterDescriptionTypeStatus
Namename

Package name

Example
com.vrchat.world
Stringrequired
Versionversion

semver or "Latest version"

Example
3.8.1
Stringrequired
Imageimage

no description

Example
Placeholder.webp
Fileoptional
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
Statusstatus

Status of the Asset, any of `maintained`, `maintenance`, `deprecated`, `abandoned`, `archived`, `unknown`, or custom text. Custom text can't be translated.

Example
maintained
Stringoptional
documentationdocumentation

Documentation URL

Example
https://docs.vrchat.com/
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
Titletitle

Overwrites Title. Default format `<name> v<version>`

Stringoptional
DisplaynamedisplayName

Overwrites Displayname.

Stringoptional
Licenselicense

Overwrites License.

Example
MIT
Stringoptional
VPMvpm

Overwrites VPM URL

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