Workshop Publishing

Official guide on Steam Workshop publishing.

Accessing Publishing Tool

The Publishing Tool comes with the game. The tool is available for Windows, OSX and Linux. The Publishing tool is located in <PATH_TO_STEAM>\SteamApps\common\Duke Nukem 3d\bin\cmdtool folder. Easiest way to find this folder is by using Steam: right click on the game in Library->Properties->Local Files->Browse Local Files and then navigate to bin\cmdtool in explorer window.


The tool doesn't have a GUI, it's a command-line based tool. So you need to use a terminal/console application to work with it. First you need to launch cmd.exe: press Win+R, type cmd.exe and press Enter.


Now you need to change folder to the folder where the tool is located. To do this you need to type cd <PATH_TO_THE_TOOL> and press Enter.


Now you can launch the tool: type cmdtool and press Enter. If you see similar output like the one on the screenshot then you are ready to proceed for publishing.

Preparing And Publishing Map

You need to prepare the files for publishing. Let's say you want to publish a map called "My House".

• First create a folder and name it "myhouse"
  
• Name your map file "myhouse.map" and put it inside "myhouse" folder.
  
• Prepare a preview image. It should be a .png file. Name it "myhouse.png" and put it inside "myhouse" folder.
  
• (Optional) Put readme.txt file with other files (custom .voc files, .art files, etc)
  
• Now you need to create a Workshop configuration file. Create a text file and name it "myhouse.json". Make sure it's "myhouse.json" and not "myhouse.json.txt"! Open it with your favourite text editor and copy the following content: http://pastebin.com/af7biG4d . Change the title. you can leave the description empty for now, because you can change it later on the Workshop page. Remove categories that are not supported by your map.

Your folder content probably looks like this:



Now you can finally publish your map. Switch to the cmd window and type cmdtool publish myhouse. Operation should take around one minute and output should look like this:



Your item will appear on the Steam Workshop page after some time. If you are publishing a map for the first time you have to accept the Steam Workshop Agreement: http://steamcommunity.com/workshop/workshoplegalagreement , otherwise your item will be invisible. You also can edit your map description even before it becomes visible. To do that you have to follow this url: http://steamcommunity.com/sharedfiles/filedetails/?id=<FILE_ID> where FILE_ID is a id of your item, that you can find in cmdtool output (highlighted red on the screenshot)

Don't remove your folder after publishing, it will be useful for when you decide to update your map.

Listing, Updating And Deleting Maps

• To list all your published maps you can type the following command: cmdtool list This command is helpful if you decide to update or delete your map but forgot its FILE_ID
  
• To update your map you have to prepare a folder the same way as you did for publishing or reuse your previously prepared folder. Use the following command after you have prepared the folder: cmdtool update FOLDER_NAME FILE_ID "Changelog message". Example: cmdtool update myhouse 190199901 "Added more powerups in the kitchen". If you forgot your FILE_ID use cmdtool list
  
• You can delete your map from Workshop page or by using the following command: cmdtool delete FILE_ID.

Troubleshooting

Common issues and solutions:

• Steam is not running or lost connection. Simply restart the Steam client.
  
• Missing resources. Verify that you have all required resources: the map, preview image and json file.
  
• Wrong json file syntax. Make sure that you are following JSON syntax: http://jsonlint.com/
  
• If you have any other issues, you can ask for help or post a bug report in this sub forum: http://steamcommunity.com/app/225140/discussions/2/

Publishing Rules

• One item – one map. Don't put more than one map in one Workshop item. Create yourself a Workshop Collection instead!
  
• Credit original authors. If you have found a good map and you can't contact the original author, you can publish it yourself, but you have to put the original readme.txt file it came with and clearly credit author in the description.
  
• Claiming ownership. If you believe that somebody has uploaded your map without your permission and/or didn't credit you properly, you can mail us contact[at]generalarcade.com and we will resolve the problem quickly.

[Thedutchjelle]

I've added my map running the cmdtool, but I forgot to copy the adress it gave me. I can't see my item yet in my workshop. Anyone knows how long this usually takes? First time I've used this.

[Nada]

Favorite text editor should not include Notepad or Word, or anything that uses "smart" quotes, dashes, dots etc.

[±Schwiiz Franco McHarrell±]

Nice guide, thanks!

[󠀡󠀡 󠀡󠀡 󠀡󠀡󠀡]

map editor tutorial please

[Pipacs]

Is it possible to upload something other than maps? (for example audio pack, texture pack)

[Haliceph]

@scavenge no different than the garrys mod workshop atm

[Robman]

That's why I intend on publishing maps to Sw Redux :D ... I managed to get 1 map up there atleast. Still having the .json file saving issue though. I just used the .json file from "TheEdge" version that some1 had ripped off from me but Lunick took that file down for me.

[termit]

Robman, ahah ancient :) you sure never work with unix-systems. If people can handle it, they probably should not publish anything in Megaton workshop.

[Robman]

Yep, ancient and frustrating way to publish a map. Saving a file as a .json file is driving me insane... always gets saved as blah.json.txt

[Spanator]

damn thing, taking ages on the cloud successfull but i dont see the map i uploaded... shame