Updated readme and examples for workshop support

joedwards32 · Aug 30, 2024 · a15e7ce · a15e7ce
1 parent 0ac69e9
commit a15e7ce
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -77,8 +77,8 @@ CS2_GAMEALIAS=""            (Game type, e.g. casual, competitive, deathmatch.
                              See https://developer.valvesoftware.com/wiki/Counter-Strike_2/Dedicated_Servers)
 CS2_GAMETYPE=0              (Used if CS2_GAMEALIAS not defined. See https://developer.valvesoftware.com/wiki/Counter-Strike_2/Dedicated_Servers)
 CS2_GAMEMODE=1              (Used if CS2_GAMEALIAS not defined. See https://developer.valvesoftware.com/wiki/Counter-Strike_2/Dedicated_Servers)
-CS2_MAPGROUP="mg_active"    (Map pool)
-CS2_STARTMAP="de_inferno"   (Start map)
+CS2_MAPGROUP="mg_active"    (Map pool. Ignored if workshop maps are defined.)
+CS2_STARTMAP="de_inferno"   (Start map. Ignored if workshop maps are defined.)
 ```
 
 ### Bots

diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml
@@ -21,8 +21,11 @@ services:
       - CS2_GAMEALIAS               # (Game type, e.g. casual, competitive, deathmatch. See https://developer.valvesoftware.com/wiki/Counter-Strike_2/Dedicated_Servers)
       - CS2_GAMETYPE=0              # (Used if CS2_GAMEALIAS not defined. See https://developer.valvesoftware.com/wiki/Counter-Strike_2/Dedicated_Servers)
       - CS2_GAMEMODE=1              # (Used if CS2_GAMEALIAS not defined. See https://developer.valvesoftware.com/wiki/Counter-Strike_2/Dedicated_Servers)
-      - CS2_MAPGROUP=mg_active      # (Map pool)
-      - CS2_STARTMAP=de_inferno     # (Start map)
+      - CS2_MAPGROUP=mg_active      # (Map pool. Ignored if Workshop maps are defined.)
+      - CS2_STARTMAP=de_inferno     # (Start map. Ignored if Workshop maps are defined.)
+      # Workshop Maps
+      - CS2_HOST_WORKSHOP_COLLECTION # The workshop collection to use
+      - CS2_HOST_WORKSHOP_MAP        # The workshop map to use. If collection is also defined, this is the starting map.
       # Bots
       - CS2_BOT_DIFFICULTY          # (0 - easy, 1 - normal, 2 - hard, 3 - expert)
       - CS2_BOT_QUOTA               # (Number of bots)