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-03-16 19:53:58 +01:00
parent 006c5df7c0
commit 414aee7d40
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
dtmt.cfg-Reference.md

@ -11,7 +11,7 @@ See [Autodesk Stingray: About the SJSON data format](https://help.autodesk.com/v
## Example ## Example
```sjson ```sjson
// The unique mod ID. Both DTMM and DMF will run into issues if this duplicates 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"
@ -19,7 +19,7 @@ name = "Darktide Mod Framework"
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 // 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"
@ -46,7 +46,7 @@ depends = [
} }
] ]
// File paths to Lua files, as passed in the second parameter of DMF's `new_mod` // File paths to Lua files (without extension), as passed in the second parameter of DMF's `new_mod`
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"
@ -57,7 +57,7 @@ resources = {
} }
packages = [ packages = [
// At least one package file 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"
] ]