From a03fab30a0c5b40a5e92f959b9afc79b6b791653 Mon Sep 17 00:00:00 2001 From: Lucas Schwiderski Date: Tue, 5 Dec 2023 09:37:54 +0100 Subject: [PATCH] Update dtmt.cfg Reference --- dtmt.cfg-Reference.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/dtmt.cfg-Reference.md b/dtmt.cfg-Reference.md index 968498a..de4ce9a 100644 --- a/dtmt.cfg-Reference.md +++ b/dtmt.cfg-Reference.md @@ -13,17 +13,26 @@ See [Autodesk Stingray: About the SJSON data format](https://help.autodesk.com/v ```sjson // The unique mod ID. Both DTMM and DMF will run into issues if this overlaps with another mod 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 name = "Darktide Mod Framework" + // 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." + // A version number to track changes in your mod with. Shows up in DTMM version = "2023-03-12" + // Name of the individual or group that made this mod. Shows up in DTMM author = "Darktide Modders" + // A file path with extension to an image to show in DTMM. Recommended width: 500 - 1000 px 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. // Grouping, filtering and other features may be implemented in the future, so you'll want to match up with other mods categories = [ @@ -50,17 +59,17 @@ depends = [ resources = { // The Lua file to be called by DMF when it initializes your mod. 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" - // 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" } +// Will be skipped when `bundled = false` 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. "packages/mods/DMF" ] - ``` **Note:** Unless otherwise noted file paths must be specified _without_ file extension. \ No newline at end of file