bitsquid_dt/dtmt
bitsquid_dt/dtmt
2
Fork 0
Code Issues 34 Pull requests 11 Projects 1 Releases 3 Packages 1 Wiki Activity
Var Dump: 
dumpVar: only available in dev mode
Mailing List

docs: Add quick start information to README

Browse source
This commit is contained in:
Lucas Schwiderski 2023-01-01 11:38:29 +01:00
parent 95aa145569
commit 61a80f71a7
Signed by: lucas
GPG key ID: AA12679AAA6DF4D8
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.adoc
View file

@ -11,3 +11,22 @@
:warning-caption: :warning:
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 https://git.sclu1034.dev/bitsquid_dt/dtmt/releases/[release] for your platform.
2. Download the `dictionary.csv` and place it next to the binary.
3. Open a command prompt, nagivate to the downloaded binary and run `dtmt.exe help`.
4. Use the `help` command (it works for subcommands, too) and the https://git.sclu1034.dev/bitsquid_dt/dtmt/wiki/CLI-Reference[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 https://www.rust-lang.org/learn/get-started[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`.