diff --git a/dtmt.cfg-Reference.md b/dtmt.cfg-Reference.md new file mode 100644 index 0000000..6202266 --- /dev/null +++ b/dtmt.cfg-Reference.md @@ -0,0 +1,46 @@ +```sjson +// The unique mod ID. Both DTMM and DMF will run into issues if this duplicates with another mod +id = "" +// The human-readable name of the mod. This will show up in places like DTMM's mod list and DMF's options view +name = "" +// A one- or two-sentence summary of what your mod does. Shows up in DTMM +summary = "" +// A version number to track changes in your mod with. Shows up in DTMM +version = "" +// An optional, longer description of your mod. Currently unused, but matched to Nexus's long description +description = "" +// Name of the individual or group that made this mod +author = "" + +// A list of mod IDs that this mod depends on. +depends = [ + // Just the ID defaults to "before" + DMF + // Long form of the above + { + id = other_dependency + order = before + } + // Dependencies may be require to come after the current mod + { + id = yet_another_dependency + order = after + } +] + +// File paths to Lua files, as passed in the second parameter of DMF's `new_mod` +resources = { + // The Lua file to be called by DMF when it initializes your mod. + init = "scripts/mods//init" + // The Lua file returning the mod's DMF configuration. + data = "scripts/mods//data" + // The Lua file returning localization strings to be registered with DMF. + localization = "scripts/mods//localization" +} + +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. + "packages/mods/" +] + +``` \ No newline at end of file