Creator Guide

If you are an artist or a distributor that isn't certain how to pack their assets in order to make it compatible with Mythkeeper, this is the place for you!
Welcome to the Mythkeeper guide for the custom asset creators!

If you are an artist or a distributor that isn't certain how to pack their assets in order to make it compatible with Mythkeeper, this is the place for you!


PLEASE KEEP IN MIND that this guide is for custom ASSETS only; Mythkeeper DOES NOT support custom themes yet. These will work ONLY for assets that normally go strictly into the "assets" directory!

Foreword

Mythkeeper (further mentioned as MK) is a fairly versatile software when it comes to processing your packed assets. This means there 3 ways you can pack your assets to make them compatible, however one of the methods is preferred. In the same spirit; you can choose how much information you will pack with your asset to display to the user.
Conventions & rules

  • Mythkeeper can handle ONLY .zip file formats. DO NOT use .rar, .tar or any similar.
  • When naming your top-level folder, make sure you name it something no other author will - a combination of content and the author's name is the best:
    • Examples (author first, asset 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.
  • If possible, use method 1 for packaging and avoid using method 2. Use method 3 only if you are absolutely certain it is necessary
  • A picture explaining what we mean by "low" and "top" level folders

The three packaging methods for assets

Keep in mind that all these methods are viable, but if you aim for the best, most fool-proof method, stick to using the first method

Method 1 - RECOMMENDED

Packing your whole asset along with the top level directory of it inside a ZIP archive.

The example folder structure in the following picture if one of the compatible assets with the correct folder structure.

A picture of how your asset folder should look like


A picture of what the zip folder should look like if you were to open it manually


Method 2 - NOT RECOMMENDED

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!

Packaging the asset contents without a top-level directory.

The example folder structure in the following picture if one of the compatible assets with the correct folder structure.

A picture of what your asset folder should look like

A picture of what the zip folder should look like if you were to open it manually


Method 3

Packing your whole asset inside another assets folder in order to be extracted directly to Wonderdraft main user data folder.

This way might be familiar mostly to theme makers as themes go into multiple directories.

If you pack your asset this way, please keep in mind that MK will ONLY unpack the FIRST directory it finds inside the assets folder and will delete all non-directory files. If you pack any licenses, install notes or anything of such kind next to the folder, it will get lost along the way!

The example folder structure in the following picture if one of the compatible assets with the correct folder structure.

A picture of what your asset folder should look like


A picture of what the zip folder should look like if you were to open it manually


The config file and metafiles
The "whats" and "whys"


An example of what an asset with properly filled in metadata looks like compared to one without it


!!!PLEASE NOTE THAT DIFFERENT AUTOMATIC LICENSE LINKS WILL BE ADDED TO MK IN THE NEAR FUTURE!!! Right now the user will get sent to Google in most cases with a search for the license you specify unless you decide to include a local copy of it in your metadata.

MK comes with a custom system of one big config file and a custom directory you can choose to pack along with your asset. 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:

  • You can name your asset 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 asset and allow your name to be filtered later on once the functionality is added.
  • You may include any contact info in the metafile. Website, email, all goes.
    • If you are a distributor of assets you didn't make, worry not! MK allows you to fill a separate name and contact in for BOTH you AND the author so both of your contacts will show independently.
  • You may include the license link or a file in your pack along with information if your asset 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 asset or a commercial license.
    • In case using your assets 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 asset that will show the user what to roughly expect.
    • You may include a whole gallery of preview images for advanced preview if you want to show a real-world usage of your asset in action!
  • You may include a version of your asset so the user can track which version of the asset he is currently on - 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 include both short and long description of your asset along with tags, so your asset is easy to find once a filter function has been added to MK.
An example of a folder structure


An example of the config file

JSON:
{
   "basicInformation": {
      "name": "Elvanos - Mountains",
      "version": "2.0",
      "author":{
         "exists": true,
         "name": "Elvanos",
         "mail": "xfenix@seznam.cz",
         "url": "https://www.patreon.com/elvanos",
         "donationURL": "https://www.patreon.com/elvanos"
      },
      "distributor":{
         "exists": true,
         "name": "Elvanos",
         "mail": "xfenix@seznam.cz",
         "url": false,
         "donationURL": "https://www.patreon.com/elvanos"
      },
      "tagLine": "A mountain pack containing a number of textures cliffs with hand-drawn outlines and 6 color tints.",
      "downloadURL": "https://drive.google.com/uc?export=download&id=1qaAOmd05npd0ddT_7OWfNGUE_A5P92DR",
      "commercialUse": true,
      "commercialURL": false,
      "license": {
         "hasLicense": true,
         "type": "CC BY 4.0",
         "localFile": false,
         "externalLink": true,
         "commentary": true
      },
      "tags": [
         "terrain",
         "mountains",
         "texture",
         "tints",
         "stylized",
         "colorable",
         "non-colorable"
      ]     
   }
}
If you are having trouble navigating the code, we suggest using VSCode free text editor for editing.
Detailed info about the different settings inside the config file

Detailed MK info file specs

Forum statistics

Threads
220
Messages
439
Members
699
Latest member
Max19

Latest profile posts

Mystilik_Mew wrote on Nexoness's profile.
Sorry for bothering you, but I'm having trouble trying to use one of your themes for Wonderdraft.
I've got the zip file in my folders, and I tried unzipping and just putting that in their alone. I'm using Mac btw, hope you can help? Thanks

Join the platform as a developer!

If you are developing software or maintaining a community related to map-making in any way then you are more than welcome to join our platform!

Learn More!
Top