package.json

A package manifest file is similar to Unity's UPM package manifest specification or NPM's package.json.

As far as I know, no one has yet to define a standard for audio packs similar to standard for each individual audio's metadata tagging like Universal Category System (UCS). Therefore we need our own format here.

{
  "id": "OFP001",
  "name": "@modular-footstep/ofp001",
  "displayName": "House Soil",
  "description": "Soil in my garden. They are quite dry with light grass and dry leaves.",
  "version": "1.0.0",
  "homepage": "https://exceed7.com/modular-footstep",
  "gears": [
    "Zoom H4n"
  ],
  "image": "Images~/image1.jpg",
  "author": {
    "name": "Sirawat Pitaksarit / 5argon",
    "email": "5argon@exceed7.com",
    "url": "https://5argon.info"
  }
}

• id (required) : ID string of your pack. Files in your pack may not know the pack's full name but they belongs to this ID. Can't change once released, and can't be a duplicate, therefore better use abstract serially running number is a good idea so there is no reason to change.
• name : Following standard package naming practice, it should be scoped. The name also cannot contain capital letter or spaces. We should just use the id in lower characters.
• displayName : What nicer pack name you would like to display. Can use the same name as previous packs as long as the id is new.
• description : Longer text describing your pack.
• version : Bump this Semantic Versioning the same way as you would do to the code. Rightmost number bump when editing file name. Middle number when you added new clips. Leftmost is considered breaking change when you tinker with released clips (such as EQ out or changing dynamics, you fear that this update will make some unhappy). And of course if you deleted clip files from the pack.
• homepage : You can add a representative link so others can learn more about you or find other packs.
• gears : An array of strings where each one is a notable gear you would like to mention, particularly if it determines the quality or style of your recordings.
• images : Photo worth a lot for footsteps since you can roughly imagine the sounds without listening to everything. Put a path to image files that should represent your pack such as recording locations. They should be inside Images~ folder so Unity skips importing them.
• author : An object with name and optionally email or url. Like NPM, if you use contributors instead you can attribute multiple people. Perhaps field recordist and the audio editor is not the same person.