Allow/Include comments and/or file formatting for the Config-Class

[mad2342]

For usablity it would be nice if existing Comments would be displayed in the Config-Tab too.
To help users understand settings or divide a big config into sections.
Best regards, Mad

[Sheep-y]

For now it should be best to note the config in the mod's readme.

The main problem is that even if I preserve the comment in initial config, it would be erased when the user delete the config or reset it to default.

One of the solutions I envisioned is to use vanilla .Net Annotation to add meta data to config properties, for example min, max, and of course comments. But it is not on the immediate roadmap of the next Modnix 3 release. Code patch is welcomed ;)

[mad2342]

Hi Sheepy, thx for your reply.
I'll fiddle around a bit (but all that stuff is new to me, coming from web-dev, js and such) and only started c# with Battletech in my limited free time...
You mean something like https://docs.microsoft.com/en-gb/dotnet/api/system.attribute, right?

[mad2342]

For now i have sth like this:

    [AttributeUsage(AttributeTargets.All)]
    public class Annotation : Attribute
    {
        private string description;
        private string defaultValue;
        private bool startSection;
        private bool endSection;
        private string sectionLabel;

        public Annotation(string description, string defaultValue, bool startSection = false, string sectionLabel = "", bool endSection = false)
        {

and use it like this (Settings.cs):

        [Annotation("General switch to enable the related subfeatures", "True", true, "")]
        public bool EnableMissionAdjustments = true;

Didn't touch Modnix, but in a console app it's working ok (as a poc).
Just wanted to make sure that this is no deadend, what do you think?
Thx for feedback and best regards, Mad

[mad2342]

If you like you can have a look at
https://github.com/Mad-Mods-Phoenix-Point/AssortedAdjustments/blob/main/Source/AssortedAdjustments/Settings.cs
That's my first attempt to add atributes and do sth. useful with them (export current settings as md/html with descriptions, default values and a marker if the currently applied setting is the mods default(very! raw, but works well enough))
Best regards, Mad