This is a quick guide for setting up Workshop Maps for Team Fortress 2 Dedicated Servers.

It will have an extra focus on using Workshop maps with SourceMod and its map voting plugins.

I have been in contact with Valve's John S. about various Map Workshop bugs.

SourceMod supports workshop maps since SourceMod 1.8.

No known bugs.

There are really 3 commands involved with the Map Workshop. They are:

• tf_workshop_map_sync - Used both to download a map and add it to the server's tracking list.
  
  • Tracked maps will be automatically updated as well as have the map's full name available to server-side plugins.
    
  • Maps in the server's mapcyclefile (mapcycle.txt by default) are automatically added to the tracked maps list.
• tf_workshop_map_status - List all maps currently being tracked.
  
• tf_workshop_refresh - Force the server to check all currently tracked maps for updates.

Before you can install a map, first you have to find one.

To do this, you can search the Map Workshop. You can filter by the workshop filters shown.


Once you find a map you like, copy its ID from your browsers title bar, or click the Share button and copy the ID from there.

On your server's console, run the command tf_workshop_map_sync followed by the ID number. For Glassworks, this would be tf_workshop_map_sync 454118349.

If you don't have access to the server console but you have rcon access, you can run rcon tf_workshop_map_sync with the map ID instead.

If you don't have that access either, but you are a SourceMod admin with sm_rcon access, you can use sm_rcon tf_workshop_map_sync with the map ID as an alternative.


To add a workshop map to a mapcycle, you have two options as to how to add it.

The first is by adding workshop/ID number (example: workshop/454118349 for glassworks).

The second is by adding workshop/anythinghere.ugcmap ID. (example: workshop/cp_glassworks_rc6.ugc454118349. This syntax may allow you to add additional information, but the information can be fake and/or misleading. In the example, GlassWorks has the wrong version number.

All maps in the mapcycle file are automatically tracked.

It is hightly recommended that you put all of your tf_workshop_map_sync lines in a file that is executed on every map change, such as server.cfg

SourceMod 1.8 or newer has full support for Workshop maps

All core plugins have been redesigned to display a workshop map's real name instead of its ID.

Here is what resolved maps look like in SourceMod's MapChooser:



In the above screenshot, the mapcycle was:

workshop/454118349
lumberyard
workshop/454160949
pipeline
dustbowl

Neither workshop map name resolution or workshop display names will occur until a map is being tracked; how to add a map to the tracked list is mentioned in a previous section.


For plugin developers, SourceMod has two commands for workshop maps:

FindMap[sm.alliedmods.net] takes a full or partial map name and gives you a FindMapResult[sm.alliedmods.net] back with its status.

GetMapDisplayName[sm.alliedmods.net] takes a workshop map's mapcycle entry and gives you its short name back.
For example, calling GetMapDisplayName on "workshop/454118349" or "workshop/cp_glassworks_rc6a.ugc454118349" will give you "cp_glassworks_rc6a" back.