As part of the Unified Community Platform project, your wiki will be migrated to the new platform in the next few weeks. Read more here.
Mods, or modifications, are alterations or additions to the original content of a video game. They may present new features, player experiences, and/or tweaks to the game, making the game more enjoyable and either easier or harder.
Mods for Don't Starve are usually developed by the Don't Starve community.
- Disclaimer: Klei is not able to help you should issues arise while using mods. Use with caution!
The simplest way to download and install mods is to subscribe to them in the Steam Community Workshop. This will automatically download the mods into the game. The player can then enable/disable the installed mods by going into the "Mods" menu, from the main menu, and ticking the mods' respective checkboxes.
Mods can also be downloaded as files from Klei's official website, which must be manually placed into the appropriate "/mods/" directory of the game. The website contains downloadable files categorized into sections: Modding Tools, Game Modifications, Language Packs, Custom Maps and New Characters, etc. The same mods can usually be found from the Steam Community Workshop.
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/dont_starve.app/Contents/mods/ 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.
There are alternate steps to take when installing and enabling mods on dedicated servers.
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.
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 are also tutorials on the forum. The API doc (see below) also has one.
Basic API Info
The mod system takes two most important files,
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.
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.
|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.|
|Don't Starve Mod Tools||Klei Enterteinment||1965676||Allow Modders to Upload to the Steam Workshop|
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.
Players may download a language pack if their language is not supported by the game. Search through them here.
In DST, there are three kinds of mods:
- client-only, which are enabled by each player individually and used on any server. These usually make changes to the interface.
- server-only, which must be enabled on the server, but no joining players need to download. These usually make small changes to game mechanics, such as changing the timing of things, or scaling creature stats.
- all-clients, which all players on a server need to have. The Steam Workshop automatically handles downloading and enabling these for players when they join a server with an all-clients mod enabled. These mods can change almost anything about the game.