using System;
using System.IO;
namespace StardewModdingAPI
{
public class Mod
{
///
/// The name of your mod.
/// NOTE: THIS IS DEPRECATED AND WILL BE REMOVED IN THE NEXT VERSION OF SMAPI
///
[Obsolete]
public virtual string Name { get; set; }
///
/// The name of the mod's authour.
/// NOTE: THIS IS DEPRECATED AND WILL BE REMOVED IN THE NEXT VERSION OF SMAPI
///
[Obsolete]
public virtual string Authour { get; set; }
///
/// The version of the mod.
/// NOTE: THIS IS DEPRECATED AND WILL BE REMOVED IN THE NEXT VERSION OF SMAPI
///
[Obsolete]
public virtual string Version { get; set; }
///
/// A description of the mod.
/// NOTE: THIS IS DEPRECATED AND WILL BE REMOVED IN THE NEXT VERSION OF SMAPI
///
[Obsolete]
public virtual string Description { get; set; }
///
/// The mod's manifest
///
public Manifest Manifest { get; internal set; }
///
/// Where the mod is located on the disk.
///
public string PathOnDisk { get; internal set; }
///
/// A basic path to store your mod's config at.
///
public string BaseConfigPath => PathOnDisk + "\\config.json";
///
/// A basic path to where per-save configs are stored
///
public string PerSaveConfigFolder => GetPerSaveConfigFolder();
///
/// A basic path to store your mod's config at, dependent on the current save.
/// The Manifest must allow for per-save configs. This is to keep from having an
/// empty directory in every mod folder.
///
public string PerSaveConfigPath => Constants.CurrentSavePathExists ? Path.Combine(PerSaveConfigFolder, Constants.SaveFolderName + ".json") : "";
///
/// A basic method that is the entry-point of your mod. It will always be called once when the mod loads.
///
public virtual void Entry(params object[] objects)
{
}
private string GetPerSaveConfigFolder()
{
if (Manifest.PerSaveConfigs)
{
return Path.Combine(PathOnDisk, "psconfigs");
}
Log.Error("The mod [{0}] is not configured to use per-save configs.", Manifest.Name);
return "";
}
}
}