Feature: Define data paths that should be created by the folder deploy script, but not used by the CFG generator
There's some number of mods, like Salts, where we ask the users to create some folders manually (in this case, main
and hi-res-glowmaps
), but the actual data paths are one level deeper (in this case, main/Data files
and hi-res-glowmaps/Data files
).
There's a couple of ways how to solve this currently, all of which cause some issues either with the CFG generator or the folder deploy script.
- Add the
manual
tag to these data paths. This means that the users don't have to create the folders manually, but also it means they can't simply drag and drop the contents of the archive from the Nexus download to the folders created by the deploy script (in this case you would get a data path that'smain/Data files/Data files
, which is obviously not what we want. - Add an additional data path with a
manual
tag to the mod that corresponds to the folder that we want the users to create (in this case,main
andhi-res-glowmaps
). This has an unfortunate side effect in that it will define an empty data path, and the openmw-validator would throw warnings, because in this case the data paths would consist ofmain
,hi-res-glowmaps
,main/Data files
, andhi-res-glowmaps/Data files
folders, only the last two of which contain any files. - Don't add a
manual
tag at all to mods like this and just ask the users to follow the usage notes to create these folders manually. This is not ideal because it partially defeats the purpose of the folder deploy script.
An ideal way would be to add some sort of way to define a data path that would be created by the folder deploy script but not used by the CFG generator (and not displayed on the mod page), possibly by extending the YAML scheme for data paths like this:
- for_mod: Salts
manual: true
no_cfg: true
extra_dirs:
- "main"
on_lists:
- "total-overhaul"
- "graphics-overhaul"
Edited by Ronik