asset.json

An overview of what the asset.json file is and how to create one

What is it?

An asset.json file represents the metadata seeker uses and generates when you sync and manage assets. What you're really editing is the metadata about the asset. All asset management stays the same, seeker simply wraps around your existing storage medium.

An asset.json file is created when you ingest an asset into seeker by syncing the storage point. This also automatically happens every hour but you can manually sync at any time.

Asset.json Schema

export interface AssetJSON {
  // Is this asset archived. Archived assets are still ingested
  archived?: boolean;
  // A list of key/value pairs that make up attributes of an asset. This can be anything.
  attributes?: {
    [key: string]: any;
  };
  // An array of strings indicating the path this asset should be under 3D, Models, Food
  category: string[];
  // A string list of collection names this asset should belong to. If it doesn't exist it will be created.
  collections?: string[];
  // The original creator of the asset (For attribution)
  creator: string;
  // A Description of the asset for users
  description: string;
  //A  collection of relative paths to gallery images or videos
  gallery?: string[];
  // A UUID of the asset in the database
  id?: UUID;
  // The name of the asset to be shown to users and searched for
  name: string;
  // An array of strings indicating tags to be used on the asset: chicken, brown, low poly
  tags: string[];
}

Asset.json Example

{
  "name": "Donut",
  "tags": ["round", "sprinkles", "food"],
  "category": ["3D Assets", "Food", "Desserts"],
  "collections": [
    "Party and Celebration",
    "Desserts and Sweets",
    "Bakery Items"
  ],
  "description": "Classic sprinkle donut",
  "creator": "Seeker Inc.",
  "attributes": {
    "color": "#FFF",
    "flavor": "vanilla",
    "width": 5,
    "length": 5,
    "height": 1.5,
    "deprecated": false
  },
  "gallery": ["media/turntable.mp4", "media/beauty.png"]
}