Don't Starve game Wiki


716pages on
this wiki
The content of this page is not supported by Klei Entertainment, the Don't Starve Wiki, or the Don't Starve Forum.
How to install mods in Don't Starve-102:31

How to install mods in Don't Starve-1

Mods (short for modifications) are external changes of Don't Starve game content from what it originally was for the PC version only. Mods are usually developed by the Don't Starve community. They present new player experiences and tweaks to the game, such as making the game easier or harder, or modifying game attributes that change the way certain elements in the DS World function.

There are various kinds of mods including Modding Tools, Game Modifications, Language Packs, Custom Maps and new Characters.

Find the mods folder under:

Windows: C:/Program Files/Steam/steamapps/common/Don't Starve/mods/
OS X: ~/Library/Application Support/steamapps/common/Don't Starve/
Linux/SteamOS:  ~/.steam/steam/steamapps/common/Don't Starve/mods/

If your release has nothing to do with Steam, Find the mods folder under:

Windows: C:/Program Files/Don't Starve/mods/

Change dont_starve to dontstarve_steam and Don't Starve to Don't Starve Together for Don't Starve Together. For Windows, look under Program Files (x86). If you have Steam installed elsewhere, look there. For OS X, right-click on the application and click show package contents or use a terminal to cd to get in the app. ~ means your home directory.

Installation Edit

Players should know that Klei is not able to help you should issues arise while using mods. Use with caution!

Here is a simple procedure for installing mods, however, some mods may have different installation procedures. The following procedure is just a reference for players.

You can Download a mod either from the Steam Workshop (DST) or Klei Forums' Downloads Section.

If downloading from the Workshop, all you need to do is subscribe it, go into the game and activate the mod from the "Mods" menu.

If downloading from the forums, unzip the mod under the mods folder mentioned above.

Removal Edit

If players have accidentally installed mods incorrectly, then usually the best thing to do is to use the backup players have made. However there is an alternative method if players forget to create backup.

If you installed a broken mod from Steam Workshop, just unsubscribe it. Also don't forget to tell the author about the crash and a list of all mods you have in the folder.

If it comes from a zip file that you unpacked, go to the mods folder mentioned above, then delete that mod folder, or move it elsewhere. In 99% of cases so far, players should only have to delete their scripts folder. Now, some of the players may realize that this is like dropping a bomb to kill a spider, but that's okay. It just guarantees that all traces of mods are removed.

Finally go to your Steam Library, Right-Click on your game and choose properties. In the tab Local Files, choose verify integrity of game cache. Steam will take care of the whole thing.

Creation Edit

Before creating new mods, players should read the Guidelines. Players are recommended to be familiar with the Lua language and the TEX file format before creating any mods. There is also a tutorial on the forum. The API doc (see below) also has one.

Basic API Info Edit

The mod system takes two most important files, modinfo.lua and modmain.lua. The earlier contains multiple info about your mod, like the name, version, and version compatibility. The latter is like the main() function in other languages -- that is, where the mod system invoke and loads your mod. It has an environment itself.

The data/scripts folder under the game's program directory contains lua code for the vanilla game itself. You can refer to them for some API info. An unofficial API doc is also available.

Modding Tools Edit

Name Author Version Description
Klei Studio Handsome Matt Hungry for your hunger Edit TEX and animation files of Don't Starve.
Mod Library WrathOf The End is Nigh Provide support for modders and additional functions.

Since you are writing some code, you may want a text editor that supports syntax highlighting in Lua, so you can see the code clearly. Notepad++, Vim and Atom are often popular choices. You can also use Integrated development environments (IDE), since they may be even smarter.

Language Packs Edit

Players may download a language pack if their language is not supported by the game. Search through them here.

Start a Discussion Discussions about Mods

Around Wikia's network

Random Wiki