From 0ac7347c9198eb34160d85d157388923bbf0cb70 Mon Sep 17 00:00:00 2001 From: Lucas Schwiderski Date: Thu, 16 Mar 2023 19:37:52 +0100 Subject: [PATCH] Update 'Migrating from loose files' --- Migrating-from-loose-files.md | 33 +-------------------------------- 1 file changed, 1 insertion(+), 32 deletions(-) diff --git a/Migrating-from-loose-files.md b/Migrating-from-loose-files.md index f581f07..8d7399f 100644 --- a/Migrating-from-loose-files.md +++ b/Migrating-from-loose-files.md @@ -5,38 +5,7 @@ To migrate Lua files from a loose file structure to something that can be built - a `dtmt.cfg` that defines the mod's metadata, entry points and packages - at least one `.package` file that includes your Lua files -Use the following template to create your `dtmt.cfg`: - -```sjson -// The ID string you pass to `get_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 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 = "" - -// A list of mod IDs that this mod depends on. -depends = [ - DMF -] - -// 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 = "" - // The Lua file returning the mod's DMF configuration. - data = "" - // The Lua file returning localization strings to be registered with DMF. - 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/" -] -``` +Check out the reference create your `dtmt.cfg`: [`dtmt.cfg` Reference](dtmt.cfg-Reference) Please note that all file paths should be specified _without_ file extension. The `resources` section can be adapted from the contents of your `.mod` file. All instances of `` are intended to be replaced with the value you specify in `id = ""`, which must be the same value you pass to DMF's `new_mod` and `get_mod`.