NotiVR Docs

Workshop Publishing

Upload a pack to Steam Workshop and push updates from the CLI

After building your pack and testing locally, you can publish your work to the Steam Workshop using our command line tool.

Before You Publish

Make sure your pack already works locally before uploading it:

  • Your pack folder contains pack.json at its root
  • All icons and sounds load correctly in NotiVR
  • There are no extra files other than the pack.json, your icons and sounds

By uploading your pack to the Workshop, you are confirming that the assets you are using are either your own or you have permission from the original creator to use them in your pack.

Uploading copyrighted material without permission may result in your pack being removed from the Workshop.

Workshop Packaging Rules

Workshop items must be packaged with pack.json at the uploaded folder root:

my-pack/
  pack.json
  icons/
  sounds/

Do not upload a nested layout like this:

my-upload/
  my-pack/
    pack.json

NotiVR ignores Workshop items that do not have pack.json in the pack folder.

Uploading a New Pack

NotiVR includes a CLI tool called NotiWorkshopTool for Workshop publishing.

To upload your pack, simply drag your pack folder onto the NotiWorkshopTool.exe file in the NotiVR installation folder.

If you have dragged a valid pack folder, the tool will ask you if you want to create a new Workshop item or update an existing one.

Your pack won't be publicly visible after uploading. You will need to go to the Steam Workshop and make it public, along with adding a description and images.

Updating an Existing Pack

Same as uploading a new pack, simply drag your pack folder onto the NotiWorkshopTool.exe file in the NotiVR installation folder.

Then select 'Update an existing pack' and choose the Workshop item you want to update.

Notes About Workshop IDs

During local development you would have created a local pack folder with an id like my-pack.

This ID is only used for development, when a user downloads your pack from the Workshop your pack's ID will be the Steam Workshop item ID.

On this page