Локализация

Как это устроеноСкопировать ссылку

В клиенте четыре языка: русский, английский, украинский и польский. Скрипту не нужно спрашивать, какой из них выбран, и подставлять строки самому. Вместо готовой строки пишут ключ, а переводы объявляют один раз через lang. Клиент подставит нужный язык, а если игрок сменит его прямо в игре, надписи поменяются вместе с ним.

1
2
3
4
5
6
7
8
9lang.load({
    "ru_ru": {"mymod.speed": "Скорость", "mymod.hi": "Привет, %s"},
    "en_us": {"mymod.speed": "Speed", "mymod.hi": "Hi, %s"},
})

mod = Module("MyMod", "Visuals")
speed = Slider(mod, "mymod.speed").min(1).max(10)   # в меню будет на языке игрока

client.msg(lang("mymod.hi", "Steve"))               # своя строка с подстановкой

Ключ, для которого перевода не нашлось, показывается как есть. Это удобно: сразу видно, какой строки не хватает, и скрипт при этом продолжает работать.

Что переводится самоСкопировать ссылку

Часть надписей клиент прогоняет через переводы на каждой отрисовке. Достаточно назвать их ключом, и больше ничего делать не нужно.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20lang.load({
    "ru_ru": {
        "mymod.speed": "Скорость",
        "mymod.speed.description": "Насколько быстро крутится анимация",
        "mymod.mode": "Режим",
        "mymod.mode.soft": "Мягкий",
        "modules.descriptions.mymod": "Мой первый модуль",
    },
    "en_us": {
        "mymod.speed": "Speed",
        "mymod.speed.description": "How fast the animation spins",
        "mymod.mode": "Mode",
        "mymod.mode.soft": "Soft",
        "modules.descriptions.mymod": "My first module",
    },
})

mod = Module("MyMod", "Visuals")
speed = Slider(mod, "mymod.speed").min(1).max(10)
mode = Mode(mod, "mymod.mode").add("mymod.mode.soft")

Ключи вместо строк в настройкахСкопировать ссылку

Заодно ключ решает старую беду: имя настройки это её адрес в конфиге. Переименовал Скорость в Скорость анимации, и сохранённое у игрока значение потерялось. С ключом видимая надпись меняется в переводах, а адрес в конфиге остаётся прежним.

Переводы отдельным файломСкопировать ссылку

Когда строк много, их держат в json рядом со скриптом. Верхний уровень это коды языков. Путь считается от папки со скриптами, и вместо него можно дать ссылку.

1
2
3
4
5
6
7
8
9
10{
    "ru_ru": {
        "mymod.speed": "Скорость",
        "mymod.hi": "Привет, %s"
    },
    "en_us": {
        "mymod.speed": "Speed",
        "mymod.hi": "Hi, %s"
    }
}

1
2lang.load_file("lang.json")
lang.load_file("https://site.ru/mymod/lang.json")   # можно и ссылкой

Подстановки и числаСкопировать ссылку

В строку можно вставлять значения: %s для любого, %d для целого числа, %.1f для дробного. Порядок подстановок одинаков во всех языках.

1
2
3
4
5
6lang.load({
    "ru_ru": {"mymod.killed": "Убит %s, осталось %d"},
    "en_us": {"mymod.killed": "Killed %s, %d left"},
})

client.msg(lang("mymod.killed", "Steve", 3))

Для слов, которые меняются по числу, есть lang.plural. В русском, украинском и польском форм три, в английском две, и клиент выбирает нужную по текущему языку.

1
2n = 5
client.msg("%d %s" % (n, lang.plural(n, "игрок", "игрока", "игроков")))   # 5 игроков

Смена языка на летуСкопировать ссылку

Надписи, которые клиент рисует сам, обновятся без твоего участия. Пересобрать нужно только те строки, которые скрипт перевёл один раз и положил в переменную. Для этого есть событие language_changed.

1
2
3
4
5
6
7
8title = lang("mymod.title")


@events.language_changed
def on_language(event):
    global title
    title = lang("mymod.title")
    client.msg("язык теперь " + event.getCode())

Текущий язык можно спросить и напрямую: lang.current() вернёт ru_ru, en_us, uk_ua или pl_pl.

Все методыСкопировать ссылку

Хватит одного языкаСкопировать ссылку

Переводить на все четыре языка необязательно. Если нужного нет, клиент возьмёт английский, потом русский, потом любой заданный, и только в последнюю очередь покажет ключ. Скрипт с одним языком остаётся рабочим для всех.