tutorial Don't Starve Steam Workshop Uploader

[Ipsquiggle]

The Don’t Starve Mod Tools allow mod creators to upload their mods to Steam Workshop for other players to subscribe to and use.
 
Getting the Mod Tools

The Mod Tools are now available for Windows, OSX and Linux!

1. Log into the Steam client using the account you wish to upload the mod with, this account must own a copy of Don’t Starve.
2. Hover over “LIBRARY” at the top of the Steam client, and select “Tools” from the dropdown list.
3. Find “Don’t Starve Mod Tools” in the list, and double click to install, or right click and “Install Game...” (despite the name, this only installs the Mod Tools)

Uploading your mod to Steam Workshop
Valve requires that you accept the Steam Subscriber Agreement before any of the Steam Workshop files you upload are visible to other users. You can install and use the Mod Tools to upload mods without accepting the agreement, however they will not be available to other users until you do.

Run The Mod Uploader

1. Hover your mouse over “LIBRARY” at the top of the Steam client, and select “Tools” from the dropdown list.
2. Find “Don’t Starve Mod Tools” in the list, and double click to run the Mod Uploader.

The main window of the Mod Uploader contains a list of mods which you have published to Workshop (which will start off empty), and buttons to Add, Delete or Edit mods that you have uploaded. There are also links to the Steam Workshop and the Steam Subscriber Agreement.
 
Upload Your Mod

1. Click the Add button, which will bring up the Mod Properties window. When adding a mod for the first time, all of the fields are required:
   • The data folder, which contains all of the files for your mod.
   • A preview image, to be displayed in the Steam Workshop
   • A name, and description to be displayed in the Steam Workshop
   • You may optionally select from one or more Tags to help players find your mod on Workshop.
2. Click Browse next to the Update Data field, and select the folder which contains your mod. At a minimum, the folder must contain a valid modinfo.lua file.  The Mod Uploader will warn you if the folder you have selected doesn’t contain a valid modinfo.lua.
3. Notice: ALL of the files in the folder that you selected will be uploaded to Steam Workshop, regardless of whether you have used them in making your mod or not.  So make sure there are no temporary or extra files contained in your mod folder that you don’t want to be included with your mod. You can always include a ReadMe.txt or similar file if you want.
4. Your mod also requires a Preview Image.  The Mod Uploader will default to looking for a file called “preview.jpg” in your mod folder, but you can click Browse to select a different JPG or PNG image if you wish. The preview image should be square and no larger than 512x512. This preview image is only for display in the Steam Workshop.
5. The Mod Uploader will read modinfo.lua and attempt to set Name and Description fields based on the contents of modinfo.lua.  Keep in mind, the information contained in modinfo.lua is what the game will display, and the information in the Name and Description fields of the Mod Uploader are what will be displayed on the Steam Workshop website.
6. Verify that the Name and Description are correct, and select any Tags that you want associated with your mod.  All of these values can be changed later, either through the Mod Uploader, or through the Steam Workshop website.
7. Press Publish!

The Mod Uploader will package and upload your mod to Steam Workshop. If all goes well, the upload will succeed and your mod will be uploaded to Workshop.  You may need to wait a few seconds and click Refresh before your mod will be displayed in the Mod Uploader, and it may take several minutes before your mod is visible on the Workshop website.

Updating Your Mod
So you’ve fixed a bug, or added some new features, or maybe you just made a typo in the Description?  You can easily update your mod using the Mod Uploader. Alternatively, you can edit your mod’s Name, Description and Tags on the Steam Workshop website, as well as add links,  preview images or screenshots.

1. Run the Mod Uploader and select your published mod from the list.  Various details about the mod will be displayed below, as well as a link to that mod in the Steam Workshop.
2. Double click the mod you want to edit, or click the Edit button below the mod details.
3. When you are editing an already published mod, you can choose which parts of the mod you want to update.
   • Check the Update Data box to upload changes to the mod itself (scripts, textures, data files).  Verify that the path to your mod is correct or Browse to its current location.
   • Check Update Preview Image if you want to update the main preview image for your mod.
   • Checking Update Details will update the Name, Description and Tags.
4. You must select at least one checkbox, or you can check all of them to update everything at once.
5. When you’re ready to make your changes, press Publish!

Wait a few second and click Refresh on the main Mod Uploader window to see that your changes have taken effect.  It may take several minutes for your changes to take effect on the Workshop website. Anyone who has subscribed to your mod will be automatically updated to your latest version the next time they visit the Mods screen inside Don’t Starve.
 
