dtmt/README.adoc

1.4 KiB

Darktide Mod Tools

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

  1. Download the latest release for your platform.

  2. Place the binary for your system and dictionary.csv next to each other.

  3. Open a command prompt, navigate to the downloaded binary and run dtmt.exe help.

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

  1. Install Rust from rust-lang.org or via the preferred means for your system.

  2. Download or clone this source code. Make sure to include the submodules in lib/.

  3. Run cargo build.