Localization - hasegaw/IkaLog GitHub Wiki

Localization (l10n)

While IkaLog support only a few version of Splatoon, hasegaw (and probably other IkaLog developers) are flexible to support other language versions of Splatoon - if developers are interested in expanding language support. In fact, more than 50% of Splatoon sales are non-Japanese version, according to Nintendo IR.

I'd happy to expand this software to more people,and L10N support definitely expands IkaLog community. Fortunately some people already done the most part of localization for en_US, so it's relatively easy way to move forward.

Documentation, Wiki postings, For pull requests, and commit logs, either English or Japanese are accepted. I'm very flexible for any inklings.

Contact: @hasegaw at Twitter. Note - original IkaLog team won't localize the software for you. Localization should be done and tested by the local users.

Localization Status

Language, Region Status Remarks
Japanese 100% Baseline
en_NA (North America) 100%
en_EU (Europe) 90% Works great. We don't have deadly weapon detection data yet. Messages are based on en_NA.
Other 0% Localization is not started. Need contributors for each region.

What we need

  • Engineering resource (Python program development, and mask data manipulation)
  • Screenshots and very HQ videos (>6Mbps x264 recommended), to manipulate masks and test.

Localization procedures

Determine the IKALOG_LANG code

IkaLog uses environment variable IKALOG_LANG to switch localized contents. It is used to find localized files, and lookup localized text names. Consult with IkaLog core developers.

  • ja ... Japanese
  • en_NA ... English, North America

Update ikalog/constants.py

ikalog/constants.py should have localized messages.

Add mask data

  • IkaLog uses mask images (and more data) to recognize the scenes. Look into masks/en/* to find out what kind of data is needed.
  • Dig a folder masks/$IKALOG_LANG/
  • Add masks to the folder.

Add locale files

  • IkaLog is based on gettext. Look into locale/ja/* to find out how to localize.

Code modifications needed

Some of the code needs modification.

  • SplatFest title recognition - needs a language-specific the recognition strategiy
  • Cause of Death recognition - the coordinates for clipping the glyph if specific to Splatoon version.

Training ML data

IkaLog needs language-specific machine-learning data.