When mods are downloaded automatically by the game, they are named “workshop-123456789” where the number is the steam ID of published mod.  DO NOT modify files in “workshop-*” folders directly, as the game may delete them at any time. Always work in a folder you created yourself and update the mod from there.

Troubleshooting
Common issues and resolutions for resolving issues with your mods.

I Got An Error!
The first things to check are that your Steam Client is up to date and that you’re signed in and on a stable internet connection. If you’re having internet connection issues, or Steam is experiencing technical problems, then the Mod Uploader may be affected. In some cases, you may just want to wait a few minutes (or longer...) and try again later.
 
While you’re waiting, check the log file!

• Windows: C:\Users\<user name>\AppData\Local\Don't Starve Mod Uploader
• OSX: /Users/<username>/Library/Application Support/DontStarveModUploader
• Linux: ~/.local/share/DontStarveModUploader

Look for the file named ModUploader.log. Open it up and take a look, if most of it doesn’t make sense that’s OK.  If you do manage to figure out your problem based on what the log says, that’s great! Otherwise, you may want to head to the Don’t Starve modding forum, and upload your log file along with a description of what you were trying to do and what seems to have gone wrong. With any luck, somebody at Klei or within the modding community will be able to sort out the issue.
 
Nobody can see my mod!
Remember, you need to accept the Steam Subscriber Agreement before your mods will be visible to anyone except you!
 
Deleting Your Mod
By selecting your published mod in the Mod Uploader mod list, and clicking Delete, you can permanently remove your mod from Steam Workshop. Mod Uploader will prompt for confirmation, and if you accept the mod will be deleted from the Steam Workshop website immediately (like most operations, this may take up to a few minutes to take effect), and players will no longer be able to subscribe to it.
 
Deleting your mod cannot be un-done. If you want to restore your mod, you will need to publish your mod again.  This will behave like a completely new mod and users will need to subscribe to the newly published mod again, even if they were subscribed to your original mod before you deleted it. If you only want to make changes or update your current mod, do not delete and re-add it, use Edit instead.

Edited September 18, 2013 by Brook
update platform support

[Heavenfall]

I just want to say thank you for making the mod uploader so straight forward and easy to use. Although this tutorial looks daunting in its size, the mod uploader is self-explanatory if you read it from top to bottom.

[Brook]

Hi Guys,

 

I built the Mod Uploader, and as Heavenfall observed I tried to make it as self-explanatory as possible.  Feedback is always welcome and I'll do what I can to address any issues that come up, or answers questions about it.

 

Cheers,

Brook

[simplex]

Hi Guys, I built the Mod Uploader, and as Heavenfall observed I tried to make it as self-explanatory as possible.  Feedback is always welcome and I'll do what I can to address any issues that come up, or answers questions about it. Cheers,Brook

Are there plans for Linux support?

[Brook]

Are there plans for Linux support?

 

We're looking into it, but no solid plans at the moment.

[TheDanaAddams]

We're looking into it, but no solid plans at the moment.

Would I be correct assuming that the same is true for a Mac version?

[Brook]

Would I be correct assuming that the same is true for a Mac version?

 

Correct, same deal

[Caratyzna]

Would I be correct assuming that the same is true for a Mac version?

Does that mean I won't get Link back? =(

[Brook]

Does that mean I won't get Link back? =(

 

I'm not entirely sure what your question is, but if it's "Can I continue to use a mod I used before on Mac/Linux" then the answer is yes, you can!

 

The current Windows-only restriction only applies to the tool which modders can use to post their mods directly onto Steam workshop.  Users on all platforms can subscribe to and play those mods, as well as continue to install mods the Old Fashioned Way if you wish, downloading and unzipping them yourself instead of through Steam.

[Caratyzna]

I'm not entirely sure what your question is, but if it's "Can I continue to use a mod I used before on Mac/Linux" then the answer is yes, you can!

 

The current Windows-only restriction only applies to the tool which modders can use to post their mods directly onto Steam workshop.  Users on all platforms can subscribe to and play those mods, as well as continue to install mods the Old Fashioned Way if you wish, downloading and unzipping them yourself instead of through Steam.

 

I was just hoping that it didn't mean TheDanaAdams wasnt going to keep working on her mod. As long as I can get him back somehow I'm happy. =)

[GiantQueef]

So since I bought Don't Starve off the official site I can't use don't starve workshop... this sucks.

 

Edit- Nevermind, thank you Bigfoot

