mirror of
https://github.com/All-Of-Us-Mods/MiraAPI.git
synced 2026-11-19 13:17:10 +00:00
72 lines
2.3 KiB
C#
72 lines
2.3 KiB
C#
using System.Globalization;
|
|
using System.Linq;
|
|
using BepInEx.Configuration;
|
|
|
|
namespace MiraAPI.PluginLoading;
|
|
|
|
/// <summary>
|
|
/// The interface that all Mira plugins must implement.
|
|
/// </summary>
|
|
public interface IMiraPlugin
|
|
{
|
|
/// <summary>
|
|
/// Gets a value indicating whether to display the plugin in the options menu.
|
|
/// </summary>
|
|
bool DisplayOnOptionsMenu => true;
|
|
|
|
/// <summary>
|
|
/// Gets the localization id to use for anything registered under this mod.
|
|
/// </summary>
|
|
string ParentLocaleId => GetType().Name.ToLower(CultureInfo.InvariantCulture);
|
|
|
|
/// <summary>
|
|
/// Gets the name to display on the options menu.
|
|
/// </summary>
|
|
string OptionsTitleText { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the abbreviated name to display for other mods to pick up.
|
|
/// </summary>
|
|
/// <returns>The <see cref="string"/> text for the plugin.</returns>
|
|
string GetAbbreviatedModName()
|
|
{
|
|
return new([.. OptionsTitleText.Where(c => !char.IsLower(c) && !char.IsWhiteSpace(c))]);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the name for the first custom category in the game options menu, if any.
|
|
/// </summary>
|
|
string CustomOptionMenuNameOne => "Custom Category 1";
|
|
|
|
/// <summary>
|
|
/// Gets the name for the second custom category in the game options menu, if any.
|
|
/// </summary>
|
|
string CustomOptionMenuNameTwo => "Custom Category 2";
|
|
|
|
/// <summary>
|
|
/// Gets the description for the second custom category in the game options menu, if any.
|
|
/// </summary>
|
|
string ModifierMenuDescription => "Configure modifiers and their settings here!";
|
|
|
|
/// <summary>
|
|
/// Gets the description for the first custom category in the game options menu, if any.
|
|
/// </summary>
|
|
string CustomOptionMenuOneDescription => "Apply game settings for this mod!";
|
|
|
|
/// <summary>
|
|
/// Gets the description for the second custom category in the game options menu, if any.
|
|
/// </summary>
|
|
string CustomOptionMenuTwoDescription => "Apply game settings for this mod!";
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the plugin is in debug mode.
|
|
/// </summary>
|
|
bool DebugMode => false;
|
|
|
|
/// <summary>
|
|
/// Gets the <see cref="ConfigFile"/> for the plugin.
|
|
/// </summary>
|
|
/// <returns>The <see cref="ConfigFile"/> for the plugin.</returns>
|
|
ConfigFile GetConfigFile();
|
|
}
|