CS:GO Map Publish Tool: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Category:Counter-Strike: Global Offensive)
m (Setting bug notice hidetested=1 param on page where the bug might not need tested in param specified)
 
(17 intermediate revisions by 13 users not shown)
Line 1: Line 1:
The CSGO Map Publish Tool is included with the [[Authoring Tools/SDK (CSGO)|CSGO SDK]] and will allow you to publish your custom maps to workshop. You can get the SDK by [steam://install/745 clicking here].
{{Lang}}
{{Subpage|[[Counter-Strike: Global Offensive Level Creation]]}}{{Delisted|csgo}}
 
The '''CS:GO Map Publish Tool''' is accessed by the console command <code>workshop_publish</code> from within the game.
__NOTOC__
==Adding your Map==
To upload a new map to workshop, click on ''Add'', then fill out all the fields:


==Adding your map==
[[File:csgo_map_publish_ui.jpg]]
[[File:csgo_map_publish_ui.jpg]]


To upload a new map to workshop, click on ''Add'' then fill out all the fields. At least one game mode is required and you should check all game modes your map would support.  
At least one game mode is required and you should check all [[CS:GO Game Modes]] your map would support. The checkbox ''Classic'' represents the modes ''{{csgo mode|Casual|link=}}'' and ''{{csgo mode|Competitive|link=}}''.
 
If your map is very large and fails to upload, add <code>-lowmemworkshop</code> to your [[Command Line Options#Command-line parameters|game launch settings]] and try again.
 
{{bug|hidetested=1|A long description will be truncated, so you have to go through the web based workshop for editing it again.}}
{{Tip|Save your full description in a text file.}}


The maximum size allowed for a map file is currently 200MB. The total storage allowed for all your CSGO maps is 1GB.
==Updating your Map==
To make changes to an existing submission, select it in the published files list and click ''Edit''.


==Updating your map==
[[File:csgo_map_update_ui.jpg]]
[[File:csgo_map_update_ui.jpg]]


To make changes to an existing submission, select it in the published files list and click ''Edit''. This dialog looks allows you to edit any of the fields you set previously. In addition, when you upload a new version of your map you have the option of providing change notes in the ''Changes this update'' field.  
This dialog looks allows you to edit any of the fields you set previously. In addition, when you upload a new version of your map you have the option of providing change notes in the ''Changes this update'' field.


When updating, only re-browse and select your bsp if you made changes to it. You can update title, description tags or the preview image without uploading a new bsp.  
When updating, only re-browse and select your [[BSP]] if you made changes to it. You can update title, description tags or the preview image without uploading a new BSP. These can also be edited on the workshop page of your entry.
 
{{Note|'''If your map has more than a 200MB size then you should add the <code>-lowmemworkshop</code> [[Command Line Options#Command-line parameters|startup parameter]] else you will crash after trying to click ''Edit''.'''}}


==File Packing==
==File Packing==
The map publish tool will automatically pack certain files if present. If any of the files are on disk at the time the map is selected for upload, the tool will add these to the BSP's pak file for you.
The map publish tool will automatically pack certain files if present. If any of the files are on disk at the time the map is selected for upload, the tool will add these to the BSP's pak file for you:
* '''maps/mapname.nav''' file used for bot navigation.
* '''maps/mapname.[[NAV|nav]]''' - A file used for [[bot]] navigation.
* '''maps/mapname.txt''' file used to populate the loading screen text (will be enabled in a future update).
* '''maps/[[mapname.txt]]''' - A file used to populate the loading screen text.
* '''maps/mapname.kv''' file used to specify default game mode, character skins and other options (default game mode option and examples will be in a future update).
* '''maps/[[Choosing Player Models|mapname.kv]]''' - A file used to specify default game mode and character skins.
* '''resource/overviews/mapname_radar.dds''' used for the radar and spectator overlays.
* '''resource/overviews/mapname_radar.dds''' - A file used for the [[Creating a working mini-map|radar and spectator overlays]].
* '''resource/overviews/mapname_radar_spectate.dds''', an optional file used for the spectator overview if you would like your overview to look different than your radar.  If this doesn't exist, it falls back to using the radar file.
{{note|Altitude-based radar image files (/resource/overview/''mapname''_higher_radar.dds and /resource/overview/''mapname''_lower_radar.dds) are not packed by the tool and will need to be manually packed.}}
* '''maps/cfg/mapname.cfg''', a cfg file to run when this map loads (used to support custom game modes and will be explained and enabled in a future update).
* '''resource/overviews/mapname_radar_spectate.dds''' - An optional file used for the spectator overview if you would like your overview to look different than your radar.  If this doesn't exist, it falls back to using the radar file.
* '''maps/cfg/mapname.cfg''' - A cfg file to run when this map loads (used to support [[CS:GO Game Modes/Custom|custom game modes]]).
 
Other files (for example, custom materials and textures not shipped with CS:GO) need to be packed in the bsp separately using [[bspzip]] or [[Third Party Tools]].
{{Note|[[Pakrat]] will corrupt some CS:GO Nav files, so it's best to let the map publish tool do the nav file packing.}}
 
==Known Errors==
 
When the Map Publish Tool is unable to update or upload the map, it will display a message referring to a specific error number. This section will attempt to explain them and show a possible solution:


Other files (for example, custom materials and textures not shipped with CSGO) need to be packed in the bsp separately using [[bspzip]] or third party tools. Note: [[Pakrat]] will corrupt some CSGO Nav files, so it's best to let the map publish tool do the nav file packing.
* '''Error 2''' - Unknown cause (likely network problem); Solution: Try uploading later. Possibly an issue with your upload stream or the Steam servers.
* '''Error 8''' - Unknown cause (likely formatting issue); Solution: delete all contents within the "'''Change Notes'''" and "'''Description'''" dialog boxes.


==Know Bugs==


* A long description will be truncated, so you have to go through the web based workshop for editing it again.
{{csgo-navbox}}
[[Category:Counter-Strike: Global Offensive]]
[[Category:Counter-Strike: Global Offensive]]

Latest revision as of 07:15, 20 May 2025

English (en)Deutsch (de)Русский (ru)Translate (Translate)
Icon-delisted.png
This page documents information about a game or software, Counter-Strike: Global Offensive Counter-Strike: Global Offensive, that is no longer available for purchase or download digitally.
It is covered here for historical and technical reference.

The CS:GO Map Publish Tool is accessed by the console command workshop_publish from within the game.

Adding your Map

To upload a new map to workshop, click on Add, then fill out all the fields:

Csgo map publish ui.jpg

At least one game mode is required and you should check all CS:GO Game Modes your map would support. The checkbox Classic represents the modes CS:GO/CS2 Casual Casual and CS:GO/CS2 Competitive Competitive.

If your map is very large and fails to upload, add -lowmemworkshop to your game launch settings and try again.

Icon-Bug.pngBug:A long description will be truncated, so you have to go through the web based workshop for editing it again.
Tip.pngTip:Save your full description in a text file.

Updating your Map

To make changes to an existing submission, select it in the published files list and click Edit.

Csgo map update ui.jpg

This dialog looks allows you to edit any of the fields you set previously. In addition, when you upload a new version of your map you have the option of providing change notes in the Changes this update field.

When updating, only re-browse and select your BSP if you made changes to it. You can update title, description tags or the preview image without uploading a new BSP. These can also be edited on the workshop page of your entry.

Note.pngNote:If your map has more than a 200MB size then you should add the -lowmemworkshop startup parameter else you will crash after trying to click Edit.

File Packing

The map publish tool will automatically pack certain files if present. If any of the files are on disk at the time the map is selected for upload, the tool will add these to the BSP's pak file for you:

  • maps/mapname.nav - A file used for bot navigation.
  • maps/mapname.txt - A file used to populate the loading screen text.
  • maps/mapname.kv - A file used to specify default game mode and character skins.
  • resource/overviews/mapname_radar.dds - A file used for the radar and spectator overlays.
Note.pngNote:Altitude-based radar image files (/resource/overview/mapname_higher_radar.dds and /resource/overview/mapname_lower_radar.dds) are not packed by the tool and will need to be manually packed.
  • resource/overviews/mapname_radar_spectate.dds - An optional file used for the spectator overview if you would like your overview to look different than your radar. If this doesn't exist, it falls back to using the radar file.
  • maps/cfg/mapname.cfg - A cfg file to run when this map loads (used to support custom game modes).

Other files (for example, custom materials and textures not shipped with CS:GO) need to be packed in the bsp separately using bspzip or Third Party Tools.

Note.pngNote:Pakrat will corrupt some CS:GO Nav files, so it's best to let the map publish tool do the nav file packing.

Known Errors

When the Map Publish Tool is unable to update or upload the map, it will display a message referring to a specific error number. This section will attempt to explain them and show a possible solution:

  • Error 2 - Unknown cause (likely network problem); Solution: Try uploading later. Possibly an issue with your upload stream or the Steam servers.
  • Error 8 - Unknown cause (likely formatting issue); Solution: delete all contents within the "Change Notes" and "Description" dialog boxes.