Steam Workshop
Publish your mods to Steam Workshop for easy distribution. Players can subscribe to mods and they're automatically downloaded and loaded.
Uploading
- Open the in-game Mods menu
- Find your local mod in the list
- Click Upload to Workshop
- Add a change note describing your mod
- 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"]
}| Field | Description |
|---|---|
cover | Path to a preview image (shown on Workshop) |
tags | Array of tags for Workshop categorization |
Updating
To update a published mod:
- Make your changes locally
- Bump the
versioninmanifest.json - Rebuild your mod
- Go to Mods menu, click Upload to Workshop on the same mod
- Add a change note describing what's new
- Click Update
Subscribing
Players can browse and subscribe to mods:
- Open the in-game Mods menu
- Click Steam Workshop
- Browse subscribed items or open the Workshop in Steam
- 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.
