Insurgency

Insurgency

50 ratings
Server Side Workshop (updated 4.1.2020)
By Arc and 2 collaborators
This guide is needed for those who want to enable Steam Workshop support on their servers.
   
Award
Favorite
Favorited
Unfavorite
Intro
For the new update, we’ve made some changes to the Steam Workshop system. There are currently 2 types of Workshop, for simplification i'll call them Current and Legacy.

Current system should work with no problem both on Windows and Linux server as well.
Legacy system may work on Windows server but it is not recommended to use and may cause some server deadlocking.
1.) Setting up the Workshop support
First add this parameter to the startup file (command line)
-workshop


This will enable workshop support for server.

Now tell the server which files should be downloaded.
Navigate to:
..\YourServerName\insurgency

create a TXT file and rename it to:
subscribed_file_ids
(click to enlarge)



In case you want to use your own custom modification or map, you need to upload it on Steam Workshop through the game client first.

Then navigate through the Steam Workshop:
https://steamhost.cn/steamcommunity_com/workshop/browse?appid=222880

and find a mod that you want to have on your server. Locate its ID number. The mod’s ID number can be found here, as highlighted in this picture (click to enlarge):




Copy that ID number to the "subscribed_file_ids.txt" file you have just created. Multiple ID’s can be placed, just be sure it is one ID per line.




Start the server and it will attempt to download all the Workshop mods.
2.) Current Workshop system
Any mod updated/uploaded after July 26, 2015 game patch sits on current workshop system and may be used server-side. Additionally, maps in current workshop will have separate BSP, NAV and TXT files.

Attention !
It is necessary to add mod ID number to "subscribed_file_ids.txt" file, otherwise clients won’t recognize the mod and will be disconnected.

Server-side folder structure:
...\YourServerName\steamapps\workshop\content\222880\



Client-side folder structure:
..\SteamLibrary\steamapps\workshop\content\222880\

This directory contains both VPK mods and custom maps. Each folder under this directory correlates with the Workshop ID.

Mapcycle file structure for New maps is same as for the official ones:
mapname modename



Yes, it works on Linux server !

If you have VPK mod containing Theater script or Playlist, you will use normal methods for getting them to work: "mp_theater_override" and "sv_playlist" respectively.
3.) Legacy Workshop items
Legacy workshop mods will not work on Linux server. They may work on Windows server, but it'll probably bring more problems than it is worth. I highly recommend to avoid those as they are probably outdated anyway.

Folder structure for maps:
..\YourServerName\insurgency\maps\workshop\ID_number

for other modifications in VPK format:
..\YourServerName\insurgency\custom\workshop

Mapcycle file structure:
workshop/id#/mapname modename

4.) Collections
Since May 26h, 2016 server now support Workshop Collections. It works a bit differently than in other Source engine games. You can mix workshop IDs with file IDs if you want.

Be sure that your server have Workshop enabled (see Step 1) then copy "Collection ID"


put it in "subscribed_file_ids.txt"



restart the server and it will download all content from the collection.

Only current Workshop mods and maps are supported, legacy will deadlock the server !!

5.) Subscribing to mod which have "item requirement"
As you may or may not know, Server Side Workshop does support modifications that requires other mods to work properly. These are linked via “required item” function in Steam Workshop page of such mod.

Only main mod ID is needed to subscribe server side, any required item will be then downloaded/mounted automatically and will be correctly pushed for clients.



I will use my server mod as an example:
https://steamhost.cn/steamcommunity_com/sharedfiles/filedetails/?id=490323818

As you can see, my mod’s ID is “490323818” and have one additional mod set as “required item”:


This "required mod" is Tigg’s “Insurgency: Arsenal” and can be found here:

https://steamhost.cn/steamcommunity_com/sharedfiles/filedetails/?id=626093257


Only my mod’s ID “490323818” is listed in “subscribed_file_ids.txt”. Upon server restart, both main mod and required mod are installed and mounted on the server:


155 Comments
DEADINSIDE 12 Sep, 2024 @ 6:59am 
And about yesterday - i just close steam session)
DEADINSIDE 12 Sep, 2024 @ 6:56am 
Hi again!) Can you help me?)
How i can add in server custom player models for players? I mean I like admin wanna have anime girl but all players will play with default skins) It is real?) Sry for my eng, is not mine main language)
DEADINSIDE 11 Sep, 2024 @ 9:29am 
Okay, thx)
I dont know why but now download is start my map) Mb it bugs Steam servers) Thx!
DEADINSIDE 11 Sep, 2024 @ 9:23am 
whats encoding must be? may be trouble on that )
Arc  [author] 11 Sep, 2024 @ 9:00am 
On Windows the MOST common issue by far is hidden file extensions causing you to funble the naming into "filename.txt.txt".
Double check you do not have this issue on your side.

Other than that, post the exact file path for the TXT file you created, the exact IDs of mods in the list, the exact way you written the IDs into the list and which text encoding the file is using.
DEADINSIDE 11 Sep, 2024 @ 8:54am 
Hi! Help me pls) I dont know why but my server didnt download maps in directory. In CMD writed like: Added 0 Workshop items to the download list.
But i create subscribed_file_ids.txt and add id map from workshop. I checked it out for right ID e.t.c. but nothing
RedDeathOfMe 14 Aug, 2024 @ 11:52pm 
Okay, thank you so much for the quick response. I will probably just post them to the workshop with a note for server owners.
Arc  [author] 14 Aug, 2024 @ 10:47pm 
The only purely server-side mods are MM and SM.
The map files, map scripts, sounds, sound scripts, theaters, assets, playlists, etc. all have to be present on client since SRCDS has 1:1 file structure to client game.
RedDeathOfMe 14 Aug, 2024 @ 5:45pm 
Thanks for your helpful guides, guys! Without them, I couldn't have opened my Insurgency server at the start of 2024.

I modded the default maps on my server, adding Checkpoint to Panj, Peak, and others. This was done using MetaMod and modded `mapname.txt` files, but yesterday I discovered a method using only the map's BSP and TXT files. This is especially cool, because I could actually upload these mods to the workshop, allowing any server admin to easily implement them. No GCFScape, no MetaMod, just a workshop ID.

However, I can't seem to find information on installing a server-only mod.

Is it possible to install a workshop mod server-side only, and NOT force clients to download it?

(Other than manually unpacking the `insurgency_misc` VPK and repacking it with the modded files, of course.)
SANGY 24 Sep, 2023 @ 1:01pm 
Also note: once you have entered a server that is using mods, these mods will be considered as SUBSCRIBED even if you did not subscribed them in workshop, and you can NOT unsubscribed them by deleting the mod file and appworkshop_222880.acf file(because steam will re-download them in a few minutes), the way I found to unsubscribed is to uninstall the whole game.