Public repository for ReLocalization (Potion Craft Mod / BepInEx 5 plugin).
Hierarchy of default localization system in Potion Craft looks like this:
┌──────┐ ┌─────┐
│locale│ -> │value│
┌───┐ ├──────┤ ├─────┤
│key│ -> │locale│ -> │value│
└───┘ ├──────┤ ├─────┤
│locale│ -> │value│
└──────┘ └─────┘
And it really pisses me off. If someone wants to add new words to the localization, correct the translation, or simply add a new language - they hill have to suffer and rummage through an endless number of game files, reading tons of information noise, in attempts to write simple 'key:value' state.
But what if the structure was like this:
┌───┐ ┌─────┐
│key│ -> │value│
┌──────┐ ├───┤ ├─────┤
│locale│ -> │key│ -> │value│
└──────┘ ├───┤ ├─────┤
│key│ -> │value│
└───┘ └─────┘
Then it would be enough to simply find or create a localization file with the desired language, for example 'en.yml', and add/change the 'key:value'. It will make life easier for translators who want to translate - not suffer (who ever wants???)
This mod actually does just that.
- For translators: Simply find '..\Potion Craft\BepInEx\plugins\Localization\{GUID}' folder, where GUID is desired Mod's ID (some word, string), and create '*.yml' file with lang code name like that: 'en.yml'. List of language codes supported by Potion Craft:
- ru - Russian (Potion Craft author's native language),
- en - English (Default localization language),
- de - German,
- fr - French,
- it - Italian,
- es - Spanish,
- ptBR - Portuguese,
- pl - Polish,
- tr - Turkish,
- zh - Simplified Chinese,
- ja - Japanese,
- ko - Korean,
- th - Thai,
- cs - Czech.
- For modders: just add mod's dll to project and write following line of code in any suitable place (Awake() method in your BaseUnityPlugin):
Localization.AddLocalizationFor(this);
Don't forget to create mod localization files and folder. As example - '..\Potion Craft\BepInEx\plugins\Localization\AirBurn.ReLocalization\en.yml' would provide localization for this mod. If it had it (however, you can still write something there and for sure, funny things will happen).
Localization file structure, if it's not obvious, - YAML. This means that the content of the files will look like this:
# comment
localization_key_string: value
idk_some_key: "idk some value"
Quotes aren't necessary for plain text, since it's YAML.
Basically there is no guides. If some more complex examples needed - consider searching for some mod that uses this and reading it's repo.
Crucible (Potion Craft) exists, you know?
Yeah, I know.
Developers aren't Russians - won’t use.
Crucible is really cool and very comfortable zero-code modding framework (myself tested), but that doesn't really apply to localization issue. Crucible Dev's decided not to reinvent the wheel and use essentially the same approach as Potion Craft uses (btw understandable), and I have already explained my attitude to default localization system.
Unfortunately - no. I started studying Unity quite recently, and the code is most likely complete crap. So perhaps what I did is even worse (in terms of performance) than what already exists. Mod was written in about 3 hours and I didn’t really tested it. There are most likely quite a few bugs, and I would be glad if they were at least reported.
Perhaps it’s even more convenient for development or something like that to use default Potion Craft's localization system or even Crucible, but I don’t know many developers who speak >10 languages, and I’m also not familiar with >10 developers from different countries each speaks at least one of game's different localization language. So I personally will need a helping hand of non-developer translators, otherwise Google Translator is certainly cool, but... who knows - they knows. And the less they have to suffer, the greater the chance that volunteers will appear someday.
And one more benefit for me - no need to fumble around in the code - just upload the file and that's all.