Modding Tools, Tutorials & Examples

78 files

  1. 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.

    139,250 downloads

    40 comments

    Updated

  2. 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.
     
     

    67,029 downloads

    61 comments

    Updated

  3. 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.4.2 - 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

    63,706 downloads

    102 comments

    Updated

  4. Map Revealer 1.0.3 and [DST] Map Revealer 1.0

    It's a very simple mod revealing the entire map in the game, regardless of the level at which we find ourselves. Despite the simplicity makes it easy modding or just makes the game lot easier.
    Have a nice use.
    Steam version: http://steamcommunity.com/sharedfiles/filedetails/?id=225675650&searchtext=

    46,674 downloads

    27 comments

    Updated

  5. N Tools

    N Tools adds six clickable button to the HUD for testing utility.
    Time Jump
    Moves the time of day/night one step.

    Time Jump +
    Move you forward five days time.

    Start/Stop Precip
    Starts or stops rain and snow.

    Go Invincible/Vulnerable
    Toggles invincibility.

    Go Insane/Sane
    Sets sanity to zero or full.

    Dig
    This button allows you to dig through the game variables and sort them by variable type as well as looking at each tables children. All of this in a visual UI.

    Wish
    This button allows you to grant items to your character for easier testing.

    12,412 downloads

    27 comments

    Updated

  6. 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!

    10,166 downloads

    8 comments

    Updated

  7. Smarter Crock Pot

    Steam Workshop Link: https://steamcommunity.com/sharedfiles/filedetails/?id=596800985
    Compatible with DS, ROG and SW.
    Original link: https://steamcommunity.com/sharedfiles/filedetails/?id=222342168
    Fixed by zUsername.
    Created by Nadav.

    9,812 downloads

    8 comments

    Updated

  8. TEXTool v1.2

    TEXTool v1.2 by Handsomematt
    Converts Klei .tex files to .png
    Re-uploading this because it seems to be unavailable. Hope it's ok and the original author did not want it taken off.

    8,498 downloads

    8 comments

    Submitted

  9. Supervivencia Natural



    -Supervivencia Natural-



    Contenido de MOD´S

    Always On Status
    Architectural Geometry
    Auto planting
    Damage Indicators
    DisplayFoodValues
    Follower Badges
    FOV
    MemSpikeFix
    MinimapHUD
    More Map Icons
    Seasonclock
    Sort Inventory
    Spanishv7.0DLC
    Wormhole Marks



    -Supervivencia Natural-



    El Paquete trata solo con unos cuantos mods que no alteran la



    dificultad con del juego, si no solo cosas visuales que ayudan



    de una manera sin afectar a el juego.



    Los mods yo no los he creado, solo son una recopilación de ellos.



    Echo por: OblanquitO

    7,569 downloads

    11 comments

    Updated

  10. 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.

    7,499 downloads

    95 comments

    Updated

  11. Easy Character Art Template

    This is a template character for Don't Starve. Instructions on how to use this template can be found here.

    3,643 downloads

    4 comments

    Updated

  12. 17 comments

    Updated

  13. Minimap Icon Sample

    This is a simple sample mod for adding your custom minimap icons. Nothing fancy, but the more samples the better.. I guess.

    2,941 downloads

    6 comments

    Submitted

  14. 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!

    2,836 downloads

    9 comments

    Updated

  15. 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

    2,655 downloads

    20 comments

    Updated

  16. 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.

    2,557 downloads

    7 comments

    Submitted

  17. Weapons armour values

    Show all the values releated with weapons, armour, tools.
    Make more or less the same that detailed tooltips and values plus
    enjoy

    2,380 downloads

    1 comment

    Submitted

  18. 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.

    2,232 downloads

    9 comments

    Updated

  19. Sample Animation

    This is an example of how to create a custom character animation. Instructions on how to use this example can be found here:
    Tutorial: Adding a Custom Idle Animation

    1,839 downloads

    5 comments

    Updated

  20. Creature Mod Tutorial 1 - Creating a Mod

    This tutorial shows you how to create your very own mod!
    Instructions on using the tutorial:
    1. Download and extract the mod to your mods folder.
    2. Open and follow the instructions in 'readme_tutorial_1.txt'.
    Happy modding!

    1,568 downloads

    0 comments

    Updated

  21. 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

    1,523 downloads

    5 comments

    Updated

  22. FutaraDragon DS Tex To AtlasXml Converter

    For Don't Starve Modder Quick Build Xml from tex file for Don't Starve Update
    FutaraDragon DS Tex To AtlasXml Converter V0.0.0.26
    Create By FutaraDragon
    Installation
    when your download finish your must rename to the original file name.
    example when your download finish the file name is "1704-fddstextoatlasxmlconverter.part1.rar " your must rename to "fddstextoatlasxmlconverter.part1.rar " and other part must rename before extract it
    - Download All File and Extract by part 1
    - None Install (Can use when unrar)
    How To Use
    1. Open Program.
    2. Select Folder has tex file inside.
    3. Press Convert Button
    4. The Program Will Create xml for all of file name with format ".tex"
    5. Start Write your code again -0- (I HAVE ALL XML FILE ALREADY!!)
    AboutProgram
    For Build xml file only support for u1="0" u2="1" v1="0" v2="1" image picture
    What I'm doing https://www.facebook.com/FutaraDragonSoftware
    My FaceBook Here https://www.facebook.com/FutaraDragon
    DiscussHere if found bug or talk about this tool >>

    1,486 downloads

    1 comment

    Updated

  23. Creature Mod Tutorial 8 - World Spawning

    This tutorial shows you how to have your creature spawn throughout the world!
    Instructions on using the tutorial:
    1. Download and extract the mod to your mods folder.
    2. Open and follow the instructions in 'readme_tutorial_8.txt'.
    Happy modding!

    1,467 downloads

    6 comments

    Updated

  24. Hat Example

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

    1,426 downloads

    11 comments

    Submitted

  25. Example: Follow the Leader

    This script example makes all creatures you come across in the world follow you.

    1,368 downloads

    9 comments

    Updated