Оглавление:
  1. Общая информация
  2. Установка
  3. Обновление
  4. Дополнительная информация по конфигурационному файлу
  5. Создание персональной конфигурации

-----------------------------------------------------------
1. ОБЩАЯ ИНФОРМАЦИЯ
-----------------------------------------------------------

  Этот мод включает в себя следующие возможности:
    * Настраиваемые маркеры над танками
    * Отключение посмертной панели
    * Управление зеркалированием иконок
    * Управление "ушами" (ширина, прозрачность, содержание)
    * Часы на экране загрузки боя
    * Иконки игрока, клана
    * Разные наборы иконок техники как для команд, так и для ушей, экрана загрузки и т.д.
    * Статистика игроков
    * Дополнительная информация в полосе захвата
    * Настраиваемая миникарта
    * Отображение расширенной статистики в личных достижениях
    * Отображение информации о танке в окне взвода
    * Статус засвета врага в правой боковой панели
    * Автоматическая посадка всего экипажа
    * Отображение пинга серверов до входа на сервер или в бой

  Сайт проекта:             https://modxvm.com/

  Как написать в поддержку: https://koreanrandom.com/forum/topic/1644-readme/
  Поддержка:                https://koreanrandom.com/forum/forum/43-xvm/
  FAQ:                      https://modxvm.com/faq/
  Конфиги:                  https://koreanrandom.com/forum/forum/50-/

-----------------------------------------------------------
2. УСТАНОВКА
-----------------------------------------------------------

  1. Разархивировать архив в папку с игрой:
     Правой кнопкой на архив -> "Извлечь все..." -> выбрать папку игры -> "Извлечь"

  2. По умолчанию ничего настраивать не надо.

    Если нужны нестандартные настройки, необходимо переименовать загрузочный файл:
      \res_mods\configs\xvm\xvm.xc.sample в xvm.xc
    Инструкции по его настройке находятся внутри.

    Увидеть все возможные настройки можно в папке
      \res_mods\configs\xvm\default\

    Внимание:
    Для редактирования используйте Notepad++. https://kr.cm/f/t/1382/c/25815/
    В случае блокнота Windows: Сохранить как -> Кодировка: UTF.
    НЕ используйте word, wordpad и подобные редакторы

  3. Если XVM неправильно определяет язык клиента игры,
    то в конфигурационном файле (по умолчанию \res_mods\configs\xvm\default\@xvm.xc )
    смените значение переменной "language" с "auto" на код языка.
    Код языка должен совпадать с именем файла в папке \res_mods\mods\shared_resources\xvm\l10n\ (например, "en").

  4. Существует возможность установки ночных сборок XVM.
    Скачать ночные сборки можно на https://nightly.modxvm.com/

-----------------------------------------------------------
3. ОБНОВЛЕНИЕ
-----------------------------------------------------------

  1. Разархивировать архив в папку с игрой:
    Правой кнопкой на архив -> "Извлечь все..." -> выбрать папку игры -> "Извлечь"

  2. Больше НИЧЕГО делать НЕ НАДО.

