Modding Tools, Tutorials & Examples

83 files

  1. use(): a require() for mods

    Based on this thread, I decided to write a version of require() for mods. The use() function works just like require(), but looks for files taking the (root) mod directory as a base and runs them inside the mod environment.
    Feel free to just drop use.lua into your mods. Below is some documentation on its behaviour, and I attached a simple sample mod ("usage") to show how to use it in practice.
    Basic usage:
    Advanced usage:
    Why "use" and not "modrequire"?

    183 downloads

    0 comments

    Submitted

  2. Speech Mod Template

    Back by my insistence, the Speech Modification Template!
    This file contains all you need to easily make speech file modifications on existing characters, or to make ones completely out of nothing for a custom character. Or even add or change quotes for Lucy or Pigmen!
    And now, it is fully updated both for the latest version of All's Well That's Maxwell, and the Reign of Giants "Feet of Strength" updates!
    I am merely continuing the work WrathOf started, but couldn't keep up with as he passed into inactivity. If he comes back one day and asks me to take this down, I will have to, i'm afraid. But until then, here you go. A nice little modder's tool.
    How to use:
    Download the proper file. If you're using the DLC, then you want version 1.6. Otherwise, stick with 1.5.
    Extract the zip file, then open the ExtraEnglish.lua file. Everything you need is there, all the generic describe quotes are alphabetized.
    Let me know if I missed anything important, or if there are some items missing from the template.

    1,066 downloads

    3 comments

    Submitted

  3. 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,537 downloads

    1 comment

    Updated

  4. 17 comments

    Updated

  5. [Tool] Thomas's Mod Manager V.1.0 [Rel]

    Thomas


    Don't Starve Mod Manager

    (Originally Known as Don't Starve Mod Installer, But I Did a complete Rewrite)
    Ladies and Gentle Starvers, I Present to You..

    Cool logo and all, but what Does this do you say? Well...
    Install Mod From .zip
    Install Mod From Normal Folder
    Uninstall Mod -- Currently Unavaliable
    Check Mods are Compatible -- Currently Unavaliable
    Run Don't Starve from Program
    Open Don't Starve Forums in Default browser
    (Only Compatible With Steam and Windows due to How Finding File Works and I have no idea if Visual Basic programs work on Linux or Mac.)
    Is that all you say? Well for now yes. But Not forever. Some when I will be adding new features based on suggestions and feedback, so if you have any then I want it!!!


    How To Use

    The Layout of the program is pretty Simple (as shown in the spoiler)



    Forum Thread Here >>

    610 downloads

    0 comments

    Submitted

  6. Speech Mod Template -- v1.3 -- WINTER UPDATE

    WrathOf
    Provides an "english_master.lua" version of my "english.lua" template file based on the "strings.lua" organization with a lot more string settings listed for all characters.
    This can be used as a starting point for creating speech mods without changing the game's "strings.lua" file and enables you to define more character specific speech than what is provided in the "strings.lua" file.
    Notes:
    ** This is now designed to use the new mod loading system without you needing to change your existing speech file based on my previous template.
    ** Refer to the "Speech Changes for DS Winter Update.txt" file for the new items you can copy/paste to your existing file in order to upgrade it for the Winter Update
    See discussion thread below for more information.

    Features:
    * Complete list of all available speech settings for all characters.
    ( and you thought you had enough already! )
    * A few "corrections" to some speech settings for consistency across all characters
    * Comments in the file on how to add more pigman talk, tombstone epitaphs and pigman names
    * Now includes speech from A Winter's Tale Update
    Game Version:
    Revision 73662 2013-02-26_10-21-53
    Use:
    Read top portion of the provided README, modmain.lua and english_master.lua files for current information.
    In the file, remove the "--" comment characters in front of any speech setting you want to activate.
    When you are done you might make a copy of the file for distribution and remove all of the commented out lines in it. That way other players can see what you have changed more easily.
    Please revise the top comment block in the file to reflect your mod's information but do leave a credit to me and the version of my template you used for support purposes. Thanks!
    Changelog:


    Support:
    Discuss this Mod

    139 downloads

    0 comments

    Submitted

  7. blow darts 50 remod

    this is a version remod of liao
    http://steamcommunity.com/profiles/76561198133238113/myworkshopfiles/?appid=322330

    790 downloads

    5 comments

    Submitted

  8. Spider Companion Animation Fail Sample

    Do not download unless you're trying to help me, haha. There is a steam version of this currently working if you are interested. This one is not for entertainment purposes.

    115 downloads

    1 comment

    Submitted

  9. Webber-Themed Animated Cursor Pack

    Express your love for our hairy little friend with this brand new
    Webber-Themed Animated Cursor Pack
    Including 15 Cursors inspired by my favourite Don't Starve Character!
    Precise enough to use at work and the survival-y feel of your favourite
    game is finally complete with this original handdrawn Cursor Pack!
    Also check out my other Cursor Packs!
    Cheers, Jules
    Follow this link for a tutorial on how to install the cursors. Thanks to @iMCrafter

    525 downloads

    6 comments

    Updated

  10. The Forge Creatures

    The Forge Creatures. Boarrior not included.
    Boaron Peghook Turtillus Elemental Snapper Boarilla Prefabs "strange_scorpion_tfc", "lizardman_tfc", "spiky_turtle_tfc", "hatty_piggy_tfc", "flame_elemental_tfc", "spiky_monkey_tfc"
    Creatures weren't full tested or balanced in normal game.
    May be someone can use it.

    302 downloads

    2 comments

    Updated

  11. Character custom voice tutorial and custom item sounds

    Note: this file will not run as a independent mod, its more of a toolbox if anything. Also its recommended to have some modding experience as the tutorial isn't beginner friendly.
    This file is a tool box and template for making custom character voices and other item sounds as well. It contains a few common armor, structure, and weapon sounds that the base game uses, along with notes about them that may prove useful. The code is preset to follow the lua files stored inside so its less of a hassle trying to start from scratch. Last this file is subject to updates to keep up with don't starve together adding more types of voices like emotes, pose, and ghost voice.
    Tutorial:
     

    173 downloads

    0 comments

    Updated

  12. Test Mod

    modinfo.lua
    modmain.lua

    31 downloads

    0 comments

    Updated

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

    75 downloads

    2 comments

    Updated

  14. TEXTools: Mac Port

    These are Mac versions of Handsome Matt's mod tools, TEXCreator and TEXTool. All I have done to them is wrap them in Wine and added icons. They work on my machine, and hopefully they will work on yours.
    The wrapping process unfortunately makes the files very large (~400mb unzipped), so I have compressed and split the files to be able to make them available here. If you would rather make wrappers yourself instead of download them, the process is very easy.
    1. Download and open Wineskin Winery as well as Matt's tools (above).
    2. Create a new blank wrapper using the latest engine (I used WS9Wine1.9.21). For simplicity's sake, you can only run one file per wrapper, so name it TEXCreator or TEXTool depending on what you're after.
    3. When prompted, say YES to installing Mono (which emulates the Microsoft.NET framework necessary to run the programs, and is why the files are so large) and NO to installing Gecko.
    4. When done, open the resulting wrapper. You should get a dialogue that has an "Install Software" button on it. (If you don't, option-click on the wrapper, select "Show Package Contents," and click on Wineskin.app.
    5. In the next dialogue, click "Move a Folder Inside," browse to the folder containing Matt's tools, and select it.
    6. When prompted, pick the appropriate EXE for the wrapper you are creating.
    7. Close all Wine dialogue buttons, and try opening your app. If all is well, the programs should run and behave the same way they do on Windows. I know very little about Wine and if you have problems, I cannot help you resolve them.
    I hope you find these programs useful!

    510 downloads

    0 comments

    Updated

  15. Critcode

    This code is designed for Don't Starve Together to allow for critical hits and items with critical hit properties.
    By design this allows all mobs the potential to be able to crit if they have crit chance greater than 0
    Using inst.components.combat:SetCrit(critchance, critdmg, critfn) we can define a basic crit settings for a mob.
    Currently equipment have crit variables as inst.variables rather than component ones.
    Some fun examples if you have a hat that has crit chance, we can give it to a pigman and he'll be able to crit.
    Currently tested on a caves enabled server and works as advertised.
     
    Suggestions and bugs found for improvements welcome.

    16 downloads

    0 comments

    Updated

  16. Sample mod: Savable Infinity

    This sample mod provides a file, savable_infinity.lua, which when modimport'ed allows storing correctly the following numerical values as savedata:
    Plus and minus infinity (i.e., math.huge and -math.huge);
    NaN (Not a Number, i.e., the result of invalid arithmetical operations, such as 0/0).
    The game's save system is patched transparently, so other than modimport'ing savable_infinity.lua no other steps need to be taken: simply feel free to store the above values in savedata.
    The patching of the game's DataDumper function uses the fact that Don't Starve's savedata is simply Lua code to store these values as arithmetical expressions: plus infinity is saved as 1/0, negative infinity as -1/0 and NaN as 0/0. The method used for the patching is more hackish than I would like (making heavy use of Lua's debug library), but it is the cleanest method of doing so I could think of, other than simply overriding vanilla's dumper.lua.
    The rest of the mode code, beyond savable_infinity.lua, is just a test suite to see the added functionality in action.
    The file savable_infinity.lua is modimport'ed in modworldgenmain.lua, so that all savedata is stored correctly (but it can safely be modimport'ed in modmain.lua instead, if worldgen savedata is not a concern).
    In modmain.lua, the global variable ENCODE_SAVES is set to false, causing save files to be stored as plain Lua instead of zip compressed Lua, allowing visual inspection of the saves' contents. Furthermore, modmain.lua adds the included infinitysavetest component to the world entity: this component simply returns the mentioned values in its OnSave method and checks the validity of the loaded savedata in its OnLoad method, which prints the following to log.txt:

    ../mods/SavableInfinity/scripts/components/infinitysavetest.lua(17,1) Running InfinitySaveTest:OnLoad() for [100013 - cave] ../mods/SavableInfinity/scripts/components/infinitysavetest.lua(28,1) Testing savedata entry 'positive infinity'... PASSED ../mods/SavableInfinity/scripts/components/infinitysavetest.lua(28,1) Testing savedata entry 'negative infinity'... PASSED ../mods/SavableInfinity/scripts/components/infinitysavetest.lua(28,1) Testing savedata entry 'NaN'... PASSED ../mods/SavableInfinity/scripts/components/infinitysavetest.lua(30,1) Ran InfinitySaveTest:OnLoad()

    202 downloads

    8 comments

    Updated

  17. Wod Renamer

    There may be a lot of unforeseen bugs with this. I hope not, but if you want to use it to refactor a previously code-named character, please BACK EVERYTHING UP.
    The primary purpose of this tool is to rename all the character identifier WODs and wods in the sample character template to a codename picked by you. This isn't the descriptive name, just the identifier used to reference your character. Occasionally, if you discover your name isn't unique, you may need to use this to alter the internal codename to not interfere with another modder's mod.
    STEPS:
    1) Download the Sample Character ( I like to use the steam workshop version )
    2) rename (or copy-rename) the folder from workshop-169568662 to taste.
    3) run WodRenamer
    4a) "Open!" the modmain.lua within the previously renamed folder.
    4bOi) If you're not refactoring the character detected, and instead refactoring a different prefab: type the prefab's internal name into the lower inputbox.
    4bOii) In the case of item, uncheck "character prefab" and check "item prefab"
    4bOiii) Click "Override!" (Right side text dump should show what files fit the pattern.)
    4c) If it looks like it found the right files, Type the desired codename in the lower input box, and click "Rename!"
    Known issues:
    Issue that just occurred to me: When using override -> rename WodRenamer won't check the lua files that reference, but don't include the name submitted. I'll have to fix that.

    123 downloads

    0 comments

    Submitted

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

    50 downloads

    0 comments

    Submitted

  19. [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:
     

    19 downloads

    0 comments

    Submitted

  20. Persistent Data

    A module that can store, save, and load any arbitrary data.
    For developers only! Don't expect it to do anything interesting in-game.
    Download contains:
    persistentdata.lua - The module. Put this in your mod's scripts folder.
    PersistentDataExample_v1.x.zip - Example usage of the module with comments
    See the example for information on how to use it.
    Mods that currently use it:
    Mod Manager - by Blueberrys
    Feats of the World - by debugman18
    Previously posted here.
    Everything provided here is public domain. No warranties for anything. Blah blah blah. Use it however you want!
    Attribution would be appreciated, but is not required.

    508 downloads

    3 comments

    Updated

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

    96 downloads

    2 comments

    Submitted

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

    39 downloads

    0 comments

    Submitted

  23. HUD Hotkey

    Feel almighty as you toggle the GUI at the push of a button.
    Configurable in-game to set your own shortcut.

    101 downloads

    0 comments

    Submitted

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

    1,370 downloads

    3 comments

    Updated

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

    512 downloads

    5 comments

    Submitted