Jump to content
  • The forum downloads section will be removed on Jan 1st 2023. Players may still download mods that are currently hosted, but new submissions are no longer being accepted. Mod makers are advised to relocate their mods to alternative hosting solutions.

Modding Tools, Tutorials & Examples

88 files

  1. Smashtemplate

    This is a template fighter for the Smashup mod for Don't Starve Together! 
    Smashup mod can be found here: https://steamcommunity.com/sharedfiles/filedetails/?id=2701285237
    Download and follow the guide in MODDING_GUIDE_README.lua
    Follow along with video tutorials: https://youtube.com/playlist?list=PL0je6QsFGE5DhpTPLc-w7wIWysRgfAyEL
     

    132 downloads

    4 comments

    Updated

  2. PyWitch: Twitch Chat Integration

    THIS MOD REQUIRE EXTERNAL TOOLS TO WORK, FOLLOW THE INSTRUCTIONS CAREFULLY!
     
    PyWtich: Twitch Chat Integration
    This mod uses from a external tool called PyWitch Client to capture Twitch events, like chat messages, and show these events in-game.
    For this version, only chat-messages are being integrated.
    Everything is open source, so you can check PyWitch, PyWitch Client and PyWitch Auth in my Github!
    How to use
    First, you need to download PyWitch Client from the RELASES page in my Github. You can do so by clicking this text
    I strongly recomend you to download it from source and run it using Python
    After downloading and openning it, read the EULA. Since PyWitch Chat read from your Twitch Chat, your authorization will be required in the next step.
    If you agree with the EULA, PyWitch Client will be ready to use.
    Now you need to write your channel in the "channel box" (you can find your channel by acessing it on Twitch and reading the current URL).
    Feel free to disable all features, leaving only PyWitch Chat enabled. The other features will be avaible in the following versions of this mod.
    After that, click "Start PyWitch Server". Now a tab in your browser will be open, requesting authorization. This authorization is necessary to PyWitch Client be able to read your chat messages.
    The authorization will redirect you to a tab with the name of all streamers that are using PyWitch Auth! Please consider visiting and supporting these Streamers channels!
    For safety reasons, after you get your token from PyWitch Auth, it will be destroyed from the server, so if your token become invalid, a new one need to be generated.
    Now, just wait for PyWitch Client to establish connection with Twitch server and its done! You can verify its working by acessing the following localhost URL:
    127.0.0.1:13846/tmi
    If you see an empty json "{}", PyWitch Client started correctly
    Now, send a message in your Twitch Chat and hit the refresh button in the PyWitch Client TMI URL.
    If everything is working fine, you will see an json with your message and display name.
    And its done!
    In game, you just need to install the mod to your server and, in-game, open the PyWitch Menu by click its logo in the bottom left corner and hit the "Activate" button!
    Now you will see the following Twitch Chat messages in your game!!
    Upcoming features
    As you can see from PyWitch and PyWitch Client, it already has some extra features. In the upcoming versions of this mod you will be able to capture Twitch Chat Redemptions in your server, making unique events and interactions to your game!
    How it work
    Don't Starve Together provides an internal function to perform REQUESTS on HTTP servers, which is very great to access data from server. However, Twitch Events, like chat messages and chat redemptions can only be accessed by WebSockets.
    So, I developed a Python library to capture these events from Twitch. This library is called "PyWitch", and its source can be accessed by the following URL:
    https://github.com/ouriquegustavo/pywitch
    Ok, we are able to recover Twitch Events using a Python script... But we need to transfer that to Don't Starve Together.
    To do so, I developed PyWitch Client, which is a GUI Interface combined with Web Framework (Flask). Its main purpose is to get events from Twitch using PyWitch and provide them on a localhost endpoint using Flask. Its source can be accessed by the following URL:
    https://github.com/ouriquegustavo/pywitch_client
    Now we can access Twitch Events from an HTTP server provided by PyWitch Client, the only remaining thing to solve is the token authentication.
    Token authentication is made server side PyWitch Auth, which the source can be seen in the following URL:
    https://github.com/ouriquegustavo/pywitch_auth
    PyWitch Auth receives code from Twitch Authorization page and perform the required OAuth flow to generate the associated access token.
    Any token is stored PyWith Auth server for more than 120 seconds. If you are not able to recover your token in this time, it will be destroyed. Every token generated in the server has an unique 128 characters state-code used for token request.
    The server only will store public information about your Twitch user, like 'Display Name'. So I can recommend your live to other streamers
    Special thanks!
    I want to thanks HypeZ, 2000 and Butterflyholix for helping me testing this mod!
    Enjoy!

    Workshop Link:
    https://steamcommunity.com/sharedfiles/filedetails/?id=2655149465

    9 downloads

    0 comments

    Submitted

  3. Stexatlaser - Simple TEX Atlas Packer

    Go to GitHub for the latest version!
    Stexatlaser (Stex)

    Stexatlaser (stex-atlaser, a play on 'spectacular'), or simply Stex, is a simple tool for generating a (Klei) TEX format atlas and its key from a simple folder structure with no external dependencies required.
    It uses an implementation of the MaxRects algorithm to efficiently pack each input element image into a larger atlas image, with as little wasted space as possible. Some empty space is inevitable given that atlases must have power-of-two dimensions.
    It can also reverse the process and extract element images from an atlas using its key.

    Usage
    Stex uses the following syntax scheme:
    stex <global options> [command] <command options>
    The order of switches within each options section does not matter.

    Basic Usage
    Creating an Atlas
    To create an atlas/key, start by setting up an input folder with the following structure:
    .atlas_name |-- element1_name.png |-- element2_name.png |-- element3_name.png |-- ... The available input formats can vary between systems, but most common formats are supported. See All Commands/Options (on GitHub) for more information.
    As implied by the above, the folder name will be used as the atlas/key name, and the file names (with the extension ".tex", see Additional Information on GitHub) of each image will be used as their respective element names. All sub-folders and other files will be ignored.
    Then run Stex with the pack command:
    stex pack -i "X:\Path\To\Input\Directory" -o "X:\Path\To\Output\Directory" When finished, the resultant atlas.tex and key.xml files will be placed in the specified output directory. You can then refer to each element by its name in LUA without concerning yourself where they actually were placed within the atlas.
    If you want to see the element arrangement, try viewing the output with a TEX viewer.
    Extracting an Atlas
    To extract an atlas, run Stex with the unpack command:
     
    stex unpack -i "X:\Path\To\Input\key.xml" -o "X:\Path\To\Output\Directory" The key's corresponding atlas, which must be located alongside it, will be read automatically using the name specified within the key.
    When finished, a subfolder with the name of the atlas will be created within the specified output directory that contains each individual element as a separate image. This results in the same structure used as input when packing an atlas.
     
    Example
    When packed, a folder of images that looks like this:

    Will produce the files "test.tex" and "test.xml", which will look like:
    test.tex (in a TEX capable viewer)

    test.xml
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Atlas> <Texture filename="test.tex"/> <Elements> <Element name="ear-0" u1="0.4375" u2="0.478027" v1="0.329102" v2="0.391113"/> <Element name="ear-0 - Copy" u1="0.472656" u2="0.513184" v1="0.266113" v2="0.328125"/> <Element name="ear-1" u1="0.372559" u2="0.40918" v1="0.941406" v2="0.999512"/> <Element name="ear-1 - Copy" u1="0.372559" u2="0.40918" v1="0.882324" v2="0.94043"/> <Element name="eye-0" u1="0.949707" u2="0.996094" v1="0.622559" v2="0.670898"/> <Element name="eye-0 - Copy" u1="0.413574" u2="0.459961" v1="0.580566" v2="0.628906"/> <Element name="eye-1" u1="0.198242" u2="0.244629" v1="0.173828" v2="0.216309"/> <Element name="eye-1 - Copy" u1="0.245605" u2="0.291992" v1="0.173828" v2="0.216309"/> <Element name="eye-2" u1="0.505859" u2="0.554199" v1="0.831055" v2="0.865723"/> ... (etc)  
    Special Feature
    Stex has a mechanism for recording if atlases it creates are using pre-multiplied alpha so that it can be handled automatically when unpacking. See GitHub.
     
    View on GitHub for more info: https://github.com/oblivioncth/Stexatlaser
    If you believe you've found a bug, please file an issue there instead of just mentioning it here. Discussion otherwise is fine.

    184 downloads

    7 comments

    Updated

  4. Mods downloading issue

    I already subscribed mods and its always were been downloading ,but can't install and update.Before it's ok  , but after game update ,this  issue appeared. Plz guide me to solve.

    9 downloads

    1 comment

    Submitted

  5. HUD Skins

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

    260 downloads

    0 comments

    Submitted

  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:
     

    534 downloads

    3 comments

    Updated

  7. Don't Starve Hamlet PT-BR

    Translation for Don't Starve Hamlet - in progress

    110 downloads

    1 comment

    Updated

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

    39 downloads

    0 comments

    Updated

  9. 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. =)

    47 downloads

    1 comment

    Updated

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

    118 downloads

    0 comments

    Submitted

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

    343 downloads

    3 comments

    Submitted

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

    81 downloads

    0 comments

    Submitted

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

    64 downloads

    0 comments

    Submitted

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

    27 downloads

    0 comments

    Updated

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

    142 downloads

    2 comments

    Updated

  16. Test Mod

    modinfo.lua
    modmain.lua

    69 downloads

    0 comments

    Updated

  17. 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:
     

    466 downloads

    1 comment

    Updated

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

    367 downloads

    1 comment

    Updated

  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

     

    874 downloads

    8 comments

    Updated

  20. Weapon and Item tutorial

    Downloads for the weapon tutorial

    601 downloads

    0 comments

    Submitted

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

    1020 downloads

    7 comments

    Submitted

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

    2425 downloads

    3 comments

    Updated

  23. HUD Hotkey

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

    114 downloads

    0 comments

    Submitted

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

    829 downloads

    0 comments

    Updated

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

    768 downloads

    6 comments

    Updated

×
  • Create New...