Grimwar/Steam Workshop addons

Overview · Getting started · SDK setup · Maps · Custom content · Entities · VSig · VMod · Workshop · Addons · Servers · Help

Publish from Grimwar's Addons screen after building and testing a Release package. The game uploads the declared content and records its Workshop identity. Keep your editable source separately for future updates.

Prepare the package

1. Test a Preview map or Development resource package locally.
2. Keep a stable add-on ID. For a Vertex map, this comes from the map filename.
3. Supply readable 1920 × 1080 artwork. For maps, use Map → Thumbnail with a PNG or JPEG. For media packs, choose a PNG in Content. For standalone VMods, set a relative PNG path in mod.json.thumbnail.
4. Build Release. Map builds require Windows client, macOS client, and Linux dedicated-server artifacts.
5. Install the complete output folder and select the intended copy in Addons.
6. Publish any required media packs first and confirm their Workshop items are available to the intended players.

Vertex uses the selected map image for both the map and add-on thumbnail. A map can compile without artwork, but publishing requires it; the publishing flow can supply missing artwork. Keep the image with your source when you want later builds to retain it.

Publish a new item

1. Launch Grimwar through the Steam account that will own the item.
2. In Addons, select the local package and choose Publish / Update.
3. Choose Map, VMod, or Content as appropriate. Review the content listed in the dialog.
4. Enter the title, description, change note, and visibility. New items default to Private.
5. Review the Workshop terms and submit. After item submission begins, Steam cannot cancel the upload.
6. If Steam requires its contributor agreement, open the linked agreement or item page and accept it.
7. Inspect the uploaded item, then test the subscribed copy before making it public.

Type	What it uploads
Map	Map artifacts and images, attached script snapshots, and declared VMod/audio/media content in the package.
VMod	Declared VMod manifests and C# source, plus audio/media. Use Map for a package that also contains a map.
Content	Reusable audio and media. Map and standalone VMod entries are omitted.

Clients can receive VMod source, but only servers execute it. Do not put secrets in source or configuration you publish. The uploader stages declared files and leaves the source package unchanged.

Required packages

A dependency names the provider's add-on ID, such as shared_sounds. In Content, Use this package records that requirement. A VMod can also declare it in mod.json.requires.

Grimwar resolves each requirement to its Workshop item and records the Workshop dependency. An unresolved provider stops the upload. Publish providers before consumers, and give every required item suitable visibility.

There are three different identities:

Identity	Purpose
Add-on ID	Stable package name used for updates, dependencies, and selecting copies.
Workshop item ID	Steam's numeric identifier for downloading that item.
Build ID	Generated identifier for one exact package build. Clients and servers must agree on it.

A Vertex map also has a playable map ID, normally the same readable name as its add-on ID. Keep these authored names stable. The SDK generates a fresh build ID; do not hand-edit it.

Update an existing item

1. Edit the source and build another Release with the same add-on ID.
2. Launch with the Steam account that owns the item.
3. Select the new local package using Use This Copy.
4. Choose Publish / Update, add a change note, and submit.
5. Wait for upload and subscribed-copy refresh, then test that Workshop copy.

The account and add-on ID identify the existing publication. A different ID creates a different add-on. Keep published asset keys stable when updating a shared pack, or update and rebuild its consumers too.

Visibility and hosting access

The least-public required item limits the session:

Workshop visibility	Hosting access
Private	Local only.
Friends Only	Local, Friends Only, and Invite Only.
Public or Unlisted	All Host access modes, subject to the other required content.

Guest hosting remains unavailable while the contributor agreement is unaccepted or required content has no usable Workshop source. Changing a map's visibility does not change its dependencies' visibility.

Install and host

Players can subscribe through Grimwar Workshop. Wait for installation, enable the package in Addons, and select the desired copy. When joining a server, the game acquires the active map and other required client content and checks the exact build.

Dedicated servers can acquire maps, VMods, and media directly from Workshop. Use server-addons.json as described in Dedicated servers. A VMod does not need a manual binding merely because it contains code. Manually staged server copies must match the corresponding Workshop add-on and build IDs.