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 'Migrating from loose files'

Lucas Schwiderski 2023-03-16 19:37:52 +01:00
parent b1dffac813
commit 0ac7347c91
1 changed files with 1 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
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 - a `dtmt.cfg` that defines the mod's metadata, entry points and packages
- at least one `.package` file that includes your Lua files - at least one `.package` file that includes your Lua files
Use the following template to create your `dtmt.cfg`: Check out the reference create your `dtmt.cfg`: [`dtmt.cfg` Reference](dtmt.cfg-Reference)
```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/<id>"
]
```
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 `<id>` 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`. 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 `<id>` 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`.