Edited August 22, 2013 by GiantQueef

[Bigfoot]

So since I bought Don't Starve off the official site I can't use don't starve workshop... this sucks.

Why not? The key it came with totally works to redeem on Steam!

[GiantQueef]

Why not? They key it came with totally works to redeem on Steam!

Really! Wow thank you!

[TheDanaAddams]

I was just hoping that it didn't mean TheDanaAdams wasnt going to keep working on her mod. As long as I can get him back somehow I'm happy. =)

Don't worry - just because I can't upload it to the Steam Workshop doesn't mean I'm going to stop. =)

[Coffgirl]

Could you check this for me?It keep saying fail to upload my mod even my internet is fine and steam is not out date.it often is like this I keep publish a lot of time to be success. ModUploader.log

[Brook]

Could you check this for me?

It keep saying fail to upload my mod even my internet is fine and steam is not out date.

it often is like this I keep publish a lot of time to be success. ModUploader.log

 

Hi Coffgirl,

 

According to Steam, the error you are getting is indicating that Steam is busy and couldn't process the upload.  I'm not sure what that means in your case, it doesn't appear that you're doing anything wrong from the log.

 

Was Steam doing anything else at the same time as you were trying to upload your mod? (eg. was it downloading any updates to other games, or did you have any Steam games running at that time?)  The best thing I can suggest at this point is just make sure you aren't doing other things in Steam when trying to upload your mods.

[Coffgirl]

ํNo, I didn't do anything while uploading it. /;A;I really wanna know what cause this problem.Thank you! ;w;

[_Q_]

Bump.

People are searching for it, and it should be pinned anyway.

[futaradragon]

Please Pin this..

[tehMugwump]

Pinned....

[Cyanogen101]

Hi Guys,

 

I built the Mod Uploader, and as Heavenfall observed I tried to make it as self-explanatory as possible.  Feedback is always welcome and I'll do what I can to address any issues that come up, or answers questions about it.

 

Cheers,

Brook

What About Us Ubuntu Users? we can make Mods, Why cant we upload them?

[TheDanaAddams]

What About Us Ubuntu Users? we can make Mods, Why cant we upload them?

Next thread down.

 

http://forums.kleientertainment.com/index.php?/topic/27868-mod-uploader-preview-osx-and-linux-support/

[Cyanogen101]

i see its now avaliable!, but when run on Ubuntu 13.04 there is a error, missing executable

[StormyRange]

Hmm, I'm trying to use this but it always fails and says my file is too big:

21:39:11: Progress: Writing mod data file...
21:39:11: WriteFileToCloud() Writing [C:\Users\Range\AppData\Local\Temp\modDD22.tmp] to [mod_publish_data_file.zip]
21:39:11: File too big!
21:39:11: EndProgress FAILED: Failed to write mod data file!
21:39:11: MainFrame::OnPublishComplete FAILED: Failed to write mod data file!
21:39:13: RefreshPublishedModInfo
21:39:13: EnumerateUserPublishedFiles(0)

 

It's a character mod with one music track replacement and is 11.5MB. Is there a way around this or should I lower quality on the track?

 

EDIT: I turned down the quality of custom SFX and music, all of them together come to 482kb, but the FSB file is 10MB by itself for some reason, it hasn't got any other sounds in it's bank than the ones I'm using.

Edited September 19, 2013 by StormyRange

[Cheerio]

Hmm, I'm trying to use this but it always fails and says my file is too big:

21:39:11: Progress: Writing mod data file...

21:39:11: WriteFileToCloud() Writing [C:\Users\Range\AppData\Local\Temp\modDD22.tmp] to [mod_publish_data_file.zip]

21:39:11: File too big!

21:39:11: EndProgress FAILED: Failed to write mod data file!

21:39:11: MainFrame::OnPublishComplete FAILED: Failed to write mod data file!

21:39:13: RefreshPublishedModInfo

21:39:13: EnumerateUserPublishedFiles(0)

 

It's a character mod with one music track replacement and is 11.5MB. Is there a way around this or should I lower quality on the track?

 

EDIT: I turned down the quality of custom SFX and music, all of them together come to 482kb, but the FSB file is 10MB by itself for some reason, it hasn't got any other sounds in it's bank than the ones I'm using.

In FMOD designer, click on the banks tab and then click on your bank(.fsb) file.  In the properties window( right side ), there should be some options regarding audio compression settings.  Try turning down the quality and switching the format to something like ',mp3'.