-----------------------------------------------------------
4. ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ ПО КОНФИГУРАЦИОННОМУ ФАЙЛУ
-----------------------------------------------------------

  Конфигурационные файлы мода:
    \res_mods\configs\xvm\default\
  Можно скопировать готовый конфиг из папки \res_mods\configs\xvm\user configs\

  Все возможные параметры конфига можно посмотреть в конфиге с русскими комментариями,
  который находится в папке документации в архиве мода:
    \res_mods\configs\xvm\default\

  Поддерживаемые теги HTML:
    https://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/text/TextField.html#htmlText

  Список используемых макросов в macros.txt и macros-hangar.txt (для ангарной части).

      Допускается форматирование макросов (используется формат, приближенный к printf):
        {{name[:norm][%[flag][width][.prec]type][~suf][(=|!=|<|<=|>|>=)match][?rep][|def]}}
        name  - имя макроса

        :norm - нормализация значения, например {{hp-ratio:300}} вернет значения в диапазоне 0..300

        flag  - "-" для выравнивания влево, иначе выравнивание вправо
                "0" для дополнения чисел ведущими нулями до заданной длины
                "'" для разделения тысячных разрядов (только для целых чисел)
        width - минимальная ширина
        prec  - в зависимости от типа:
                - максимальная ширина для строк
                - количество знаков после запятой для дробных чисел
                - смещение ASCII таблицы для чисел в ASCII (по умолчанию 129)
        type  - тип:
                s - строка
                d - целое число
                f - число с плавающей запятой
                x — шестнадцатеричное число (abcdef)
                a - целое число в ASCII (для значений от 0 до 100)
                ...

        suf   - суффикс, добавляемый в конце
        match - сравнение значения, возвращается только совпадающее значение, иначе значение по умолчанию
                допустимые операторы: =, !=, >, >=, <, <=
        rep   - подменное значение, возвращается вместо обычного значения если оно присутствует
        def   - значение по умолчанию, которое подставляется при отсутствии значения:

      Например:
        {{name%-10.10s}}      - обрезать длинные имена до 10 символов, а короткие дополнить
                                до 10 символов и выровнять влево
        {{kb%4.01f~k|----}}   - ширина 4 символа, обязательно 1 символ после запятой, выравнивание вправо
                                если kb==null, будет отображаться "----"
      Подробнее: https://ru.wikipedia.org/wiki/Printf

    Использование макросов перевода - {{l10n:localizationKey}}
      Макросы представляют собой ссылки на перевод в файлах \res_mods\mods\shared_resources\xvm\l10n\XX.xc file (XX означает код языка).
      Если перевод не найден, отображается "localizationKey".

      Пример с полосой захвата, используется язык en:
        \l10n\en.xc
          "enemyBaseCaptured": "Base captured by allies!"
        captureBar.xc
          "captureDoneFormat": "<font size='17' color='#FFCC66'>{{l10n:enemyBaseCaptured}}</font>"

        Как будет отображаться: "<font size='17' color='#FFCC66'>Base captured by allies!</font>"

      Узнать больше о переводах: https://koreanrandom.com/forum/topic/27394-xvm-localization/

  Примеры поля "format":
    1. Отобразить количество кило-боев, эффективность и процент побед без изменения цвета:
      "{{kb}} {{xwn8}} {{winrate}}"
    2. То же самое, но раскрасить каждое число в зависимости от его значения:
      "<font color='{{c:kb}}'>{{kb}}</font> <font color='{{c:xwn8}}'>{{xwn8}}</font> <font color='{{c:winrate}}'>{{winrate}}%</font>"
    3. То же, что и 2, но с выравниванием колонок:
      "<font face='Consolas' size='11'><font color='{{c:kb}}'>{{kb%2d}}k</font> <font color='{{c:xwn8}}'>{{xwn8}}</font> <font color='{{c:winrate}}'>{{rating%2d}}%</font></font>"
    4. Отобразить процент побед, подкрашенный в зависимости от рейтинга WN8:
      "<font color='{{c:xwn8}}'>{{winrate}}</font>"

  Примеры использования динамического цвета и прозрачности:
    "color": "{{c:xwn8}}" - цвет в зависимости от WN8
    "alpha": "{{a:hp}}" - прозрачность в зависимости от количества здоровья

  Иконки кланов и игроков.
    В качестве рейтинга кланов используется:
      Эло-рейтинг клана на Глобальной карте: https://ru.wargaming.net/clans/wot/leaderboards/#ratingssearch&order=-egm (колонка wGM).
      Эло-рейтинг клана в Укрепрайоне:       https://ru.wargaming.net/clans/wot/leaderboards/#ratingssearch&order=-wsh (колонка wSH).
      Формула:                               https://ru.wargaming.net/clans/wot/leaderboards/#ratingssearch&offset=0&limit=25&order=-esh&guide-slug=ratings&guide-anchor=1
      Принцип рейтинга ЭЛО:                  https://ru.wikipedia.org/wiki/%D0%A0%D0%B5%D0%B9%D1%82%D0%B8%D0%BD%D0%B3_%D0%AD%D0%BB%D0%BE
    Сервер XVM мониторит список топ-кланов и при запуске клиента этот список скачивается. При появлении топового клана в бою, с сервера XVM скачивается его иконка.
    Обновление списка на сервере происходит 8 раз в сутки.
    Существует возможность добавления своего набора иконок кланов/игроков.
    Параметр конфигурационного файла battle/clanIconsFolder определяет путь к корневой папке иконок кланов.
    Все иконки загружаются автоматически из подпапки с названием, соответствующем региону
    игры (RU, EU, US, и т.д. или из папки ID по id аккаунта игрока).
    Чтобы добавить иконку клана или игрока, просто скопируйте файл иконки в:
      \res_mods\mods\shared_resources\xvm\res\clanicons\[REGION]\clan\ (для клана)
      \res_mods\mods\shared_resources\xvm\res\clanicons\[REGION]\nick\ (для отдельного игрока)
      \res_mods\mods\shared_resources\xvm\res\clanicons\ID\ (для отдельного игрока по id)
    Так же можно сделать иконку по умолчанию для клана или игрока:
      \res_mods\mods\shared_resources\xvm\res\clanicons\[REGION]\clan\default.png (для клана по умолчанию)
      \res_mods\mods\shared_resources\xvm\res\clanicons\[REGION]\nick\default.png (для игрока по умолчанию)
    Иконки ищутся в следующем порядке:
      ID/<accountId>.png -> nick/<playerName>.png -> clan/<clan>.png -> clan/default.png -> nick/default.png

  Изображение 6-ого чувства.
    Для замены изображения индикатора 6-ого чувства поместите альтернативное изображение PNG формата в
    \res_mods\mods\shared_resources\xvm\res\ с именем SixthSense.png. В комплекте с модом поставляется SixthSense.png.sample, для использования - переименовать.

  Лог попаданий.
    Отрицательные значения x, y позволяют привязать текст к правому и нижнему
    краю, чтобы конфиг работал одинаково на разных разрешениях экрана.

  Часы в бою и на экране загрузки.
    Формат значений: PHP Date: http://php.net/date
    Например:
      "clockFormat": "H:i"          => 01:23
      "clockFormat": "Y.m.d H:i:s"  => 2013.05.20 01:23:45

-----------------------------------------------------------
5. СОЗДАНИЕ ПЕРСОНАЛЬНОЙ КОНФИГУРАЦИИ
-----------------------------------------------------------

  Персональная конфигурация позволяет сохранить индивидуальные настройки и не терять их при обновлении мода или установке пользовательских конфигов

    1. в папке res_mods\configs\xvm создайте новую папку и присвойте ей имя
    2. скопируйте в созданную Вами папку содержимое из папки default
    3. переименуйте xvm.xc.sample в xvm.xc
    4. замените в xvm.xc
      ${"default/@xvm.xc":"."}
    на
      ${"имя_вашей_папки/@xvm.xc":"."}
    5. Персональный конфиг создан, можно приступать к редактированию

   Внимание! Кодировка файлов должна оставаться UTF8+BOM.
   Для редактирования используйте Notepad++. https://kr.cm/f/t/1382/c/25815/
   В случае блокнота Windows: Сохранить как -> Кодировка: UTF.
