NotiVR Docs

Examples

Complete pack examples and Steam Workshop info

Minimal Example

The simplest possible pack with one icon:

my-pack/
  pack.json
  icons/
    discord.png
{
  "SchemaVersion": 1,
  "Name": "Discord Icon",
  "Author": "Me",
  "Description": "",
  "Version": "1.0.0",
  "Icons": [
    {
      "Android": "com.discord",
      "iOS": "com.hammerandchisel.discord",
      "PNG": "icons/discord.png"
    }
  ],
  "Sounds": {}
}

Sound-Only Example

A pack that only provides notification sounds:

my-sounds/
  pack.json
  sounds/
    ping.ogg
    bloop.ogg
{
  "SchemaVersion": 1,
  "Name": "Custom Sounds",
  "Author": "Me",
  "Description": "Fun notification sounds",
  "Version": "1.0.0",
  "Icons": [],
  "Sounds": {
    "ping": {
      "Name": "Ping",
      "Ogg": "sounds/ping.ogg",
      "Android": ["com.discord", "com.slack"],
      "iOS": ["com.hammerandchisel.discord"]
    },
    "bloop": {
      "Name": "Bloop",
      "Ogg": "sounds/bloop.ogg",
      "Android": [],
      "iOS": []
    }
  }
}

Sounds with empty Android/iOS arrays won't auto-assign to any app, but users can still manually pick them in the sound settings.

Steam Workshop

Steam Workshop integration is not yet fully implemented. NotiVR can detect your subscribed Workshop items, but does not yet load them as packs. Workshop packs will use the same pack.json format described above. Once implemented, subscribing to a pack on the Workshop will automatically install and load it without needing to manually copy files.

For now, packs must be installed manually by copying the folder into assets/packs/.

On this page