Suggestion for Localisation Tutorial

Place to get help with not working mods / modding interface.
Pi-C
Smart Inserter
Smart Inserter
Posts: 1760
Joined: Sun Oct 14, 2018 8:13 am
Contact:

Suggestion for Localisation Tutorial

Post by Pi-C »

Since working on my latest mod, I've dug a bit into localization and found that there is a category [mod-description]. By using the internal name of your mod as a localization key, you can provide a localized description of your mod that will be displayed by the in-game mods manager.

Unfortunately, I didn't see it mentioned in the tutorial, and I guess that is the main reason why so many mods don't have translations of their description: Even many (most?) of the mod authors who provide localized strings for their mod don't include it -- either because they don't know about it, or because they don't care as their native language is English anyway and they don't see a need to provide the same description they used in info.json also in the localization file. Translators, on the other hand, usually only translate only the strings they get by the mod author (i.e. the original localization file). The result is that a mod with full localization of everything else will be shown with the original (usually English) description.

Could you include this missing information in the tutorial, please?
A good mod deserves a good changelog. Here's a tutorial (WIP) about Factorio's way too strict changelog syntax!
Bilka
Factorio Staff
Factorio Staff
Posts: 3464
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: Suggestion for Localisation Tutorial

Post by Bilka »

points at https://wiki.factorio.com/Tutorial:Mod_ ... escription

Anyway, "list of base game localization categories" is on my to-do, but it looks like those are not defined in any central place in the code so it will take a while/be potentially inaccurate.
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.
Pi-C
Smart Inserter
Smart Inserter
Posts: 1760
Joined: Sun Oct 14, 2018 8:13 am
Contact:

Re: Suggestion for Localisation Tutorial

Post by Pi-C »

Bilka wrote: Tue Sep 24, 2019 12:09 pm points at https://wiki.factorio.com/Tutorial:Mod_ ... escription
I knew I must have read about this somewhere, but I couldn't find it again. That's why I asked for including it in the most obvious place. :-)
Anyway, "list of base game localization categories" is on my to-do, but it looks like those are not defined in any central place in the code so it will take a while/be potentially inaccurate.
Nice to know it's on your list. About things being inaccurate: If you indicate in the text where you are in doubt, that should be fine …
A good mod deserves a good changelog. Here's a tutorial (WIP) about Factorio's way too strict changelog syntax!
Post Reply

Return to “Modding help”