Modding Tools, Tutorials & Examples

83 files

  1. Animation Commandline Tool

    Tool to convert binary animation and build files to text and then back to binary again.
    Included:
    EXE command line program
    README explaining the format
    SampleAnimMod sample using custom files & raw files used to generate the sample
    Warnings:
    Not tested with every file
    Not tested on other computers
    Unlikely to work on non-windows machines
    Known Issues:
    The current sample_prefab build.bin (missing text name in build file)

    722 downloads

    8 comments

    Updated

  2. 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,879 downloads

    4 comments

    Updated

  3. Tiled - tileset

    Updated version of Kzisor's tileset for the modding program "Tiled". Usage is explained thoroughly in Jack Slender's (outdated) tutorial thread. Keep in mind that this tileset is 64x64 before creating your setpiece and importing it!
    Explanation:
    All tiles up until the first "wall" are basegame surface. All tiles after the first "wall" and before "fake" are basegame caves. All tiles from "fake" on are shipwrecked (not available in DST). "WALL" tiles are invalid, as they aren't meant for flooring. "FAKE (DST)" is the fake floor in DST (used in Atrium), but the beach sand in sW. "Lava" is defined as volcano lava, but doesn't actually exist. The empty purple frames are undefined and thus invalid. The tiles should all be recognisable, feel free to ask if unsure.

    163 downloads

    1 comment

    Updated

  4. Wod Better

    To anyone using this mod to create their mod leave a comment here or
    here http://forums.kleientertainment.com/topic/33507-wod-better/
    that will allow me to put your mod in a list of "mods helped"

    1,170 downloads

    5 comments

    Submitted

  5. 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,887 downloads

    5 comments

    Updated

  6. Sample mod: Custom tile/ground types

    This mod shows how to add a custom tile (ground) type to the game, to the map and minimap.
    The actual work is encapsulated in the file tile_adder.lua, which may just be plopped into your mod and modimport'ed. It exports the function AddTile(), whose usage is exemplified in modworldgenmain.lua (note, however, that the tile texture assets must be declared in modmain.lua).
    As an example, a new tile type GROUND.MODTEST is added. The mod will also spawn in the player's inventory an infinite turf item which places the new tile type (to make testing easier, it does not require digging up the original turf with a pitchfork).
    WARNING!
    The numerical id passed as the second argument to AddTile (which becomes the value of GROUND.YOURNEWTILETYPE) must be unique, not conflicting with with game's own values (specified in vanilla's constants.lua) as well as with other mods. It must also be less than 128 (the value of GROUND.UNDERGROUND), otherwise the game assumes the new tile represents a wall type. The AddTile function checks the given numerical id for validity, raising an error if the check fails. With regard to intercompatibility between mods adding tiles, it is important to choose numerical ids not conflicting with the choice of other mods. Ideally the ids would be generated automatically and stored/restored as map savedata, but since mods run before any savedata is loaded this would add a number of pitfalls for the modder to be aware of, and generally increase the complexity of the code required for adding a new tile, so I kept the manual specification. The sample tile is added with an id of 80, while Up and Away uses consecutive ids starting from 64.

    354 downloads

    6 comments

    Updated

  7. 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,604 downloads

    0 comments

    Updated

  8. Music Mod Tutorial

    This tutorial will teach you how to create a mod which replaces the music in 'Don't Starve'. For this tutorial, we're going to replace the main menu music.
    To follow this tutorial, download and extract this mod to your 'mods' folder and jump to the tutorial page here.

    1,060 downloads

    1 comment

    Updated

  9. Season Calendar

    As I found Lunar Calendar from darkestaxe some days ago I found it very useful. But I couldn't find any calendar, table, chart or whatever for the season cycles, neither here nor elsewhere on the net. So I decided to write my own in MS Excel.
    Feel free to change the worksheet and the script to your needs.
    Update:
    Thanx for the nice comments.
    F... this voting system. I accidentally gave myself 2 stars and can't adjust this anymore Please could some users who like my tool vote for it?
    Update 2:
    Hopefully this version is the final one.
    Thanx for voting.
    LAST update:
    Due to the amazing Season Clock mod my tool is obsolete:
    http://forums.kleientertainment.com/files/file/862-season-clock
    Thanx again for all your feedback.

    881 downloads

    6 comments

    Updated

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

    9,264 downloads

    8 comments

    Submitted

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

    3,302 downloads

    9 comments

    Updated

  12. Hat Example

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

    1,595 downloads

    11 comments

    Submitted

  13. Example: Follow the Leader

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

    1,406 downloads

    9 comments

    Updated

  14. Example: Code Tips and Tricks

    A working example of the tips/tricks detailed in this thread: http://forums.kleientertainment.com/index.php?/topic/29599-code-tips-and-tricks/

    469 downloads

    2 comments

    Updated

  15. 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,975 downloads

    6 comments

    Submitted

  16. Mod Testing Toolbox (RoG compatible)

    The mod formerly known as "simplex testing".
    Its goal is to aid in mod testing (being aimed at modders), focusing on being extensible through custom code to suit a particular purpose.
    To add custom code, place it in a file inside submodules/ and add that file's name (minus the ".lua" extension) to the Submodules.Include call in modmain.lua. Such code will have access to the variable imports performed in imports.lua and the conveniences defined in conveniences.lua, alongside the usual mod environment capabilities.
    The default submodules do (at least) the following:
    Enable debug keys.
    Add a new row of buttons to error screens, with a button for reloading the game state (like the previous mod) and another one for going straight to the main menu (without any saving).
    Run consolecommands.lua and export a few additional console utilities, listed below.
    Export an utility function called regen_level(), which regens the current level (erasing it).
    The additional console functions are:
    This mod will be listed as outdated in the Steam version. This is necessary to keep compatibility with standalone.

    1,189 downloads

    5 comments

    Updated

  17. Sample Tech Branch (RoG compatible)

    Sample mod showing how to add a custom tech branch. In this example, the fire pit is used as the prototyper for a recipe of rocks (in the Magic tab).
    Due to a game change made to have recipes not requiring a prototyping structure cease to be prototypable (see this), unfortunately it was necessary to override the method Builder:KnowsRecipe() from the Builder component. More generally, the hardcoded logic in the Builder component prevented this implementation from being as clean and simple as I'd like. It is functional, nevertheless.
    Thanks to Heavenfall for originally looking into this.

    220 downloads

    7 comments

    Updated

  18. Crock Pot for Modders

    From Modder for modders.
    With these files the food out of the crock pot will be visible in the game. It's probably enough for a description.
    Compatibility: there are no problems with the other mod
    Contents:
    files needed for the mod (catalogs)
    information on how to install (install_how_to.txt)
    guide on how to use (tutorial.pdf)

    I wish you all a great amount of mods. If you have any questions, please write to priv or leave comments.
    Guide is also available on forum: http://forums.kleien...l-modification/

    941 downloads

    6 comments

    Updated

  19. 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,580 downloads

    5 comments

    Updated

  20. 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,650 downloads

    7 comments

    Submitted

  21. 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,315 downloads

    9 comments

    Updated

  22. Example: Cookpot Fix

    This is obsolete! This mod's changes have been incorporated into Don't Starve as of the May 24th, 2014 patch (Rev. 102535)
    An example mod that implements a fix for modded crockpot recipe results being invisible.
    See this thread for more information.

    984 downloads

    3 comments

    Updated

  23. Sample - Mr Smiley

    This is just a sample of a spriter file which creates an anim that is compatible with hats.

    399 downloads

    1 comment

    Submitted

  24. 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,703 downloads

    20 comments

    Updated

  25. 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,580 downloads

    11 comments

    Updated