Last Update: 2023-08-01
API Updates and Changes
The Don't Starve Together API evolves over time as Klei Entertainment adds new features, fixes bugs, and makes balance changes. This page explains how API changes are documented and how to keep your mods updated.
API Versioning
Don't Starve Together uses the game build number as its API version. The current documented API version is 624447 (as of August 1, 2023).
Finding API Changes
API changes are typically announced in these locations:
-
Game Update Notes: Check the "Notes for Modders" section in game update posts on the Klei Forums.
-
API Changelog: For a comprehensive list of all API changes, check the API Changelog document.
-
Discord Server: Join the Klei Discord to discuss API changes with other modders.
Recent API Changes
API Version 624447 (August 1, 2023)
- Added support for recipes unlocked by skill tree skills
- All existing skill tree builder tags have been removed in favor of builder skills
- Added missing TUNING.ANTLION_DEAGGRO_DIST value
Updating Your Mods
When a new API version is released, you should:
-
Check for breaking changes: Review the changelog to identify any changes that might affect your mods.
-
Test your mods: Load your mods in the latest game version to test for any issues.
-
Update your code: Make necessary changes to accommodate API updates.
-
Update your mod's API version: Update the API version in your mod's modinfo.lua file:
api_version = 10
For more detailed guidance on updating mods, see the Mod Updating Guide.
Backwards Compatibility
Klei generally tries to maintain backwards compatibility, but sometimes breaking changes are necessary. For more information about handling backwards compatibility, see the Backwards Compatibility document.
Reporting API Issues
If you encounter issues with the API or believe you've found a bug:
-
Post in the #dst-modding channel on the Klei Discord.
-
Report the issue on the Klei Bug Tracker