OpenXcom Forum

Modding => Help => Topic started by: pjlasl on January 03, 2022, 07:07:33 pm

Title: metadata.yml documentation [SOLVED]
Post by: pjlasl on January 03, 2022, 07:07:33 pm
I have tried to search for documentation that explains the different properties and their definitions in a metadata file but I haven't had any luck.

Can someone point me to some documentation?
Title: Re: metadata.yml documentation
Post by: Meridian on January 03, 2022, 10:33:55 pm
id = mod's unique ID (required)
name = mod's short name
description = mod's full description
version = mod's version
author = mod's author(s)
master = ID of the parent mod, for example xcom1, xcom2, etc. You can use "*" to say it can be used with any parent mod
isMaster = whether this mod is a mod without a parent mod, true or false
reservedSpace = how much space do you need for image indices in image sets, default 1 = indices 0 to 999; 2 = 0 to 1999, 3 = 0 to 2999, etc.
requiredExtendedVersion = number of the minimum required OXCE version required by this mod
loadResources = original 1994/1995 resources to be loaded by this mod (either UFO or TFTD)
resourceConfig = filename of an additional config file that you will probably never need... unless you plan to mod "soundDefs" or "transparencyLUTs"
Title: Re: metadata.yml documentation
Post by: pjlasl on January 04, 2022, 01:23:06 am
Thank you!
Title: Re: metadata.yml documentation [SOLVED]
Post by: N7Kopper on July 12, 2022, 12:11:50 am
Can you have a mod have multiple master mods? Such as a mod that specificially targets UFO and TFTD, but not conversions - or one that targets UFO or TFTD plus certain total conversions that still use their assets, such as X-Chronicles?
Title: Re: metadata.yml documentation [SOLVED]
Post by: Meridian on July 12, 2022, 11:30:05 am
not atm