Sign inSign up

dstmodders/dst-mod

By dstmodders

Updated almost 2 years ago

Dockerized modding environment for the Klei Entertainment's game Don't Starve Together.

Image
Developer tools
1

3.1K

dstmodders/dst-mod repository overview

Overview

Docker images for modding environment of Klei Entertainment's game Don't Starve Together to dive right into the mods' development without bothering with building, installing and configuring all the tools yourself. Especially comes in handy when working on Linux and/or macOS.

Usage

$ docker pull dstmodders/dst-mod:latest
# or
$ docker pull ghcr.io/dstmodders/dst-mod:latest

See tags for a list of all available versions.

In the examples below, the current working directory will be mounted to the container as your mod directory.

Shell/Bash (Linux & macOS)
$ docker run --rm -it \
    -v "$(pwd):/opt/dont_starve/mods/$(basename "$(pwd)")" \
    -w "/opt/dont_starve/mods/$(basename "$(pwd)")" \
    dstmodders/dst-mod \
    /bin/bash
CMD (Windows)
> for %I in (.) do docker run --rm -it ^
    -v "%CD%:/opt/dont_starve/mods/%~nxI" ^
    -w "/opt/dont_starve/mods/%~nxI" ^
    dstmodders/dst-mod ^
    /bin/bash
PowerShell (Windows)
PS:\> docker run --rm -it `
    -v "${PWD}:/opt/dont_starve/mods/$((Get-Item "${PWD}").Basename)" `
    -w "/opt/dont_starve/mods/$((Get-Item "${PWD}").Basename)" `
    dstmodders/dst-mod `
    /bin/bash

Supported tools

Note

Since the game engine bundles [Lua] interpreter v5.1, the images bundle v5.1.5 instead of the latest one.

Supported environment variables

General
NameValueDescription
DS_MODS or DST_MODS/opt/dont_starve/modsMods directory path
DS or DST/opt/dont_starveGame directory path
IMAGEMAGICK_VERSION7.1.1-39ImageMagick version
KTOOLS_KRANE/usr/local/bin/kranektools/krane path
KTOOLS_KTECH/usr/local/bin/ktechktools/ktech path
KTOOLS_VERSION4.5.1ktools version
LCOV_VERSION2.1LCOV version
LUA_VERSION5.1.5Lua version
Alpine
NameValueDescription
LUAROCKS_VERSION3.8.0LuaRocks version
Debian
NameValueDescription
KLEI_TOOLS_AUTOCOMPILER/opt/klei-tools/mod_tools/autocompilerklei-tools/autocompiler path
KLEI_TOOLS_PNG/opt/klei-tools/mod_tools/pngklei-tools/png path
KLEI_TOOLS_SCML/opt/klei-tools/mod_tools/scmlklei-tools/scml path
KLEI_TOOLS_VERSION1.0.0klei-tools version
LUAROCKS_VERSION3.11.1LuaRocks version
STYLUA_VERSION0.20.0StyLua version

Supported build arguments

NameImageDefaultDescription
IMAGEMAGICK_VERSIONalpine7.1.1-39Sets ImageMagick version
KLEI_TOOLS_VERSIONdebian1.0.0Sets klei-tools version
KTOOLS_VERSIONalpine
debian
4.5.1Sets ktools version

Supported architectures

ImageArchitecture(s)
alpinelinux/amd64
debianlinux/amd64

Build

To build images locally:

$ docker build --tag='dstmodders/dst-mod:alpine' ./alpine/
$ docker build --tag='dstmodders/dst-mod:debian' ./debian/

Respectively, to build multi-platform images using [buildx]:

$ docker buildx build --platform='linux/amd64' --tag='dstmodders/dst-mod:alpine' ./alpine/
$ docker buildx build --platform='linux/amd64' --tag='dstmodders/dst-mod:debian' ./debian/

License

Released under the MIT License.

Tag summary

Content type

Image

Digest

sha256:591ba6946

Size

312.6 MB

Last updated

almost 2 years ago

docker pull dstmodders/dst-mod