Mythkeeper author guide
Hello and welcome to the Mythkeeper author guide.
This guide is meant primarily for assets, theme and brush authors and/or distributors who wish to publicize their work in a way that is compatible with Mythkeeper software.
In this guide, you will detailed information about the structure of the folders and other useful information accompanied by image-guides and examples.
Mythkeeper is a fairly versatile software when it comes to processing your packed items:
- Assets can be packed in three different ways in order to make them compatible. However, only one of the methods is recommended and we strongly discourage to even consider using the last one at all.
- Themes can also be packed in three different ways - yet again; one is recommended and the others not so much.
- Brushes should be packed exclusively via the described method below as they lack the rigid folder structure of assets or the unique file formats of themes - therefore a special approach is needed.
If you are looking for the details on the mythkeeperConfig.json file, please continue through this link instead.
Conventions & rules
How to pack - ASSETS
Method 1 - Recommended
- Mythkeeper can handle ONLY .zip file formats. DO NOT use .rar, .tar or any similar.
- When naming your top-level folder, make ABSOTELLY 100% CERTAIN that you name it something no other author EVER should - we recommend a combination of content and the author's name:
- Examples (author first, item name second):
- "Elvanos - Cliffs"
- "Zalkenai - Orc Settlements"
- "Nexoness - Avoro, Gates of hell additions"
- Naming your low-level folder in a similar manner as the top folder.
- When packing assets, use method 1 for packaging and avoid using method 2 if you can.
- Never use method 3. We only mention it in order to show people how NOT to pack their items.
- A picture explaining what we mean by "low" and "top" level folders
Packing your whole asset pack inside another assets folder in order to be extracted directly to Wonderdraft main user data folder.
Packing your whole asset along with the top-level directory of it inside a ZIP archive.
Method 3 - Not recommended (do not do this)
Packaging the asset contents without a top-level directory.
How to pack - THEMES
Method 1 & 2
- We DO NOT suggest this method, it is dangerous and can lead to unforeseen consequences when unpacking!
- If your asset is packed this way, we HEAVILY suggest adding the top-level directory to make it more stable!
Exactly the same as assets - the sole change is the lack of existence of the sub-folder since themes do not support those.
- Method 1 wraps the main theme file with a top-level folder and "themes" folder above it.
- You may pack multiple theme folders inside the "themes" folder. Mythkeeper will allow selective installation of the zip's contents to the user.
- Method 2 doesn't add the "themes" folder, but still adds the top-level folder.
How to pack - BRUSHES
- A simple ".wonderdraft_theme" file.
- If you don't want to, there is no need to package anything specially. Just export the theme out of Wonderdraft and let someone install that file directly thought Mythkeeeer.
Packing brushes is done exactly as method 1 of packing assets, except for the fact, that the "assets" folder is replaced by the "brushes" folder.
Please note that this is THE ONLY viable method of how to pack brushes since they lack the rigid folder structure of assets.
How to pack - PACKAGES
With the update, Mythkeeper now offers a possibility to pack multiple asset packs, multi themes and/or multi brushes in one big pack. Theoretically, you can ship an unlimited amount of items in one single zip file. We believe this will be most useful for collections from the same author or theme makers who wish to pack custom paths, textures, fonts and similar along with their themes.
However, if you find some other use for this feature, by all means, experiment - only the sky is the limit!
If you use this option as an author/distributor, please keep in mind that the ONLY method of how to get this work is to hollow method 1 from each of the previously mentions sections.
The config file and metafiles
The "whats" and "whys"
MK comes with a custom system of one big config file and a custom directory you can choose to pack along with your items. This gives a number of advantages that both the user and the author (you) will get for investing the extra time to set it up properly:
An example of a folder structure
A picture of example folder structure with explanation
An example of the config file
An example config file to either get inspired from or copy
- You can name your item in any way you want it displayed in the manager. If you do not fill this, it will just show as the directory name.
- You may include your author name, so the user knows who made the item and allow your name to be filtered later on once the functionality is added.
- If you are merely a distributor and not the actual author, you may separately include details about both you and the author.
- You may include any contact info in the metafile: A website, an email; even a donation URL - all goes!
- You may include the license link or a file in your pack along with information if your item can be used commercially. Alternatively, you can pack a demo version of it and include a link where the user can buy the full version of your item.
- In case using your item has some additional requirements or you don't want to you just want to include a commentary - you can! You can pack a separate small TXT or PDF file on top of the license.
- You may include a preview image of your item that will show the user what to roughly expect (use 250x250px png or jpg image for the best preview experience).
- You may include a whole gallery of preview images for advanced preview if you want to show a real-world usage of your item in action!
- You may include a version of your item so the user can track which version of the item they have installed - very helpful when used in combination with naming your zip files with a version number at the end (elvanos-cliffs-2.0.zip)
- You may also include a description of your item along with tags, so your item is easy to find via a built-in filter functionality.
If you are having trouble navigating the code, we suggest using VSCode free text editor
Detailed info about the different settings inside the config file
Detailed MK info file specs
An example of a fully packed asset that is Mythkeeper compatible
An example asset to either get inspired from or to copy the structure from