Skip to content

Descriptor keys

Open Markdown

All descriptor keys in one table. The Descriptor page explains them. A is an addon. P is a resource pack. S is a Shaderpack.

KeyForRequiredDefaultMeaning
formatA P SYesThe format of the descriptor: 1.
idA P SYesThe id. The folder name must be the same.
nameA P SYesThe name on the card.
versionA P SYesThe version: major, minor and patch, each of at most three digits (MMM.NNN.PPP).
authorA P SNoThe author on the card.
descriptionA P SNoA short description, at most 128 characters. The card shows the start of it; the player reads all of it when the pointer rests on it.
iconA P SNoA tile with a letterA PNG file in the package folder.
licenseA P SNoThe name of the licence.
game.minA P SYesThe oldest game build.
game.maxA P SNoNo limitThe newest game build.
viewpoint.minA P SNoThe oldest Viewpoint version.
viewpoint.maxA P SNoNo limitThe newest Viewpoint version.
sideANoclientclient or gameplay.
requiresA P SNoid or id@min, with commas between them.
conflictsA P SNoIds, with commas between them.
changelogA P SNoA file of ## <version> sections.
modelsA PNoThe path of a model manifest. Use version 2; version 1 is deprecated.
tilesA PNoA folder of tile PNG files.
soundsA PNoA folder of ogg and wav files.
dataA PNoA folder of data files.
apiAYesThe API version that you compiled against: 1.0.
jarAYesThe name of the jar.
entryAYesThe class that implements Addon.
settingsANoA settings.properties file.
permissionsANoNonehooks, files, downloads, lua, camera, combat, models, shaders, draw, vram.
hooks.targetsAWith hooksThe classes that the addon can hook: game classes and listed classes of Viewpoint.
files.quotaMiBANo64The size of the files folder, in MiB. More than 64 needs consent.
draw.gpuMiBANo64The video memory for the Gpu objects, in MiB, 1 or more. It needs draw. More than 128 needs the permission vram.
downloads.hostsAWith downloadsThe hosts that the addon can download from.
lua.globalsANoNames of Lua globals for the exports.
exportsANoJava packages that other addons can link to.
baseSNoThe libraryThe pack that the Shaderpack builds on.
dropOptionsSNoOptions of the base that the pack leaves out.
options, option.<id>.*SNoThe options of the pack.
presets, preset.<id>, preset.defaultSNoThe presets of the pack.
passes, pass.<id>.*, targets, target.<name>SNoThe passes and targets of the pack.
pipeline.<knob>SNoThe baseWhich passes of the renderer run.
librarySNoThe Viewpoint version that the pack was made for (planned).