Vladya

Описание настроек и настроечного файла.

---

Общий вид настроечного файла:

{
    "gameLanguage": "en",
    "directionOfTranslation": "ru",
    "modeOnStartup": "off",
    "_debug_mode": false,
    "translationService": "selenium_deepl",
    "workMethod": "dialogueOnly",
    "originalInHistory": false,
    "requestsFrequency": null,
    "splitTextAsSentences": false,
    "googleHost": "translate.google.com",
    "seleniumStartMode": "hide",
    "seleniumInputSplitMethod": "strings",
    "extraTextOptions": {
        "font": null,
        "size": null,
        "italic": false,
        "bold": false
    }
}

---

• Формат описания следующий:
  • Сначала идёт название параметра в настроечном файле.
    • На этой же строке указывается номер-сноска типа допустимых данных.
      • Текстовый тип данных: ¹
        • Ожидается ввод значения, экранированного кавычками.
      • Булевый тип данных: ²
        • true / false
      • Положительный числовой тип данных: ³
        • Ожидается ввод числа из множества положительных вещественных чисел.
  • На следующей строке указывается название соответствующего пункта в GUI⁴.
    • Только если он имеется. т.к. присутствуют параметры, недоступные в GUI⁴.
  • Далее следует объяснение специфики пункта.

---

• В тексте могут встречаться следующие термины: прескан, рилтайм перевод, etc. Информацию о них можно найти в соответсвующих разделах FAQ.

• Если в документации имеются пункты настройки, которых пока нет в переводчике, их следует игнорировать, т.к. документация пишется одновременно с обновлением переводчика и, на данный момент, эти пункты ещё в бета-тесте.

---

• Дисклеймер:

  1. Информация, представленная в этой документации, исключительно ознакомительного характера.
  2. Все необходимые настройки лучше проводить в GUI⁴.
  3. Крайне не рекомендуется менять что либо в настроечном файле, без полного понимания своих действий.
  4. Создатель переводчика не несёт никакой ответственности за некорректную работу, при ручном изменении настроечного файла.

---

Описание параметров.

1. gameLanguage: ¹

   • “Исходный язык игры.” ⁵

   • Язык самой игры (с которого нужен перевод).

     • Код языка от конкретного сервиса, либо название языка на английском.
       • Примеры допустимых параметров:
         • “en”
         • “en-GB”
         • “Portuguese”
         • “Polish”
         • “Chinese”

2. directionOfTranslation: ¹

   • “Направление перевода.” ⁵

   • Язык на который нужно перевести игру.

     • Формат указываемых данных идентичен параметру gameLanguage.

3. modeOnStartup: ¹

   • Режим работы переводчика при старте игры.

   • Принимаются 4 параметра:

     • “off”:
       • При старте ничего не происходит. Нужный режим запускается вручную.
       • Рекомендуемый вариант использования.
     • “db_only”:
       • При старте активируется режим перевода только из базы данных.
       • Читать о режиме подробнее.
     • “realtime”:
       • При старте активируется режим перевода в реальном времени.
       • Читать о режиме подробнее.
     • “prescan”:
       • При старте активируется предварительное сканирование.
       • Читать о режиме подробнее.

4. _debug_mode: ²

   • “Режим отладки.” ⁵

   • Режим отладки.
   • При активированном параметре работа переводчика меняется следующим образом:
     • При возникновении ошибки, будет брошен трейсбек.
     • Будет активировано логирование действий переводчика.
   • За исключением особых случаев, в активации этого параметра нет необходимости.

5. translationService: ¹

   • “Сервис перевода.” ⁵

   • Сервис который будет осуществлять перевод.

   • Доступны следующие значения:

     • “google_gtx”:

       • Небраузерная логика.
       • Сервис с самым лучшим (из небраузерных) качеством перевода.
       • т.к. Google банит при подозрении на автоматизацию, скорость запросов принудительно снижена до 8 запросов в минуту.

     • “google_client5”:

       • Небраузерная логика.
       • Сервис с посредственным (по крайней мере в “ru” направлении) качеством перевода, но хорошей скоростью.

     • “google_rpc”:

       • Небраузерная логика.
       • Полностью идентичен “google_client5”, но с возможностью менять хост сервиса (параметр “googleHost”).

     • “selenium_deepl”:

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

6. workMethod: ¹

   • “Способ работы переводчика.” ⁵

   • Способ работы переводчика.

   • Доступны следующие значения:

     • “dialogueOnly”:
       • “Перевод диалогов и меню.” ⁵
       • Переводчик будет использовать для работы параметр config.say_menu_text_filter.
       • Будут переведён основной текст (в диалоговом окне) и меню выбора.
       • В большинстве случаев рекомендуется использовать именно этот параметр.
     • “allText”:
       • “Перевод всего текста в игре (Бета).” ⁵
       • Переводчик будет использовать для работы перезапись метода Text.set_text.
       • Будет переведён весь выводимый на экран текст.
       • Режим находится в бета стадии и не рекомендуется к использованию без крайней необходимости.
       • Так как при активации параметра будет переведён весь текст на экране, возможно длительное “зависание” игры.
       • Абсолютно противопоказано к использованию, если игра демонстрирует динамические данные.
         • Такие как:
           • Время.
           • Изменяющиеся статы персонажа.
           • etc.
         • Потому как переводчик будет пытаться перевести каждое из новых значений, что приведёт к полному зависанию процесса.

7. originalInHistory: ²

   • “Сохранять оригинал в истории.” ⁵

   • При активированном параметре на экран “истории” будет выводиться оригинальный текст, вместо перевода.

8. requestsFrequency: ³

   • “Частота запросов.” ⁵

   • Частота обращений к сервису перевода.
     • Количество запросов в минуту.
   • Для некоторых сервисов перевода значение фиксировано.
   • Для браузерной логики игнорируется.

9. splitTextAsSentences: ²

   • “Разделять предложения при переводе.” ⁵

   • При активированном параметре, перед переводом текст будет разделён на “предложения” по паттерну:

       # Python RE logic.
       r"(?P<text>[^!?….\r\n]+)(?P<end_mark>[!?….]*)"
     

   • Некоторые сервисы перевода (например google_client5) возвращают некорректный перевод, если в тексте присутствуют излишние знаки препинания. Данная настройка позволяет избежать подобного.
   • В некоторых сервисах этот параметр активирован по умолчанию и настройка игнорируется (например ранее обозначенный google_client5).
   • Активировать данный параметр не рекомендуется.
     • В тех сервисах где он нужен, он активирован по умолчанию.

10. googleHost: ¹

    • Хост для сервиса перевода google_rpc.
      • При выборе иных сервисов параметр игнорируется.
    • Для стран, где стандартный translate.google.com работает некорректно (или медленно).
    • Например:
      • Для Латвии:
        • “translate.google.lv”
      • Для Китая:
        • “translate.google.cn”
      • И так далее…

11. seleniumStartMode: ¹

    • Режим запуска браузера для работы браузерной логики.
      • Подробнее о браузерной логике в соответствующем разделе в FAQ.
    • Доступны следующие значения:
      • “hide”:
        • Браузер будет запущен как фоновый процесс и не будет мешаться на панели задач.
      • “default”:
        • Браузер запустится в обычном режиме.
          • При перезапусках браузер так же вернётся в обычный режим, даже если пользователь свернёт окно.
      • “minimized”:
        • Идентично параметру “default”, но, после запуска, браузер свернётся.
    • Важно:
      • т.к. браузерная логика автоматизирована, вмешательство пользователя (как в примере ниже) может помешать корректной работе:
        • Нажатие кнопок на странице перевода.
        • Открытие вкладок.
        • Закрытие окна перевода.
        • etc.
      • В случае подобного вмешательства жалобы на некорректную работу не принимаются.

12. seleniumInputSplitMethod: ¹

    • Режим разделения вводимого текста, для сервисов с браузерной логикой.

    • Доступны следующие значения:

      • “all”:
        • Весь текст будет введён сразу.
        • Возможно подвисание, если текст велик.
        • Возможно обнаружение браузером автоматизации.
      • “strings”:
        • Текст будет введён по строкам.
      • “symbols”:
        • Текст будет введён посимвольно, без паузы между вводом.
      • “humanTyping”:
        • Имитация ввода человеком со средней скоростью печати - 450 символов в минуту (реальное значение рандомизируется).

13. extraTextOptions:

    • “Настройки отображаемого текста.” ⁵

    1. font: ¹

       • “Шрифт.” ⁵
       • Шрифт с которым будет выводиться текст.
       • Путь к файлу шрифта задаётся относительно папке “%NovelDir%\game”, где %NovelDir% - папка с игрой.
         • К примеру, шрифт лежит в папке:
           • “C:\Games\MyNovel\game\fonts\Comic Sans.otf”
         • Значит в файле следует прописать:
           • “fonts/Comic Sans.otf”
             • Все обратные слеши (\), если они имеются в пути, следует заменить на прямые (/).
       • Выбрав шрифт один раз - операцию не обязательно повторять для каждой игры.
         • Все используемые шрифты кешируются.
           • При указании в другой игре шрифта, который уже был выбран ранее, файл добавится автоматически.
           • Так же шрифт можно выбрать в GUI⁴ в пункте “Выбрать из использовавшихся ранее”.

    2. size: ¹

       • “Размер.” ⁵
       • Размер выводимого текста.
       • Принимается положительное целое число, либо выражение в формате Ren’Py.

    3. italic: ²

       • “Курсивный текст.” ⁵
       • При активированном параметре делает выводимый текст курсивным.

    4. bold: ²

       • “Жирный текст.” ⁵
       • При активированном параметре делает выводимый текст жирным.

1. Текстовый тип данных. Ожидается ввод значения, экранированного кавычками. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷ ↩⁸ ↩⁹ ↩¹⁰ ↩¹¹

2. Булевый тип данных. true/false. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶

3. Положительный числовой тип данных. Ожидается ввод числа из множества положительных вещественных чисел. ↩ ↩²

4. Graphical User Interface. Графический интерфейс. Окно настройки, появляющееся в игре. ↩ ↩² ↩³ ↩⁴

5. Название параметра в графическом интерфейсе. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷ ↩⁸ ↩⁹ ↩¹⁰ ↩¹¹ ↩¹² ↩¹³ ↩¹⁴ ↩¹⁵