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

Update dtmt.cfg Reference

Lucas Schwiderski 2023-12-05 09:37:54 +01:00
parent f96344903f
commit a03fab30a0
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
dtmt.cfg-Reference.md

@ -13,17 +13,26 @@ See [Autodesk Stingray: About the SJSON data format](https://help.autodesk.com/v
```sjson ```sjson
// The unique mod ID. Both DTMM and DMF will run into issues if this overlaps with another mod // The unique mod ID. Both DTMM and DMF will run into issues if this overlaps with another mod
id = DMF id = DMF
// The human-readable name of the mod. This will show up in places like DTMM's mod list and DMF's options view // The human-readable name of the mod. This will show up in places like DTMM's mod list and DMF's options view
name = "Darktide Mod Framework" name = "Darktide Mod Framework"
// A one- or two-sentence summary of what your mod does. Shows up in DTMM // A one- or two-sentence summary of what your mod does. Shows up in DTMM
summary = "An open-source, community-run framework that provides enhanced Darktide modding support." summary = "An open-source, community-run framework that provides enhanced Darktide modding support."
// A version number to track changes in your mod with. Shows up in DTMM // A version number to track changes in your mod with. Shows up in DTMM
version = "2023-03-12" version = "2023-03-12"
// Name of the individual or group that made this mod. Shows up in DTMM // Name of the individual or group that made this mod. Shows up in DTMM
author = "Darktide Modders" author = "Darktide Modders"
// A file path with extension to an image to show in DTMM. Recommended width: 500 - 1000 px // A file path with extension to an image to show in DTMM. Recommended width: 500 - 1000 px
image = "assets/icon.png" image = "assets/icon.png"
// Needs to be set to `false` explicitly for mods that don't use `dtmt` to build.
// When `false`, the `packages` field will be ignored.
bundled = false
// A list of arbitrary strings that will show up in DTMM. // A list of arbitrary strings that will show up in DTMM.
// Grouping, filtering and other features may be implemented in the future, so you'll want to match up with other mods // Grouping, filtering and other features may be implemented in the future, so you'll want to match up with other mods
categories = [ categories = [
@ -50,17 +59,17 @@ depends = [
resources = { resources = {
// The Lua file to be called by DMF when it initializes your mod. // The Lua file to be called by DMF when it initializes your mod.
init = "scripts/mods/DMF/init" init = "scripts/mods/DMF/init"
// The Lua file returning the mod's DMF configuration. // (Optional) The Lua file returning the mod's DMF configuration.
data = "scripts/mods/DMF/data" data = "scripts/mods/DMF/data"
// The Lua file returning localization strings to be registered with DMF. // (Optional) The Lua file returning localization strings to be registered with DMF.
localization = "scripts/mods/DMF/localization" localization = "scripts/mods/DMF/localization"
} }
// Will be skipped when `bundled = false`
packages = [ packages = [
// At least one package file (without extension) to load your files. It doesn't have to be named after your mod's ID value, but it is good practice to do so. // At least one package file (without extension) to load your files. It doesn't have to be named after your mod's ID value, but it is good practice to do so.
"packages/mods/DMF" "packages/mods/DMF"
] ]
``` ```
**Note:** Unless otherwise noted file paths must be specified _without_ file extension. **Note:** Unless otherwise noted file paths must be specified _without_ file extension.