SunkenlandLocalizationAPI

Note: This description is bilingual. The Chinese section is provided below the English section.

Note: This description is a bilingual version in Chinese and English. The Chinese content is located below the English content.

Sunkenland Localization API (English)

Sunkenland Localization API is a shared localization library for Sunkenland mods.

What This Mod Does

• Lets compatible mods load their own external JSON language files.
• Uses Sunkenland's active language and refreshes registered mod text after a language change.
• Supports localized config sections, setting names, descriptions, dropdown values, ordering, and slider steps.

For Players

This mod is an API/dependency. It does not add gameplay features by itself.

Install it only when another mod lists Sunkenland Localization API as a requirement.

For Mod Authors

Reference SunkenlandLocalizationAPI.dll and add a hard BepInEx dependency:

using BepInEx;

using BepInEx.Configuration;

using SunkenlandLocalizationAPI.Api;

[BepInDependency(SunkenlandLocalizationAPI.PluginInfo.PLUGIN_GUID)]

public sealed class MyPlugin: BaseUnityPlugin

{

private void Awake()

{

Config.Bind("General", "Enabled", true, I18n.Localizer.Config("config.enabled", 10, "General", "config.general", 10));

LocalizationApi.LanguageChanged += OnLanguageChanged;

}

private static void OnLanguageChanged(string language)

{

// Refresh this mod's existing UI text here.

}

}

Load the JSON file from the directory containing your mod DLL. This also works with generated r2modman and mod-manager folder names:

using System.IO;

using System.Reflection;

using SunkenlandLocalizationAPI.Api;

internal static class I18n

{

private const string FileName = "MyMod.Localization.json";

private static readonly ModLocalizer _localizer = Load();

internal static ModLocalizer Localizer

{

get { return _localizer; }

}

internal static string Text(string key, params object args)

{

return _localizer.GetLocalizedText(key, args);

}

private static ModLocalizer Load()

{

string directory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);

ModLocalizer localizer = LocalizationApi.For(PluginInfo.PLUGIN_GUID);

localizer.RegisterJson(Path.Combine(directory, FileName));

return localizer;

}

}

The Config call uses.name and.description. Enum and acceptable-list values use a normalized lowercase suffix, so SafeMode resolves to.safe_mode automatically:

Config.Bind("General", "Mode", MyMode.SafeMode, I18n.Localizer.Config("config.mode", 20, "General", "config.general", 10));

Pass an AcceptableValueRange and sliderStep to declare a custom range-slider step in the same call:

Config.Bind("Display", "Scale", 100, I18n.Localizer.Config("config.scale", 10, "Display", "config.display", 20, new AcceptableValueRange(50, 200), sliderStep: 5d));

Single JSON file example:

{

"en": {

"config.general": "General",

"config.enabled.name": "Enabled",

"config.enabled.description": "Enable this mod.",

"config.mode.name": "Mode",

"config.mode.description": "Select the operating mode.",

"config.mode.safe_mode": "Safe"

},

"zh-Hans": {

"config.general": "General",

"config.enabled.name": "Enabled",

"config.enabled.description": "Enable this mod.",

"config.mode.name": "mode",

"config.mode.description": "Select the running mode.",

"config.mode.safe_mode": "safe"

}

}

Every localization file must contain an en object. If the current language or requested key is missing, the API tries en; if the key is still missing, it returns the key itself.

Supported Locale Codes

• English: en
• Chinese (Simplified): zh-Hans
• French: fr
• German: de
• Japanese: ja
• Korean: ko
• Russian: ru
• Spanish: es
• Turkish: tr

Compatibility

• Game version: Beta 0.8.41+

Bug Reports & Feature Suggestions

If you have any questions or feature suggestions, please submit them through GitHub Issues, contact me on Discord at iceboxcool, or email me at 764884112@qq.com or ibox2333@gmail.com.

If you enjoy my mods, feel free to support me! / If you like my mod …