Creation:
← Older revision
Revision as of 10:01, August 3, 2015
(One intermediate revision by one user not shown)
Line 6:
Line 6:
There are various kinds of mods including '''Modding Tools''', '''Game Modifications''', '''Language Packs,''' '''Custom Maps and new Characters.'''
There are various kinds of mods including '''Modding Tools''', '''Game Modifications''', '''Language Packs,''' '''Custom Maps and new Characters.'''
−
== Installing Mods ==
+
{{GameDir|mods/|it=the ''mods'' folder}}
+
+
== Installation ==
Players should know that '''Klei is not able to help you should issues arise while using mods. Use with caution!'''
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.
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.
−
# [[Download]] a mod either from the [http://steamcommunity.com/sharedfiles/browse/?appid=219740 Steam Workshop] or [http://forums.kleientertainment.com/files/ Klei Forums' Downloads Section.]
−
# If downloading from the Workshop, all you need to do is go into the game and activate the mod from the "Mods" menu.
−
# If downloading from the fourms, unzip the mod folder under :<code>''\steam\steamapps\common\dont_starve\mods'' (If you are on Mac, right click dontstarve_steam and click show package contents. If you're on the non-Steam version, the Don't Starve folder should be in ''C''</code><code>'':\Program Files\Don't Starve''</code> for Windows machines.)
+
You can [[Download]] a mod either from the [http://steamcommunity.com/sharedfiles/browse/?appid=219740 Steam Workshop] ([http://steamcommunity.com/sharedfiles/browse/?appid=322330 DST]) or [http://forums.kleientertainment.com/files/ Klei Forums' Downloads Section].
+
+
If downloading from the Workshop, all you need to do is suscribe 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 ==
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 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.
−
# Go to steam folder. This is usually either in <code>C:\Program Files\Steam</code> '''or''' <code>C:\Program Files (x86)\Steam</code>
+
If you installed a broken mod from Steam Workshop, just unsuscribe it. Also don't forget to tell the author about the crash and a list of all mods you have in the folder.
−
# Go to <code>\steam\steamapps\common\dont_starve\mods</code>
−
# If players have modified a folder to install a mod, then delete the folder. 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.
−
# Go into the steam library.
−
# Right click Don't Starve, go to properties.
−
# Go to the tab labelled Local Files.
−
# Click Verify Integrity of Game Cache.
−
# Steam will help recover game files.
−
== Creating Mods ==
+
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. <small>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.</small>
−
Before creating new mods, players should read [http://www.dontstarvegame.com/player-creation-guidelines '''Player Creation Guidelines''']. Players are recommended to be familiar with [[Lua]] and [[TEX]] file format before creating any mods.
−
[http://forums.kleientertainment.com/showthread.php?10817-TUTORIAL-Creating-a-Mod-using-the-Mod-System Here is a tutorial for creating mods.]
−
== Modding Tools ==
+
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.
−
{| border="1" cellpadding="1" cellspacing="1" class="article-table" style="width: 650px; height: 200px; "
+
−
! scope="col" style="text-align:center;"|Name
+
== Creation ==
−
! scope="col" style="text-align:center;"|Author
+
Before creating new mods, players should read the [http://www.dontstarvegame.com/player-creation-guidelines Guidelines]. Players are recommended to be familiar with the [[Wikipedia:Lua|Lua]] language and the [[TEX]] file format before creating any mods. There is also a [http://forums.kleientertainment.com/showthread.php?10817-TUTORIAL-Creating-a-Mod-using-the-Mod-System tutorial] on the forum. The API doc (see below) also has one.
−
! scope="col" style="text-align:center;"|Version
+
−
! scope="col" style="text-align:center;"|Mod Page
+
=== Basic API Info ===
−
! scope="col" style="text-align:center;"|Note
+
+
The mod system takes two most important files, <code>modinfo.lua</code> and <code>modmain.lua</code>. The earlier contains multiple info about your mod, like the name, version and version compatibilities. The latter is like the <code>main()</code> function in other languages -- that is, where the mod system invoke and loads your mod. It has an enivornment itself.
+
+
The <code>data/scripts</code> 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 [http://dontstarveapi.com unoffical API doc] is also avaliable.
+
+
=== Modding Tools ===
+
{| class=wikitable
+
! Name !! Author !! Version !! Description
|-
|-
−
| style="text-align:center;"|'''Klei Studio'''
+
| [http://forums.kleientertainment.com/showthread.php?12434-REL-Klei-Studio-(-TEXTool-)-Underground Klei Studio]
−
| style="text-align:center;"|Handsome Matt
+
| Handsome Matt || Hungry for your hunger ||Edit [[TEX]] and animation files of Don't Starve.
−
| style="text-align:center;"|Hungry for your hunger
−
| style="text-align:center;"|[http://forums.kleientertainment.com/showthread.php?12434-REL-Klei-Studio-(-TEXTool-)-Underground]
−
| style="text-align:center;"|Edit [[TEX]] and animation files of Don't Starve
|-
|-
−
| style="text-align:center;"|'''Mod Library'''
+
| [http://forums.kleientertainment.com/showthread.php?14337-REL-Mod-Library-v1-3-END-UPDATE Mod Library]
−
| style="text-align:center;"|WrathOf
+
| WrathOf || The End is Nigh || Provide support for modders and additional functions.
−
| style="text-align:center;"|The End is Nigh
−
| style="text-align:center;"|[http://forums.kleientertainment.com/showthread.php?14337-REL-Mod-Library-v1-3-END-UPDATE]
−
| style="text-align:center;"|Provide support for modders and additional functions
|}
|}
−
== Language Pack ==
+
Since you are writing some code, you may want a [[Wikipedia:text editor|text editor]] that supports [[Wikipedia:syntax highlighting|syntax highlighting]] in [[Wikipedia:Lua|Lua]], so you can see the code clearly. [[Wikipedia:Notepad++|Notepad++]], [[Wikipedia:Vim|Vim]] and [[Wikipedia:Atom (text editor)|Atom]] are often popular choices. You can also use [[Wikipedia:integrated development environment|Integrated development environments]] (IDE), since they may be even smarter.
+
+
== Language Packs ==
Players may download a language pack if their language is not supported by the game. Search through them [http://forums.kleientertainment.com/downloads.php?categoryid=2 here].
Players may download a language pack if their language is not supported by the game. Search through them [http://forums.kleientertainment.com/downloads.php?categoryid=2 here].
[[Category:Mods]]
[[Category:Mods]]