Modding Tools, Tutorials & Examples

84 files

  1. ktools: Cross-platform modding tools for Don't Starve

    IMPORTANT: Starting with version 4.3.0, the Windows binary release requires Microsoft's Visual C++ 2013 Redistributable Package (previously, the 2010 one was required). See the bottom of this description for more information.
     
    ktools is a set of cross-platform (Linux, Mac and Windows) modding tools for Don't Starve. It consists of the following command-line tools:
    ktech: a bidirectional converter between TEX texture and PNG; krane: a anim.bin/build.bin decompiler, whose output is a Spriter project. More detailed information about these tools may be found in the README, in the project's GitHub repository.
    ktools primary release format is as source code, compilable under every platform using CMake, as per the instructions in the README. A Windows binary release is also included (the ZIP ending with "-win32").
    When compiling from source, if libzip is found then the ktools are compiled with zip support, so that zip archives may be given as input in the same way directories may. The binary Windows release does not have zip support.
    If you have issues running the Windows binary release, make sure you have Microsoft's Visual C++ 2013 Redistributable Package (the 32 bit version, that is, download the file called vcredist_x86.exe). It's very likely already installed, but in case of any errors first make sure that is in fact the case.

    9884 downloads

    100 comments

    Updated

  2. Extended Sample Character

    A character mod template for Don't Starve and Don't Starve Together.
    There are multiple versions.
    V1.0.4 - Don't Starve and Don't Starve Reign of Giants
    V1.2.6 - Don't Starve Together
    V1.3.1 - Don't Starve Shipwrecked
    The full tutorial can be found here.
    Features:
    Basic coding for a character mod All sprites and symbols to build a character Extended drawing areas for custom art Reign of Giants, Shipwrecked, and Don't Starve Together versions This requires Don't Starve Mod Tools to autocompile .png files that are modified.
    The .scml is built in a way that you can use Spriter (included with Don't Starve Mod Tools) to preview the changes you make. The .scml file is not intended to be changed itself, and changes may not correctly reflect how it appears in-game.
    A folder of cleared sprites has been included to easily remove unwanted parts from your character.
    Also on Github

    78732 downloads

    113 comments

    Updated

  3. API Examples

    This mod is made by Ipsquiggle at Klei to show off various features of the mod API.
    This mod is not meant to be played. It is for scripting demonstration only.
    I'll keep this up-to-date as I add functions to the API so you have an example of how they are used.

    Updated for the Stuff of Nightmares release! Tonnes of new functions and examples to check out!

    11406 downloads

    9 comments

    Updated

  4. HUD Skins

    This library helps you to create your own custom HUDs! You can find the guide on using it here:
     

    31 downloads

    0 comments

    Submitted

  5. Development tool

    This mod adds a Development Tool - It have been crated by Klei, to help with testing Don't Starve and RoG DLC. File "devtool.lua" can be found in vanilla game, in prefabs folder. This mod adds a remade version of it, that makes it possible to use in-game, along with couple of features.
    Devtool:
    - can be used as weapon (range: 20, about half of a screen; damage: 10000)
    - can be used as axe, pick, shovel, hammer and net; every action is instant
    - creates large light spot around a holder, or around lying spot
    - provides health, hunger and sanity insta-regeneration
    - provides heat in Winter and (if RoG is enabled) act as cooler in Summer
    - act as Walking Cane, adding speed multiplier (about 2 times faster than normal)
    - has built-in prototyper, so you can prototype stuff anywhere and anytime
    - if you want to build anything, provides necessary resources
    - act as blinkstaff (you can teleport to a chosen spot)
    - almost every feature is configurable in mod configuration screen
    I'm uploading it here as a mod, because it really helps testing mods. It doesn't have a crafting recipe (obviously), so, Here as a console command that you have to type in console to get it:


    c_give("devtool")



    This mod is meant to be OP, because I made it to help testing mods...



    Consider that before posting a comment...
    Have fun with testing mods

    2798 downloads

    21 comments

    Updated

  6. [API] Skins for modded items

    This is the API for making your own skins for modded items. Guide on how to do it is here:
     

    218 downloads

    3 comments

    Updated

  7. Texture and Atlas Packer

    This program can be used to create a single texture and atlas file from multiple images.
    VirusTotal: Here
    Unpack Function:
    The unpack function allows the end user to break down Texture (.tex) files into their base image into a Portable Network Graphics (.png) file.
    HOW TO USE EXPORT FUNCTION:
    When adding files instead of adding Image Files, select 'Texture Files' from the drop down. Add the Texture (.tex) files you wish to unpack and click the Unpack button. If you press the Unpack button and no Texture (.tex) files are in the list, it will skip operations. If a Texture (.tex) file is in the list and you press the Pack button, the pack function will skip the Texture (.tex) file.
    NOTE 1:
    This required .NET Frameworks 4.6 in order to run it correctly. Please download it from the Microsoft Website if you're not running Windows 10.
    Regards,
    Kzisor/Ysovuka

    1496 downloads

    5 comments

    Updated

  8. Hat Example

    This is an example of a hat. This example requires the PC version of the 'Don't Starve Mod Tools'.

    1811 downloads

    13 comments

    Submitted

  9. Don't Starve Hamlet PT-BR

    Translation for Don't Starve Hamlet - in progress

    93 downloads

    1 comment

    Updated

  10. Sample Mods

    These are official sample mods developed by Klei. They are very small and barebones, in order to get you started with modding. These are meant to serve as a starting point only and are not complete mods on their own!
    Sample Prefab
    This mod demonstrates adding a new object to the world which can also be put in the player's inventory. For testing purposes, one is added to the player's pockets every time the game starts.
    Sample Character
    Use this as a starting place for your own characters! Contains template artwork for character animations, saveslot portraits, and more! Note: This will require TEX tools in order to create .tex files from the provided .png images.
    Also note that the template for the bigportrait is in it's own zip file for download size reasons, but both samplecharacter.zip and samplecharacter_bigportrait.zip together make the Sample Character mod and templates.
    Sample Mod
    A demonstration of very basic mod setup, including attaching a custom components and setting tuning variables.

    145114 downloads

    44 comments

    Updated

  11. Handsome Matt's Tools!

    These are some super simple tools I made for Don't Starve years ago, recently updated and re-uploaded myself seeing how popular they were. I still believe you should use the official tools for texture creation, but for simply viewing and exploring assets this tool should work great for you.
    Source code and latest releases are always available on GitHub.
     
     

    74108 downloads

    64 comments

    Updated

  12. Music Mod Guide (DST)

    This is a music mod guide for Don't Starve Together that can also be used for Don't Starve. It is created by me, and contains links to other files needed. This is a current guide and should help more than the extremely outdated one from 2011. 
     
    Search me up on Steam to see my music mods. My Steam name is TheScraps

    716 downloads

    6 comments

    Submitted

  13. Domo's Don't Starve Character Creator

    This is the download page for Domo's Don't Starve Character Creator tool.  It is a plugin for Adobe Flash, and requires that you have Adobe Extension Manager installed.  Instructions on its use can be found here.  Enjoy!

    1775 downloads

    3 comments

    Updated

  14. OmniKey

    OmniKey
    A Don't Starve Together Mod. Add keybindings to use with tools, weapons, armor and much more.
    Usage
    Keybindings can be changed in the configuration:
    Default Key Function G Equip best weapon by damage C Equip best armor V Equip best helmet 1 Equip best axe 2 Equip best pickaxe 3 Equip best shovel 4 Equip best scythe, requires scythes mod H Use best healing item J Eat food Also when unequiping the hand slot using the keybindings it automatically equips a cane if available
    Installing
    Download latest release from github

    28 downloads

    0 comments

    Updated

  15. CaseReplace Tool

    Description
    This contains a little tool called CaseReplace that I whipped up because I got tired of using search & replace with different letter cases when renaming characters for Don't Starve.
    It runs a search & replace process, replacing one name with another in all the relevant files while preserving case (so, for example, "oldname" will become "newname" while "OLDNAME" will become "NEWNAME").
    It also renames all the files and directories accordingly (this can be turned on or off).
    I bundled a batch file named RenameDSCharacter with it which runs the script using the parameters you would normally need in order to make the replacements for a standard Don't Starve character (it basically searches everywhere except zip files).
    IMPORTANT NOTE
    This tool performs a simple search & replace. It doesn't know that you only want to change text when it's referring to a character name.
    Therefore the name you replace needs to be unique and only appear when as the name of that character!
    If your character is named "e" and you run this tool to replace "e" with "a" you'll most certainly break your mod and nothing will work.
    Also, this tool has no undo option (replacing "a" with "e" won't undo it), so it's highly recommended you back your files up before using it.
    I have tested it but not rigorously, so it's best to make a backup before running this.
    I will not be held responsible for the loss of your work or data as a result of using this tool.
    Usage
    You need Python 3 to use them, so if you don't have it and you want to use this tool, go get it.
    I was using Python 3.6.6 when I made it but it's probably OK to use any version of Python 3.
    To use it, first extract it into your mod folder.
    Now you have two options:
    Double-click the file called RenameDSCharacter.bat and when prompted enter the name of the character you want to replace followed by the new name you want it to have (it asks you for those two; just follow the instructions). Run RenameDSCharacter.bat from command prompt and give it the current name and the new name as parameters (in that order). If you really want to, or if there's a problem making it get to the right files or something, you can also use the CaseReplace script directly.
    To do that, go to the folder in command prompt and type "python CaseReplace.py" (no quotes) followed by the parameters you want.
    You can run "python CaseReplace.py --help" to see a list of parameters 
    Enjoy your modding. =)

    28 downloads

    1 comment

    Updated

  16. KTEX+XML Decompiler

    Simple Java application that allows its user to split the contents of Klei's TEX files using their respective XML atlases. In other words...
    Using it is simple:
    - The first text field is for the XML file. It usually has the same name as the TEX file and is found in the same folder.
    - The second text field is for the PNG file. The tool will accept TEX files if it is put in the same folder as simplex's ktools.
    - The third field is for the output folder. All images contained in the PNG/TEX will be put there when they're extracted.
     
    As I've previously mentioned, this tool does NOT convert TEX files to PNG. It will make ktech from ktools do so if they are in the same folder. The second field's label will change from  to  if ktech.exe is detected.
     

    175 downloads

    2 comments

    Submitted

  17. Extended Sound Mod Tutorial

    Based on this:
    This project is a complimentary one to help you understand FMOD, and to give you an idea of how to make complex sounds.
    Open the README.txt for more info.

    67 downloads

    0 comments

    Submitted

  18. [Library] Client Data

    library that sends data between the clients without server code. This is very useful when you want to create a client mod and send something to other players with your mod. You can find how to use it here:
     

    26 downloads

    0 comments

    Submitted

  19. Klei Tools

    Hello Guys so i was working on a project which allows you to convert animation to scml with one file 
    it creates scml,textures and back ups the anim in the .zip
    The Pack Includes Following Things: FMOD Studio,Texmod,Krane Converter,Spriter and some of my old scripts  including old throne
    Folders on Screenshot: Textures - Extracted Textures
                                               Input - Put .zip files in here
                                               Output - Has the converted scml ready to open with spriter
                                               Texmod - Creating of .tex and Viewing it
                                                FMOD Studio - Allows to edit audio to make it work with klei games
                                                Spriter - Studio for Animating 
    And don't forget about reading ReadMe.txt  
    Newest Version Can be found here
    https://gitlab.com/CliffW/Klei-Dough-Tools
     
     
     
    Klei Tools.rar

     

    685 downloads

    8 comments

    Updated

  20. Save game of base demonstrating a few advanced concepts.

    This is an example I was asked to provide for a reader on the subreddit. It is a bit starved for power approaching the late game but otherwise demonstrates some management and automation concepts, as well as a solid format for a modular base. Download, critique, whatever.

    53 downloads

    0 comments

    Submitted

  21. Spriter Example: Equippable Item

    This is an example of an equippable item made in Spriter. This example requires the pc version of the Steam Workshop 'Don't Starve Mod Tools' to be installed.
    Big thanks to the Waverly Mod Team for letting me use their art!

    3796 downloads

    9 comments

    Updated

  22. TextureConverter

    This is Klei's internal tool for converting textures into our in-game format.
    NOTE:
    This tool comes with a big Buyer Beware! This is a development tool and not end user friendly. As you've discovered there is virtually no error checking because we use it in a very narrow set of circumstances and those are well debugged.
    Also please note the game engine only supports ARGB/DXT1/3/5.
    Hey all,
    I see that many of you are looking to create .tex files for the game to load. I've discussed it with the team, and we're releasing our own Texture Converter for you to use.
    Have fun!
    USAGE:



    Discuss this Mod

    1652 downloads

    5 comments

    Updated

  23. Language Sample Mod

    This mod demonstrates how to set up a language pack to be compatible with the mod system and with Steam Workshop. Language packs distributed this way will be easier to everyone to install and update!
    For more information on creating a language pack, please read this thread.

    2411 downloads

    9 comments

    Updated

  24. Custom Tile Adder

    This mod can be used as a template for custom ground tiles for Don't Starve Together. I use it in the Green World. The main logic implemented in two files:
    tileadder.lua — provides two functions: AddTiles() and AddMinimap(); tiledescription.lua — contains parameteres for new tiles. Function AddTiles() should be called from the modworldgen.lua, function AddMinimap() should be called from the the modmain.lua. Ground ID is not required, the tile adder calculates it automatically; this provides high compability with any other custom tile mods. Turf prefab is also generated by the tile adder, but you need to set build/icon/anim/any other prefab data with AddPrefabPostInit() function in the modmain file.
    Five steps to add new tile:
    Pick the name for you tile; Place ground texture (resolution 512x512, name «noise_yourtilename») and minimap texture (resolution 256x256, name «mini_noise_yourtilename») in the «images/textures» folder; Add string «yourtilename = { }» to the tiledescription.lua file; Add AddPrefabPostInit() function to set inventory images for your tile; Test it! More information you can find in the tiledescription.lua file. As an example, two custom ground tiles (Jungle and Tech) are added. 

    95 downloads

    2 comments

    Updated

  25. Don't Starve Lunar Calendar In Javascript

    Save this html file to your desktop and open it in a browser. It will automatically generate a calendar of Don't Starves moon cycles going out to day 200. Input whatever day you want moon cycles calculated out to.
    Notes:
    I don't actually care if you put the file on your desktop or not, just put it somewhere that you can find it and open it.
    Pigs will turn into werepigs on a full moon. Werepigs are very bad piggies and will likely attack you and kill you for no reason. This is also when woody becomes the doom incarnate of all vegetation.
    The latest day I tested successfully was day 50,000. It was a very long calendar and the scroll-bar thingy was very small. If you intend to not starve for longer then 50k days then you may need a longer calender.
    Internet Explorer may block content from the lunar calendar. It's blocking Javascript which is the programming language used to generate the calendar. I promise it won't hack your computer and install pop-up advertisements for "Over 100 horney chicks in your area can't wait to chat with you right now!"
    This script won't hack anything at all actually. It's not a hack, it just makes a calendar. Just go ahead and hit "run script" or open it in Firefox instead.
    While transformed into a werebeaver, you should refrain from eating the berry bushes you planted earlier that day. Bad Werebeaver! bad. bad. bad. You go back to the firepit and starve back into Woody right now!
    Leave comments if there's some functionality you would like added to this calendar. Making it was kinda fun.
    Don't Starve.

    2782 downloads

    7 comments

    Submitted