Skip to content

[codex] Add localization support and Chinese translation #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
5151561 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[codex] Add localization support and Chinese translation #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f099f4c
Add localization support for LookingGlass UI
5151561 May 17, 2026
669bd45
Localize built-in stats display templates
5151561 May 17, 2026
f5c5ad4
Refresh localized option and stat strings
5151561 May 17, 2026
b492eaa
Refresh localized RiskOfOptions buttons
5151561 May 17, 2026
6945bb1
Address localization review gaps
5151561 May 17, 2026
5d4bc49
Localize stats display option UI
5151561 May 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 32 additions & 30 deletions LookingGlass/AutoSortItems/AutoSortItemsClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using BepInEx.Configuration;
using LookingGlass.Base;
using LookingGlass.LookingGlassLanguage;
using MonoMod.RuntimeDetour;
using RiskOfOptions;
using RiskOfOptions.Components.Options;
Expand Down Expand Up @@ -113,23 +114,23 @@ public void Setup()
{

instance = this;
ScrapSorting = BasePlugin.instance.Config.Bind<ScrapSortMode>("Auto Sort Items", "Scrap Sorting", ScrapSortMode.Start, "Where scrap should be sorted");
cfgSortByTier = BasePlugin.instance.Config.Bind("Auto Sort Items", "Tier Sort", TierSortMode.Tier, "Sorts by Tier");
TierOrder = BasePlugin.instance.Config.Bind<string>("Auto Sort Items", "Tier Order", "Lunar FoodTier VoidBoss Boss VoidTier3 Tier3 VoidTier2 Tier2 VoidTier1 Tier1 NoTier", "How the tiers should be ordered");
CombineVoidTiers = BasePlugin.instance.Config.Bind("Auto Sort Items", "Combine Normal And Void Tiers", false, "Considers void tiers to be the same as their normal counterparts");
ScrapSorting = BasePlugin.instance.Config.Bind<ScrapSortMode>("Auto Sort Items", "Scrap Sorting", ScrapSortMode.Start, LookingGlassLanguageAPI.ConfigDescription("Scrap Sorting", "Where scrap should be sorted"));
cfgSortByTier = BasePlugin.instance.Config.Bind("Auto Sort Items", "Tier Sort", TierSortMode.Tier, LookingGlassLanguageAPI.ConfigDescription("Tier Sort", "Sorts by Tier"));
TierOrder = BasePlugin.instance.Config.Bind<string>("Auto Sort Items", "Tier Order", "Lunar FoodTier VoidBoss Boss VoidTier3 Tier3 VoidTier2 Tier2 VoidTier1 Tier1 NoTier", LookingGlassLanguageAPI.ConfigDescription("Tier Order", "How the tiers should be ordered"));
CombineVoidTiers = BasePlugin.instance.Config.Bind("Auto Sort Items", "Combine Normal And Void Tiers", false, LookingGlassLanguageAPI.ConfigDescription("Combine Normal And Void Tiers", "Considers void tiers to be the same as their normal counterparts"));

cfgSortByStackSize = BasePlugin.instance.Config.Bind("Auto Sort Items", "Stack Size Sort", StackSortType.Largest_Smallest, "Sorts by Stack Size");
cfgSortByStackSize = BasePlugin.instance.Config.Bind("Auto Sort Items", "Stack Size Sort", StackSortType.Largest_Smallest, LookingGlassLanguageAPI.ConfigDescription("Stack Size Sort", "Sorts by Stack Size"));

SortQualityItems = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Quality Items", QualitySortType.Grouped, "Sorts quality items from ItemQualities mod\n\n\"Grouped\" keeps all versions of a given item together, similar to the mod's own grouping\n\"Separated\" separates out qualities, similar to tier sorting");
QualityItemsOrder = BasePlugin.instance.Config.Bind("Auto Sort Items", "Quality Items Order", QualitySortOrder.RareToCommon, "How qualities from ItemQualities mod should be ordered if quality sorting is on");
SortQualityItems = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Quality Items", QualitySortType.Grouped, LookingGlassLanguageAPI.ConfigDescription("Sort Quality Items", "Sorts quality items from ItemQualities mod\n\n\"Grouped\" keeps all versions of a given item together, similar to the mod's own grouping\n\"Separated\" separates out qualities, similar to tier sorting"));
QualityItemsOrder = BasePlugin.instance.Config.Bind("Auto Sort Items", "Quality Items Order", QualitySortOrder.RareToCommon, LookingGlassLanguageAPI.ConfigDescription("Quality Items Order", "How qualities from ItemQualities mod should be ordered if quality sorting is on"));

SortCommand = BasePlugin.instance.Config.Bind("Auto Sort Items", "Command Sorting", CommandSortType.Off, "Sorts Command menus by stack count or alphabetically.\n\n");
SortCommand = BasePlugin.instance.Config.Bind("Auto Sort Items", "Command Sorting", CommandSortType.Off, LookingGlassLanguageAPI.ConfigDescription("Command Sorting", "Sorts Command menus by stack count or alphabetically.\n\n"));
//Most people would be accustomed to the vanilla sort order, so shouldn't mess with that.
//Additionally sorting Void Potentials is just kind of, who cares.


SortScrapper = BasePlugin.instance.Config.Bind("Auto Sort Items", "Scrapper Sorting", ScrapperSortType.MatchHud, "Sorts Scrapper by stack count or alphetically.\n\nMatchHud will automatically use tier sorting and stacking sorting of the regular hud.");
SortScrapperTier = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Scrapper by Tier", true, "Sorts Scrapper by tier"); //While this should be on by default, because your hud is sorted by tier and you'd expect those two to correlate
SortScrapper = BasePlugin.instance.Config.Bind("Auto Sort Items", "Scrapper Sorting", ScrapperSortType.MatchHud, LookingGlassLanguageAPI.ConfigDescription("Scrapper Sorting", "Sorts Scrapper by stack count or alphetically.\n\nMatchHud will automatically use tier sorting and stacking sorting of the regular hud."));
SortScrapperTier = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Scrapper by Tier", true, LookingGlassLanguageAPI.ConfigDescription("Sort Scrapper by Tier", "Sorts Scrapper by tier")); //While this should be on by default, because your hud is sorted by tier and you'd expect those two to correlate
//The scrapper sorting should match, whatever is shown in the Hud, so they can see like ah yeah X item is between YZ and it's the same in the scrapper.

ScrapSorting.SettingChanged += SettingsChanged;
Expand All @@ -141,9 +142,9 @@ public void Setup()
QualityItemsOrder.SettingChanged += SettingsChanged;

//
SortPotentials = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Potentials & Fragments", false, "Sorts Void Potentials & Aurelionite Fragments according to Scrapper rules.");
SortDeathScreen = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Death Screen Items", false, "Sort items on the game over screen & run reports.");
sortCraftableItems = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Crafting Menu", true, "Sort items in the Wandering Chef or any crafting station, according to scrapper rules (alphabetical sorting not supported). \n\nAll items that cannot be used in any crafting recipe sorted to the bottom");
SortPotentials = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Potentials & Fragments", false, LookingGlassLanguageAPI.ConfigDescription("Sort Potentials & Fragments", "Sorts Void Potentials & Aurelionite Fragments according to Scrapper rules."));
SortDeathScreen = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Death Screen Items", false, LookingGlassLanguageAPI.ConfigDescription("Sort Death Screen Items", "Sort items on the game over screen & run reports."));
sortCraftableItems = BasePlugin.instance.Config.Bind("Auto Sort Items", "Sort Crafting Menu", true, LookingGlassLanguageAPI.ConfigDescription("Sort Crafting Menu", "Sort items in the Wandering Chef or any crafting station, according to scrapper rules (alphabetical sorting not supported). \n\nAll items that cannot be used in any crafting recipe sorted to the bottom"));

//
InitHooks();
Expand All @@ -152,32 +153,33 @@ public void Setup()

public void SetupRiskOfOptions()
{
ModSettingsManager.AddOption(new ChoiceOption(ScrapSorting, new ChoiceConfig() { restartRequired = false }));
ModSettingsManager.AddOption(new ChoiceOption(cfgSortByTier, new ChoiceConfig() { restartRequired = false }));
string autoSortCategory = LookingGlassLanguageAPI.ConfigCategory("Auto Sort Items");

ModSettingsManager.AddOption(new ChoiceOption(cfgSortByStackSize, new ChoiceConfig() { restartRequired = false }));
ModSettingsManager.AddOption(new ChoiceOption(ScrapSorting, new ChoiceConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(ScrapSorting.Definition.Key), restartRequired = false }));
ModSettingsManager.AddOption(new ChoiceOption(cfgSortByTier, new ChoiceConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(cfgSortByTier.Definition.Key), restartRequired = false }));

ModSettingsManager.AddOption(new ChoiceOption(SortCommand, new ChoiceConfig() { restartRequired = false, /*checkIfDisabled = CheckNotCommandSortAlphabetical*/ }));
ModSettingsManager.AddOption(new ChoiceOption(SortScrapper, new ChoiceConfig() { restartRequired = false, /*checkIfDisabled = CheckNotScrapperSortTierAlphabetical*/ }));
ModSettingsManager.AddOption(new CheckBoxOption(SortScrapperTier, new CheckBoxConfig() { restartRequired = false, checkIfDisabled = CheckNotScrapperSortTierAlphabetical }));
ModSettingsManager.AddOption(new ChoiceOption(cfgSortByStackSize, new ChoiceConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(cfgSortByStackSize.Definition.Key), restartRequired = false }));

