Darktide Mod Manager #39

Merged
lucas merged 91 commits from feat/dtmm into master 2023-03-01 22:27:42 +01:00
4 changed files with 56 additions and 13 deletions
Showing only changes of commit 45da42908b - Show all commits

View file

@ -10,23 +10,18 @@
:tip-caption: :bulb: :tip-caption: :bulb:
:warning-caption: :warning: :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_. A set of tools to use and develop mods for the newest generation of the Bitsquid game engine that powers the game _Warhammer 40.000: Darktide_.
== Quickstart == Darktide Mod Manager (DTMM)
1. Download the latest https://git.sclu1034.dev/bitsquid_dt/dtmt/releases/[release] for your platform. DTMM is a GUI application to install and manage mods for the game.
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 https://git.sclu1034.dev/bitsquid_dt/dtmt/wiki/CLI-Reference[CLI Reference].
== Runtime dependencies image::docs/screenshots/dtmm.png[dtmm main view]
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. Head to https://git.sclu1034.dev/bitsquid_dt/dtmt/src/branch/master/crates/dtmm[crates/dtmm] for more information or check the https://git.sclu1034.dev/bitsquid_dt/dtmt/wiki[Wiki].
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. == Darktide Mod Tools (DTMT)
== Building DTMT is a CLI application providing various commands that aid in developing mods for the game.
1. Install Rust from https://www.rust-lang.org/learn/get-started[rust-lang.org] or via the preferred means for your system. Head to https://git.sclu1034.dev/bitsquid_dt/dtmt/src/branch/master/crates/dtmt[crates/dtmt] for more information or check the https://git.sclu1034.dev/bitsquid_dt/dtmt/wiki[Wiki].
2. Download or clone this source code. Make sure to include the submodules in `lib/`.
3. Run `cargo build`.

16
crates/dtmm/README.adoc Normal file
View file

@ -0,0 +1,16 @@
= Darktide Mod Manager (DTMM)
:idprefix:
:idseparator:
:toc: macro
:toclevels: 1
:!toc-title:
:caution-caption: :fire:
:important-caption: :exclamtion:
:note-caption: :paperclip:
:tip-caption: :bulb:
:warning-caption: :warning:
DTMM is a GUI application to install and manage mods for the game.
![dtmm main view](../../docs/screenshots/dtmm.png)

32
crates/dtmt/README.adoc Normal file
View file

@ -0,0 +1,32 @@
= Darktide Mod Tools (DTMT)
:idprefix:
:idseparator:
:toc: macro
:toclevels: 1
:!toc-title:
:caution-caption: :fire:
:important-caption: :exclamtion:
:note-caption: :paperclip:
:tip-caption: :bulb:
: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. Head to the latest https://git.sclu1034.dev/bitsquid_dt/dtmt/releases/[release] and download the `dtmt` binary for your platform.
2. Place the binary 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 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`.

BIN
docs/screenshots/dtmm.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB