README.md

MiraModOptions

📌 Overview

A mod that adds an in-game settings menu to TEAM HORAY's Sephiria.

Only the settings for supported mods are displayed. You can change the settings in-game.

📥 Installation

1. Download the latest MiraModOptions-1.X.X.zip from the Releases section and unzip it.
2. Create an AddOns folder inside the Program Files (x86)\Steam\steamapps\common\Sephiria folder.
3. Copy the MiraModOptions folder into the Program Files (x86)\Steam\steamapps\common\Sephiria\AddOns folder.

Example:

Sephiria/
└── AddOns/
    └── MiraModOptions/
        ├── Libs/
        ├── metadata.json
        ├── MiraModBase.dll
        └── SephiriaModOptions.dll

📝 Notes

• This repository and its contributors are in no way affiliated with Sephiria, TEAM HORAY, or any related organizations.

🔧 For Mod Developers

How to display settings

Please add the following properties and functions to the class that inherits from HorayModBase.

• public List<List<string>> ModOptions { get; }
  Choices for each setting.
• public List<string> ModOptionsDescription { get; }
  Descriptions for each setting. Optional.
• public List<int> ModOptionsCurrent { get; }
  Current values ​​for each setting.
• public bool UseLocalizedSring { get; }
  Whether to use LocalizedString for options and descriptions. This is optional; the default is false.
• public void OnModOptionChanged(int index, int value)
  This function is called when the settings are changed.

Example:

        public List<List<string>> ModOptions => [["Option 1", "Option 2"], ["Example 1", "Example 2", "Example 3"]];

        public List<string> ModOptionsDescription => ["Example Mod Setting"];

        public List<int> ModOptionsCurrent => [GetCurrentValue(0), GetCurrentValue(1)];

        public void OnModOptionChanged(int index, int value)
        {
            //Applying and Saving Settings
        }
        
        private int GetCurrentValue(int index)
        {
            //Get saved current settings
        }