ModSettingsManager.AddOption(new ChoiceOption(SortCommand, new ChoiceConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(SortCommand.Definition.Key), restartRequired = false, /*checkIfDisabled = CheckNotCommandSortAlphabetical*/ }));
ModSettingsManager.AddOption(new ChoiceOption(SortScrapper, new ChoiceConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(SortScrapper.Definition.Key), restartRequired = false, /*checkIfDisabled = CheckNotScrapperSortTierAlphabetical*/ }));
ModSettingsManager.AddOption(new CheckBoxOption(SortScrapperTier, new CheckBoxConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(SortScrapperTier.Definition.Key), restartRequired = false, checkIfDisabled = CheckNotScrapperSortTierAlphabetical }));

ModSettingsManager.AddOption(new StringInputFieldOption(TierOrder, new InputFieldConfig() { restartRequired = false, checkIfDisabled = CheckTierSort, lineType = TMPro.TMP_InputField.LineType.MultiLineSubmit, submitOn = InputFieldConfig.SubmitEnum.OnExitOrSubmit }));
ModSettingsManager.AddOption(new GenericButtonOption("Use Ascending Tiers Preset", "Auto Sort Items", "Sets the Tier Order option to use ascending tiers", "Set", SetAscendingTiers));
ModSettingsManager.AddOption(new GenericButtonOption("Use Descending Tiers Preset", "Auto Sort Items", "Sets the Tier Order option to use descending tiers", "Set", SetDescendingTiers));
ModSettingsManager.AddOption(new CheckBoxOption(CombineVoidTiers, new CheckBoxConfig() { restartRequired = false, checkIfDisabled = CheckTierSort }));
ModSettingsManager.AddOption(new StringInputFieldOption(TierOrder, new InputFieldConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(TierOrder.Definition.Key), restartRequired = false, checkIfDisabled = CheckTierSort, lineType = TMPro.TMP_InputField.LineType.MultiLineSubmit, submitOn = InputFieldConfig.SubmitEnum.OnExitOrSubmit }));
ModSettingsManager.AddOption(new GenericButtonOption(LookingGlassLanguageAPI.GetString("CONFIG_USE_ASCENDING_TIERS_PRESET_NAME", "Use Ascending Tiers Preset"), autoSortCategory, LookingGlassLanguageAPI.GetString("CONFIG_USE_ASCENDING_TIERS_PRESET_DESCRIPTION", "Sets the Tier Order option to use ascending tiers"), LookingGlassLanguageAPI.GetString("MISC_SET", "Set"), SetAscendingTiers));
ModSettingsManager.AddOption(new GenericButtonOption(LookingGlassLanguageAPI.GetString("CONFIG_USE_DESCENDING_TIERS_PRESET_NAME", "Use Descending Tiers Preset"), autoSortCategory, LookingGlassLanguageAPI.GetString("CONFIG_USE_DESCENDING_TIERS_PRESET_DESCRIPTION", "Sets the Tier Order option to use descending tiers"), LookingGlassLanguageAPI.GetString("MISC_SET", "Set"), SetDescendingTiers));
ModSettingsManager.AddOption(new CheckBoxOption(CombineVoidTiers, new CheckBoxConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(CombineVoidTiers.Definition.Key), restartRequired = false, checkIfDisabled = CheckTierSort }));

// hide these configs if itemqualities isn't loaded
if (ItemQualitiesLoaded)
{
ModSettingsManager.AddOption(new ChoiceOption(SortQualityItems, new ChoiceConfig() { restartRequired = false }));
ModSettingsManager.AddOption(new ChoiceOption(QualityItemsOrder, new ChoiceConfig() { restartRequired = false, checkIfDisabled = CheckQualitySort }));
ModSettingsManager.AddOption(new ChoiceOption(SortQualityItems, new ChoiceConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(SortQualityItems.Definition.Key), restartRequired = false }));
ModSettingsManager.AddOption(new ChoiceOption(QualityItemsOrder, new ChoiceConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(QualityItemsOrder.Definition.Key), restartRequired = false, checkIfDisabled = CheckQualitySort }));
}


