blob: 018b31aea2faff86dd6477b97eb094395dd8ccbe (
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
using System;
using Newtonsoft.Json;
namespace StardewModdingAPI
{
/// <summary>Wraps <see cref="Manifest"/> so it can implement <see cref="IManifest"/> without breaking backwards compatibility.</summary>
[Obsolete("Use " + nameof(IManifest) + " or " + nameof(Mod) + "." + nameof(Mod.ModManifest) + " instead")]
internal class ManifestImpl : Manifest, IManifest
{
/// <summary>The mod version.</summary>
public new ISemanticVersion Version
{
get { return base.Version; }
set { base.Version = (Version)value; }
}
}
/// <summary>A manifest which describes a mod for SMAPI.</summary>
public class Manifest
{
/*********
** Accessors
*********/
/// <summary>The mod name.</summary>
public string Name { get; set; }
/// <summary>A brief description of the mod.</summary>
public string Description { get; set; }
/// <summary>The mod author's name.</summary>
public string Author { get; set; }
/// <summary>The mod version.</summary>
public Version Version { get; set; } = new Version(0, 0, 0, "", suppressDeprecationWarning: true);
/// <summary>The minimum SMAPI version required by this mod, if any.</summary>
public string MinimumApiVersion { get; set; }
/// <summary>The name of the DLL in the directory that has the <see cref="Mod.Entry"/> method.</summary>
public string EntryDll { get; set; }
/// <summary>The unique mod ID.</summary>
public string UniqueID { get; set; }
/****
** Obsolete
****/
/// <summary>Whether the manifest defined the deprecated <see cref="Authour"/> field.</summary>
[JsonIgnore]
internal bool UsedAuthourField { get; private set; }
/// <summary>Obsolete.</summary>
[Obsolete("Use " + nameof(Manifest) + "." + nameof(Manifest.Author) + ".")]
public virtual string Authour
{
get { return this.Author; }
set
{
this.UsedAuthourField = true;
this.Author = value;
}
}
/// <summary>Whether the mod uses per-save config files.</summary>
[Obsolete("Use " + nameof(Mod) + "." + nameof(Mod.Helper) + "." + nameof(IModHelper.ReadConfig) + " instead")]
public bool PerSaveConfigs { get; set; }
}
}
|
