using System.Collections.Generic;
namespace StardewModdingAPI
{
/// Provides simplified APIs for writing mods.
public interface IModHelper
{
/*********
** Accessors
*********/
/// The full path to the mod's folder.
string DirectoryPath { get; }
/// An API for loading content assets.
IContentHelper Content { get; }
/// Simplifies access to private game code.
IReflectionHelper Reflection { get; }
/// Metadata about loaded mods.
IModRegistry ModRegistry { get; }
/// An API for managing console commands.
ICommandHelper ConsoleCommands { get; }
/// Provides translations stored in the mod's i18n folder, with one file per locale (like en.json) containing a flat key => value structure. Translations are fetched with locale fallback, so missing translations are filled in from broader locales (like pt-BR.json < pt.json < default.json).
ITranslationHelper Translation { get; }
/*********
** Public methods
*********/
/****
** Mod config file
****/
/// Read the mod's configuration file (and create it if needed).
/// The config class type. This should be a plain class that has public properties for the settings you want. These can be complex types.
TConfig ReadConfig() where TConfig : class, new();
/// Save to the mod's configuration file.
/// The config class type.
/// The config settings to save.
void WriteConfig(TConfig config) where TConfig : class, new();
/****
** Generic JSON files
****/
/// Read a JSON file.
/// The model type.
/// The file path relative to the mod directory.
/// Returns the deserialised model, or null if the file doesn't exist or is empty.
TModel ReadJsonFile(string path) where TModel : class;
/// Save to a JSON file.
/// The model type.
/// The file path relative to the mod directory.
/// The model to save.
void WriteJsonFile(string path, TModel model) where TModel : class;
/****
** Content packs
****/
/// Get all content packs loaded for this mod.
IEnumerable GetContentPacks();
}
}