NotiVR Docs

pack.json Reference

Complete reference for the pack manifest file

Every pack needs a pack.json file in its root directory. Here's a complete example:

{
  "SchemaVersion": 1,
  "Name": "My Custom Pack",
  "Author": "Your Name",
  "Description": "Custom icons and sounds for my favorite apps",
  "Version": "1.0.0",
  "Icons": [
    {
      "Android": "com.discord",
      "iOS": "com.hammerandchisel.discord",
      "PNG": "icons/discord.png"
    },
    {
      "Android": "com.google.android.gm",
      "iOS": "com.apple.mobilemail",
      "iOSCategory": "Email",
      "PNG": "icons/mail.png"
    }
  ],
  "Sounds": {
    "ding": {
      "Name": "Ding",
      "Ogg": "sounds/ding.ogg",
      "Android": ["com.discord", "com.slack"],
      "iOS": ["com.hammerandchisel.discord", "com.tinyspeck.chatlyio"]
    },
    "chime": {
      "Name": "Soft Chime",
      "Ogg": "sounds/chime.ogg",
      "Android": ["com.google.android.gm"],
      "iOS": ["com.apple.mobilemail"]
    }
  }
}

Fields

FieldRequiredDescription
SchemaVersionYesMust be 1
NameYesDisplay name shown in the NotiVR settings UI
AuthorYesWho made the pack
DescriptionYesShort description (can be empty "")
VersionYesVersion string (e.g. "1.0.0")
IconsYesArray of icon entries (can be empty [])
SoundsYesObject of sound entries (can be empty {})

On this page