Interact with localizaton

[andy840119]

It's the base implementation of trying to translate the karaoke ruleset.
The full step of adding localization can see #1265

What's done in this PR:

• Install package for localization hint and auto-generate the class.
• Add dotnet tool.json for able to generate the localization resource file(.resx)
• Create the localization class for testing purposes.
• Create the localization resource file.

[andy840119]

Let's test on the release build

[andy840119]

Seems not working in the release build.
Need to check the reason.

[update]

Got no idea why zh.resx and ja.resx is missing while packing.
Checked by the dotpeek.

[another update]

Got no idea why the resource is still missing in the local debug build, but Japanese localization can be loaded in the osuGame test scene.

[andy840119]

Also, not really sure should place the localization file into:

• <root>/Localisation -> will let the code and file in the same namespace.
• <root>/Resources/Localisation -> need to setup .editorconfig and deal with Duplicated resource issue(NETSDK1022)

[andy840119]

Make the reference:
https://crowdin.com/project/karaoke-dev
The translation is available here.

[andy840119]

Check:

• is all language can be found in the resources dll

Damn, got no idea why some of the localization files are missing(or not visible?)

[andy840119]

But it's OK to catch the fall-back localization fie(?) in the release environment.
So seems it might have an issue getting another kind of localization file?

[andy840119]

todo:

• Check all the localization strings if exist. See: https://stackoverflow.com/a/2041057

[update]
Tested in this code, but seems it's only able to read the resource file.

 new StreamReader(matchingAssembly.GetManifestResourceStream("osu.Game.Rulesets.Karaoke.Localisation.KaraokeSettingsSubsection.resources")).ReadToEnd()

[andy840119]

Seems it's the issue related to the return manager.GetString(key, EffectiveCulture); in ResourceManagerLocalisationStore. It's only able to get the default localization.
Or the localization does not pack well in the release build.
Very not sure.

Not sure related to those kinds of issues:
dotnet/android#4664
https://stackoverflow.com/questions/33274715/wrong-culture-string-from-resourcemanager-getstring

[smoogipoo]

Hmm.. So it looks like you need the osu.Game.Rulesets.Karaoke.resources.dll files placed inside /bin/{Debug/Release}/netstandard2.1/{locale}/. Copying them inside the osu.Desktop/bin/Debug/net6.0/{locale} dirs seems to work for me.

Can you confirm this is the case?

Bundling the localisation files alongside the ruleset also seems to work, like:

This would be a .NET ResourceManager localisation, it needs those files and can't search inside the parenting assembly... Not sure how to handle this yet but it's a good find. I would say that bundling the localisation files as above is a reasonable solution for now.

[andy840119]

Big thanks for the testing for this issue 🙏🏼 .
I might test this issue in a few days in the osx.

[andy840119]

Tested, both way works in the osx.

But have some (maybe) bad news:

• I have made traditional chinese(zh-TW) localization as well, but seems the folder(zh-TW) and resource file doesn't generated.
• Trying to packing them as single dll, but this way seems doesn't work.(Checked that the resource is inside the dll)
  

[smoogipoo]

but seems the folder(zh-TW) and resource file doesn't generated

This is weird. It looks like it needs to be called zh-Hant for it to be generated. I've made an issue tracking this here: ppy/osu-localisation-analyser#44.

Trying to packing them as single dll, but this way seems doesn't work

Yeah, that's why I mentioned ResourceManager doesn't search the parenting assembly. I noticed you're using IL repack 😄

[andy840119]

Conclusion:

• Will working if copy the osu.Game.Rulesets.Karaoke.resources.dll into the right position.
• zh-TW localization resource file not generated issue is fixing.

Guess it's harmless if merged.
Will open another issue if has another new progress(e.g: zh-TW issue or found a new way to deal with the localization or interact with CI).

Also, might open another issue for packing the localization resource file as zip for users who wants to use the localization with release build.

[smoogipoo]

After ppy/osu#17785, you'll be able to rename it to zh-Hant