summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Manifest.cs
blob: 6819cbd12bc8e9f2fc2ed1ba42b2493ad326648d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
using System;
using Newtonsoft.Json;

namespace StardewModdingAPI
{
    /// <summary>A manifest which describes a mod for SMAPI.</summary>
    public class Manifest
    {
        /*********
        ** Accessors
        *********/
        /// <summary>Whether the manifest defined the deprecated <see cref="Authour"/> field.</summary>
        [JsonIgnore]
        internal bool UsedAuthourField { get; private set; }

        /// <summary>The mod name.</summary>
        public virtual string Name { get; set; } = "";

        /// <summary>The mod author's name.</summary>
        public virtual string Author { get; set; } = "";

        /// <summary>Obsolete.</summary>
        [Obsolete("Use 'Author'.")]
        public virtual string Authour
        {
            get { return this.Author; }
            set
            {
                this.UsedAuthourField = true;
                this.Author = value;
            }
        }

        /// <summary>The mod version.</summary>
        public virtual Version Version { get; set; } = new Version(0, 0, 0, "");

        /// <summary>A brief description of the mod.</summary>
        public virtual string Description { get; set; } = "";

        /// <summary>The unique mod ID.</summary>
        public virtual string UniqueID { get; set; } = Guid.NewGuid().ToString();

        /// <summary>Whether the mod uses per-save config files.</summary>
        public virtual bool PerSaveConfigs { get; set; }

        /// <summary>The name of the DLL in the directory that has the <see cref="Mod.Entry"/> method.</summary>
        public virtual string EntryDll { get; set; } = "";
    }
}