src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs


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
50
51
52
53
54
55
56
57
58
59
60

namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
{
    /// <summary>An entry in the mod compatibility list.</summary>
    public class WikiCompatibilityEntry
    {
        /*********
        ** Accessors
        *********/
        /****
        ** Mod info
        ****/
        /// <summary>The mod's unique ID. A mod may have multiple current IDs in rare cases (e.g. due to parallel releases or unofficial updates).</summary>
        public string[] ID { get; set; }

        /// <summary>The mod's display name.</summary>
        public string Name { get; set; }

        /// <summary>The mod ID on Nexus.</summary>
        public int? NexusID { get; set; }

        /// <summary>The mod ID in the Chucklefish mod repo.</summary>
        public int? ChucklefishID { get; set; }

        /// <summary>The GitHub repository in the form 'owner/repo'.</summary>
        public string GitHubRepo { get; set; }

        /// <summary>The URL to a non-GitHub source repo.</summary>
        public string CustomSourceUrl { get; set; }

        /// <summary>The custom mod page URL (if applicable).</summary>
        public string CustomUrl { get; set; }

        /****
        ** Stable compatibility
        ****/
        /// <summary>The compatibility status.</summary>
        public WikiCompatibilityStatus Status { get; set; }

        /// <summary>The human-readable summary of the compatibility status or workaround, without HTML formatting.</summary>
        public string Summary { get; set; }

        /// <summary>The version of the latest unofficial update, if applicable.</summary>
        public ISemanticVersion UnofficialVersion { get; set; }

        /****
        ** Beta compatibility
        ****/
        /// <summary>Whether a Stardew Valley or SMAPI beta which affects mod compatibility is in progress. If this is true, <see cref="BetaUnofficialVersion"/> should be used for beta versions of SMAPI instead of <see cref="UnofficialVersion"/>.</summary>
        public bool HasBetaInfo => this.BetaStatus != null;

        /// <summary>The compatibility status for the Stardew Valley beta, if a beta is in progress.</summary>
        public WikiCompatibilityStatus? BetaStatus { get; set; }

        /// <summary>The human-readable summary of the compatibility status or workaround for the Stardew Valley beta (if any), without HTML formatting.</summary>
        public string BetaSummary { get; set; }

        /// <summary>The version of the latest unofficial update for the Stardew Valley beta (if any), if applicable.</summary>
        public ISemanticVersion BetaUnofficialVersion { get; set; }
    }
}