docker-klei-tools

Note

This repository uses a fork dstmodders/klei-tools instead of the original kleientertainment/ds_mod_tools. All tags prefixed with "official" point to official releases. See fork releases to learn more.

Supported tags and respective Dockerfile links

• 1.0.0-ktools-4.5.1-debian, 1.0.0-ktools-4.5.1, 1.0.0, debian, latest
• official-ktools-4.4.0-debian, official-ktools-4.4.0, official-debian, official-latest, official

Overview

Docker images for modding tools of Klei Entertainment's game Don't Starve.

• Usage
• Supported environment variables
• Supported build arguments
• Supported architectures
• Build

Usage

Fork releases (recommended):

$ docker pull dstmodders/klei-tools:latest
# or
$ docker pull ghcr.io/dstmodders/klei-tools:latest

Or you can also pick one of the official releases:

$ docker pull dstmodders/klei-tools:official
# or
docker pull ghcr.io/dstmodders/klei-tools:official

See tags for a list of all available versions.

For your convenience, create an environment variable, such as DST_DIR, which points to the game directory. This variable will simplify the process of mounting the game directory to the container. Common paths include:

• C:\Program Files (x86)\Steam\steamapps\common\Don't Starve Together Windows/Steam
• ~/.steam/steam/steamapps/common/Don't Starve Together Linux/Steam
• ~/.var/app/com.valvesoftware.Steam/data/Steam/steamapps/common/Don't Starve Together Linux/Steam (Flatpak)
• ~/Library/Application Support/Steam/steamapps/common/Don't Starve Together macOS/Steam

Shell/Bash (Linux & macOS)

$ export DST_DIR='/path/to/game/'
$ docker run --rm -v "${DST_DIR}:/opt/dont_starve/" dstmodders/klei-tools

CMD (Windows)

> set DST_DIR='C:\Path\To\Game'
> docker run --rm -v "%DST_DIR%:/opt/dont_starve/" dstmodders/klei-tools

PowerShell (Windows)

PS:\> $Env:DST_DIR = 'C:\Path\To\Game'
PS:\> docker run --rm -v "$($Env:DST_DIR):/opt/dont_starve/" dstmodders/klei-tools

Supported environment variables

Name	Value	Description
DS or DST	/opt/dont_starve	Game directory path
IMAGEMAGICK_VERSION	7.1.1-39	ImageMagick version
KLEI_TOOLS_AUTOCOMPILER	/opt/klei-tools/mod_tools/autocompiler	klei-tools/autocompiler path
KLEI_TOOLS_PNG	/opt/klei-tools/mod_tools/png	klei-tools/png path
KLEI_TOOLS_SCML	/opt/klei-tools/mod_tools/scml	klei-tools/scml path
KLEI_TOOLS_VERSION	1.0.0	klei-tools version
KTOOLS_KRANE	/usr/local/bin/krane	ktools/krane path
KTOOLS_KTECH	/usr/local/bin/ktech	ktools/ktech path
KTOOLS_VERSION	4.5.1	ktools version

Supported build arguments

Name	Image	Default	Description
KTOOLS_VERSION	latest official	4.5.1 4.4.0	Sets ktools version

Supported architectures

Image	Architecture(s)
latest	linux/amd64, linux/386
official	linux/amd64, linux/386

Build

To build images locally:

$ docker build --tag='dstmodders/klei-tools:latest' ./latest/debian/
$ docker build --tag='dstmodders/klei-tools:official' ./official/debian/

Respectively, to build multi-platform images using buildx:

$ docker buildx build --platform='linux/amd64,linux/386' --tag='dstmodders/klei-tools:latest' ./latest/debian/
$ docker buildx build --platform='linux/amd64,linux/386' --tag='dstmodders/klei-tools:official' ./official/debian/

License

Released under the MIT License.