Skip to content

Steam Workshop

Publish your mods to Steam Workshop for easy distribution. Players can subscribe to mods and they're automatically downloaded and loaded.

Uploading

  1. Open the in-game Mods menu
  2. Find your local mod in the list
  3. Click Upload to Workshop
  4. Add a change note describing your mod
  5. Click Upload

The game automatically uses your manifest.json metadata:

  • Title from name
  • Description from description
  • Preview image from cover
  • Tags from tags

Manifest Fields

Add Workshop-related fields to your manifest.json:

json
{
    "id": "my-mod",
    "name": "My Awesome Mod",
    "version": "1.0.0",
    "author": "YourName",
    "description": "An awesome mod for HackHub",
    "apiVersion": 1,
    "permissions": ["events", "network"],
    "cover": "cover.png",
    "tags": ["quest", "network", "story"]
}
FieldDescription
coverPath to a preview image (shown on Workshop)
tagsArray of tags for Workshop categorization

Updating

To update a published mod:

  1. Make your changes locally
  2. Bump the version in manifest.json
  3. Rebuild your mod
  4. Go to Mods menu, click Upload to Workshop on the same mod
  5. Add a change note describing what's new
  6. Click Update

Subscribing

Players can browse and subscribe to mods:

  1. Open the in-game Mods menu
  2. Click Steam Workshop
  3. Browse subscribed items or open the Workshop in Steam
  4. Subscribe to mods -- they're automatically downloaded and loaded on next game start

Priority

If a local mod and a Workshop mod share the same id, the local mod takes priority. This allows mod authors to test changes locally before publishing.

Cover Image

Use a 16:9 image (e.g. 1920x1080) for best results on the Workshop page. PNG or JPG format.

HotBunny Interactive Entertainment Inc.