History

Lucas Schwiderski 7080dcb8de Some checks failed lint/clippy Checking for common mistakes and opportunities for code improvement build/linux Build for the target platform: linux build/msvc Build for the target platform: msvc sdk: Use common ljd flags		2023-10-30 14:07:00 +01:00
..
src	sdk: Use common ljd flags	2023-10-30 14:07:00 +01:00
Cargo.toml	sdk: Implement decompiling Lua	2023-10-30 09:28:07 +01:00
README.adoc	docs: Add split READMEs	2023-03-01 22:14:31 +01:00

README.adoc

Darktide Mod Tools (DTMT)

A set of tools to develop mods for the newest generation of the Bitsquid game engine that powers the game Warhammer 40.000: Darktide.

Quickstart

Head to the latest release and download the dtmt binary for your platform.
Place the binary and dictionary.csv next to each other.
Open a command prompt, navigate to the downloaded binary and run dtmt.exe help.
Use the help command (it works for subcommands, too) and the CLI Reference.

Runtime dependencies

The LuaJit decompiler (short "ljd") is used to decompile Lua files. A version tailored specifically to Bitsquid may be found here: https://github.com/Aussiemon/ljd.

A custom executable location may be passed via the --ljd flag during extraction, otherwise decompilation expects ljd to be found via the PATH environmental variable.

Building

Install Rust from rust-lang.org or via the preferred means for your system.
Download or clone this source code. Make sure to include the submodules in lib/.
Run cargo build.