ModSettingsManager.AddOption(new CheckBoxOption(SortPotentials, new CheckBoxConfig() { restartRequired = false }));
ModSettingsManager.AddOption(new CheckBoxOption(SortDeathScreen, new CheckBoxConfig() { restartRequired = false }));
ModSettingsManager.AddOption(new CheckBoxOption(sortCraftableItems, new CheckBoxConfig() { restartRequired = false }));
ModSettingsManager.AddOption(new CheckBoxOption(SortPotentials, new CheckBoxConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(SortPotentials.Definition.Key), restartRequired = false }));
ModSettingsManager.AddOption(new CheckBoxOption(SortDeathScreen, new CheckBoxConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(SortDeathScreen.Definition.Key), restartRequired = false }));
ModSettingsManager.AddOption(new CheckBoxOption(sortCraftableItems, new CheckBoxConfig() { category = autoSortCategory, name = LookingGlassLanguageAPI.ConfigName(sortCraftableItems.Definition.Key), restartRequired = false }));

}
//I'm going cross-eyed looking at all these
Expand All @@ -201,7 +203,7 @@ private void SetDescendingTiers()
// manually update the tier order option in the menu (which also updates the setting)
foreach (var controller in UnityEngine.Object.FindObjectsOfType<InputFieldController>())
{
if (controller.name.Contains("Tier Order"))
if (controller.name.Contains(TierOrder.Definition.Key) || controller.name.Contains(LookingGlassLanguageAPI.ConfigName(TierOrder.Definition.Key)))
{
controller.SubmitValue("Lunar FoodTier VoidBoss Boss VoidTier3 Tier3 VoidTier2 Tier2 VoidTier1 Tier1 NoTier");
}
Expand All @@ -211,7 +213,7 @@ private void SetAscendingTiers()
{
foreach (var controller in UnityEngine.Object.FindObjectsOfType<InputFieldController>())
{
if (controller.name.Contains("Tier Order"))
if (controller.name.Contains(TierOrder.Definition.Key) || controller.name.Contains(LookingGlassLanguageAPI.ConfigName(TierOrder.Definition.Key)))
{

controller.SubmitValue("Tier1 VoidTier1 Tier2 VoidTier2 Tier3 VoidTier3 Boss VoidBoss FoodTier Lunar NoTier");
Expand Down
12 changes: 11 additions & 1 deletion LookingGlass/BasePlugin.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
using LookingGlass.HidePickupNotifs;
using LookingGlass.ItemCounters;
using LookingGlass.ItemStatsNameSpace;
using LookingGlass.LookingGlassLanguage;
using LookingGlass.PickupNotifsDuration;
using LookingGlass.ResizeCommandWindow;
using LookingGlass.StatsDisplay;
Expand Down Expand Up @@ -54,11 +55,14 @@ public class BasePlugin : BaseUnityPlugin
public static Sprite logo2;

internal bool ItemQualitiesLoaded = false;
const string ModDescriptionFallback = "Stat info, item stacking info, skill and equipment cooldown info, and much more ui related things.";

public void Awake()
{
Log.Init(Logger);
instance = this;
LookingGlassLanguageAPI.Init(Info.Location);
Language.onCurrentLanguageChanged += RefreshRiskOfOptionsLocalization;
try
{
string folderName = System.IO.Path.Combine(System.IO.Path.GetDirectoryName(Info.Location), "icons");
Expand Down Expand Up @@ -107,7 +111,13 @@ public void Awake()

statsDisplayClass.CheckForOldDefaultSettingsThatNeedToBeUpdated();

ModSettingsManager.SetModDescription("Stat info, item stacking info, skill and equipment cooldown info, and much more ui related things.");
RefreshRiskOfOptionsLocalization();
}

void RefreshRiskOfOptionsLocalization()
{
ModSettingsManager.SetModDescription(LookingGlassLanguageAPI.GetString("MOD_DESCRIPTION", ModDescriptionFallback));
LookingGlassLanguageAPI.RefreshRiskOfOptionsTokens();
}

private void FixedUpdate()
Expand Down
12 changes: 6 additions & 6 deletions LookingGlass/BuffDescriptions/BuffDefinitions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ internal static class BuffDefinitions
{
internal static void SetupEnglishDefs()
{
string utilityString = "<style=\"cIsUtility>";
string damageString = "<style=\"cIsDamage>";
string healingString = "<style=\"cIsHealing>";
string healthString = "<style=\"cIsHealth>";
string voidString = "<style=\"cIsVoid>";
string shrineString = "<style=\"cShrine>";
string utilityString = "<style=cIsUtility>";
string damageString = "<style=cIsDamage>";
string healingString = "<style=cIsHealing>";
string healthString = "<style=cIsHealth>";
string voidString = "<style=cIsVoid>";
string shrineString = "<style=cShrine>";
string styleString = "</style>";

//Stop using "health" for "healing" related things
Expand Down
Loading