Mod Metadata Standard

[yani]

It would be good to have a standard for mod metadata that we can use to provide more information about a mod.

The most important one would be a name and description so that people don't have to guess what a mod does by trying to figure out a mod folder name.

I have come up with an example (not final ofcourse):

• Place mod.cfg in /mods/mymod with the following contents:

[mod]
Author = Loobinex
Name = Instant Charged Up Spells Mod
Description = This mod will make it so holding Shift instantly charges up your Keeper spells to their maximum level
Version = 1.0
Thumbnail = thumbnail.png
DefaultLoadOrder = after_map
MinimumGameVersion = 1.3.0

[name]
ENG = Instant Charged Up Spells Mod
DUT = Direct Opgeladen Spreuken Mod
FRA = Sorts Chargés Instantanément Mod
GER = Sofort Aufgeladene Zauber Mod

[description]
ENG = This mod will make it so holding Shift instantly charges up your Keeper spells to their maximum level
DUT = Deze mod zorgt ervoor dat het ingedrukt houden van Shift je Keeper-spreuken onmiddellijk tot het maximale niveau oplaadt
FRA = Ce mod fait en sorte que maintenir la touche Maj charge instantanément vos sorts de Gardien à leur niveau maximal
GER = Diese Mod sorgt dafür, dass das Gedrückthalten der Umschalttaste deine Keeper-Zauber sofort auf das maximale Level auflädt

[web]
KfxNetAuthorUsername = Loobinex
KfxNetWorkshopItemId = 784

• [mod] Name and [mod] Description would be fallbacks for when a translation is not available.
• [mod] DefaultLoadOrder could be the initial load order location when enabling the mod. (Depending on GUI implementation)
• [mod] Thumbnail files should be limited to png and jpg so there's no need for libraries for weird image formats.
• [webinfo] stuff would be used to link back to the KeeperFX.net workshop.
• Translations are done the same way as KeeperFX

By using a file such as this for mod metadata I can start working on implementing mod management in the new launcher.

This issue is mostly to come up with a metadata standard without actually implementing anything yet.

[yani]

There's also the question if we should force this file and some of its properties to be present.

[yani]

Changed MinGameVersion to MinimumGameVersion in the example

[yani]

Changed the way translations would be done to match how KeeperFX does it.