Log inGet started
World

Swatchbook: Material Library, Picker and Calibration Kit

README.md

materialCollection (asset type)

A materialCollection is one installable shelf of the materialLibraryKit material library: a collection.yaml that lists material assets and the tags that describe each one. The core (materialLibraryKit) discovers every collection in the world, on every peer, and merges their entries into the library that Materials.list, Materials.apply, the picker and the swatch gallery read. Installing a package that holds a collection is all a world does to get its materials into the library.

Folder shape

  • collection.yaml - the entries. Required.
  • README.md - what the collection holds. Required.
  • .metadata - tags for search. Required.

collection.yaml

title: "Metals"              # shown in the picker and gallery
version: "1.0.0"
materials:
  - id: brushedSteel         # unique library id (letters, digits, _ -)
    material: "~.materials.brushedSteel"  # identity, VFS path, or ~. (this package)
    name: "Brushed steel"
    category: metal          # free text, lower case
    kind: steel              # sub-kind inside the category
    style: realistic         # realistic | stylised | toon | pixel | scifi | fantasy
    tileSize: 1.0            # metres one texture repeat covers
    roughness: [0.25, 0.4]   # min, max (one number means min = max)
    metallic: [1, 1]
    textureKB: 2730          # optional: estimated GPU texture memory; measured when omitted
    animated: false
    tags: [brushed, anisotropic-look]
    description: "Satin steel sheet."

Any field but id, material, category and style may be left out; the core fills defaults (see the materialLibraryKit README). ~. means the package the collection file lives in, so a collection keeps working wherever its package is installed.