Home
This will serve as a location to put non-API documentation and examples for things contained in the MDK.
How you 'install' the MDK depends on how you intend to use it.
You just want to get your hands on the goods, and aren't looking to use any MDK items in an exported package for sharing or anything like that.
Well, you are who the mdk mpackage is for! Download the MDK.mpackage from your desired release on the Releases page and install it in the package manager. The examples in the wiki are written with this in mind, and you would require the items you need as local EMCO = require("MDK.emco")
You should download the demonnic-MDK-<version>.zip file for your desired release on the Releases page.
Inside are the individual .lua files for the modules and classes described in the wiki and API docs.
You can include all of them if you wish, or only the ones you actually make use of. I ask that you include the LICENSE.lua or LICENSE-MDK.lua file (depending on the release) file in addition.
They should go in the root of your package, so that when your package is installed the files can be found at getMudletHomeDir() .. "/<packagename>/emco.lua". You would then use local EMCO = require("<mypackagename>.emco")
So for example if your package name is "MySuperCoolPackage" and it installs to getMudletHomeDir() .. "/MySuperCoolPackage/" then you use local EMCO = require("MySuperCoolPackage.emco") and the emco.lua file should be at getMudletHomeDir() .. "/MySuperCoolPackage/emco.lua"
As mentioned in the installation section, all examples will be written as though you have installed the MDK mpackage. If you are embedding parts of the MDK in your own project then the require call at the top will need to change accordingly.
You can find the API documentation for the current version of the MDK HERE
Check out the sidebar helpfully generated by github-wiki-sidebar as it contains links to all the examples pages.
If you need help with anything in the MDK, why not come ask on my discord?
