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

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

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

  Сайт проекта: http://code.google.com/p/wot-xvm/

  Как написать в поддержку: http://www.koreanrandom.com/forum/topic/1644-readme
  Поддержка:    http://www.koreanrandom.com/forum/forum/43-xvm
  FAQ:          http://www.koreanrandom.com/forum/topic/1381-faq
                http://www.koreanrandom.com/forum/topic/1644-readme/
  Конфиги:      http://www.koreanrandom.com/forum/topic/1384-configurations
  Редактор:     http://www.koreanrandom.com/forum/topic/1422-/#entry11316

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

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

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

     Если нужны не стандартные настройки, необходимо создать конфигурационный файл:
       \res_mods\[ВЕРСИЯ ИГРЫ]\gui\flash\XVM.xvmconf

     Можно скопировать готовый из папки \xvm-doc\samples\, или воспользоваться
     онлайн-редактором: http://www.koreanrandom.com/forum/topic/1422-/#entry11316

     Старые конфигурационные файлы OTMData.xml тоже поддерживаются, вы можете
     их использовать если вам не нужны новые возможности.

     Все возможные настройки можно посмотреть в этом файле:
       \xvm-doc\samples\Full config RU\XVM.xvmconf

     Внимание: Если вы меняете конфиг вручную, используйте Блокнот (notepad),
     НЕ используйте word, wordpad и подобные редакторы)

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

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

  2. Если произошло обновление версии игры, скопируйте ваш конфиг:
     из res_mods/[СТАРАЯ ВЕРСИЯ]/gui/flash/XVM.xvmconf
     в res_mods/[НОВАЯ ВЕРСИЯ]/gui/flash/XVM.xvmconf

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

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

  Конфигурационный файл мода:
    \res_mods\[ВЕРСИЯ ИГРЫ]\gui\flash\XVM.xvmconf
  Можно скопировать готовый конфиг из папки \xvm-doc\samples\
  Можно создать новый конфиг или изменить существующий с помощью онлайн-редактора:
    http://www.koreanrandom.com/forum/topic/1422-/#entry11316

  Все возможные параметры конфига можно посмотреть в конфиге с русскими комментариями,
  который находится в папке документации в архиве мода:
    \xvm-doc\samples\Full config RU\XVM.xvmconf

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

  Используемые макросы:
    В ушах, на экране загрузки боя и в окне статистики боя по Tab:
      {{nick}}        - ник игрока с названием клана
      {{name}}        - ник игрока без названия клана
      {{clan}}        - клан игрока в квадратных скобках (пусто если нет клана)
      {{vehicle}}     - название танка
      {{vtype}}       - типа техники
      {{c:vtype}}     - цвет в зависимости от типа техники
      + макросы статистики (см. ниже)

    В маркерах над танком:
      {{nick}}        - ник игрока с названием клана
      {{name}}        - ник игрока без названия клана
      {{clan}}        - клан игрока в квадратных скобках (пусто если нет клана)
      {{squad}}       - значение '1' для своего взвода, пусто для остальных
      {{vehicle}}     - название танка
      {{vtype}}       - типа техники
      {{level}}       - уровень танка арабскими цифрами
      {{rlevel}}      - уровень танка римскими цифрами
      {{turret}}      - маркер сток башни:
                          символ "*" - башня стоковая и в неё нельзя ставить топ орудие
                          символ "'" - башня стоковая и в неё можно ставить топ орудие
                          пусто - башня топовая
      {{hp}}          - текущее здоровье
      {{hp-ratio}}    - процент текущего здоровья (без символа '%')
      {{hp-max}}      - максимальное здоровье
      {{dmg}}         - количество отнятого здоровья
      {{dmg-ratio}}   - процент отнятого здоровья (без символа '%')
      {{dmg-kind}}    - вид урона (атака, пожар, таран и т.д.)
      {{c:hp}}        - цвет в зависимости от текущего здоровья
      {{c:hp-ratio}}  - цвет в зависимости от процента текущего здоровья
      {{c:dmg}}       - цвет в зависимости от источника урона
      {{c:dmg-kind}}  - цвет в зависимости от вида урона
      {{c:vtype}}     - цвет в зависимости от типа техники
      {{c:system}}    - системный цвет (отменяет переопределенный цвет)
      {{a:hp}}        - прозрачность в зависимости от текущего здоровья
      {{a:hp-ratio}}  - прозрачность в зависимости от процента текущего здоровья
      + макросы статистики (см. ниже)

    В логе попаданий (hitlog):
      {{n}}           - общее число попаданий
      {{n-player}}    - число попаданий по каждому игроку
      {{dmg}}         - значение последнего попадания
      {{dmg-total}}   - общая сумма попаданий за бой
      {{dmg-avg}}     - средний урон за время боя
      {{dmg-player}}  - общая сумма попаданий по каждому игроку
      {{dead}}        - признак убийства танка
      {{nick}}        - ник игрока с названием клана
      {{name}}        - ник игрока без названия клана
      {{clan}}        - клан игрока в квадратных скобках (пусто если нет клана)
      {{vehicle}}     - название танка
      {{vtype}}       - типа техники
      {{level}}       - уровень танка арабскими цифрами
      {{rlevel}}      - уровень танка римскими цифрами
      {{dmg-kind}}    - вид урона (атака, пожар, таран и т.д.)
      {{c:dmg-kind}}  - цвет в зависимости от вида урона
      {{c:vtype}}     - цвет в зависимости от типа техники

    В полосе захвата:
      {{points}}      - кол-во уже захваченных точек
      {{extra}}       - дополнительная секция текста; показывается только когда захватчики и время вычислены успешно
      {{tanks}}       - кол-во захватчиков; нельзя обсчитать более трёх; может быть помещён только в дополнительную текстовую секцию
      {{time}}        - оставшееся время захвата; минуты и секунды;      может быть помещён только в дополнительную текстовую секцию
      {{time-sec}}    - оставшееся время захвата; только секунды;        может быть помещён только в дополнительную текстовую секцию
      {{speed}}       - скорость захвата; очков в секунду;               может быть помещён только в дополнительную текстовую секцию

    В миникарте:
      {{level}}       - уровень
      {{short-nick}}  - укороченный ник
      {{vehicle}}     - полное название типа техники
      {{ifspg}}       - вставка специального символа в случае артиллерии

    Макроподстановки статистики (необходимо включить rating/showPlayersStatistics):
      {{avglvl}}      - средний уровень танков игрока
      {{eff}}         - эффективность игрока: http://wot-news.com/index.php/stat/calc/ru/
      {{eff:4}}       - эффективность игрока с выравниванием слева до четырех символов
      {{teff}}, {{e}} - эффективность игрока на текущем танке: http://www.koreanrandom.com/forum/topic/1643-
      {{twr}}         - TWR (T-Calc): http://www.koreanrandom.com/forum/topic/2389-
      {{wn}}          - рейтинг WN6: http://www.koreanrandom.com/forum/topic/2575-
      {{rating}}      - общий процент побед
      {{rating:3}}    - процент побед с выравниванием слева до трех символов
      {{battles}}     - количество боев
      {{wins}}        - количество побед
      {{kb}}          - количество кило-боев (округление количества боев до 1000).
      {{kb:3}}        - количество кило-боев с выравниванием слева до трех символов
      {{t-rating}}    - процент побед на текущем танке
      {{t-rating:3}}  - процент побед на танке с выравниванием слева до трех символов
      {{t-battles}}   - количество боев на текущем танке
      {{t-battles:4}} - количество боев на танке с выравниванием слева до 4х символов
      {{t-wins}}      - количество побед на текущем танке
      {{t-kb}}        - количество кило-боев на текущем танке
      {{t-kb-0}}      - количество кило-боев на танке с ведущим нулем
      {{t-kb:4}}      - количество кило-боев на танке с выравниванием слева до 4х символов
      {{t-hb}}        - количество гекто-боев на танке (гекто = 100)
      {{t-hb:3}}      - количество гекто-боев на танке с выравниванием слева до 3х символов
      {{tdb}}, {{tdb:4}} - средний дамаг за бой для текущего танка - damage/battles
      {{tdv}} - средняя эффективность дамага для танка - damage/(battles*maxHP)
      {{tfb}} - среднее количество фрагов за бой для текущего танка
      {{tsb}} - среднее количество засвеченных врагов за бой для текущего танка
      {{c:tdb}}, {{c:tdv}}, {{c:tfb}}, {{c:tsb}} - динамические цвета для этих макросов
      {{c:eff}}       - цвет в зависимости от эффективности
      {{c:e}}         - цвет в зависимости от эффективности на текущем танке
      {{c:twr}}       - цвет в зависимости от TWR (T-Calc)
      {{c:wn}}        - цвет в зависимости от рейтинга WN6
      {{c:rating}}    - цвет в зависимости от процента побед
      {{c:kb}}        - цвет в зависимости от количества кило-боев
      {{c:t-rating}}  - цвет в зависимости от процента побед на текущем танке
      {{c:t-battles}} - цвет в зависимости от количества боев на текущем танке

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

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

  Иконки кланов и игроков.
  Параметр конфигурационного файла battle/clanIconsFolder определяет путь к корневой
  папке иконок кланов.
  Все иконки загружаются автоматически из подпапки с названием, соответствующем региону
  игры (RU, EU, US, и т.д.).
  Чтобы добавить иконку клана или игрока, просто скопируйте файл иконки в:
    clanicons/[REGION]/clan/ (для клана)
    clanicons/[REGION]/nick/ (для отдельного игрока)
  Так же можно сделать иконку по умолчанию для клана или игрока:
    clanicons/[REGION]/clan/default.png (для клана по умолчанию)
    clanicons/[REGION]/nick/default.png (для игрока по умолчанию)
  Иконки ищутся в следующем порядке:
    nick/<player>.png -> clan/<clan>.png -> clan/default.png -> nick/default.png
  По умолчанию в архив мода добавлены топ 100 кланов.
  Полный архив со всеми кланами можно скачать отдельно:
    http://code.google.com/p/wot-xvm/downloads/list
    Файлы: clanicons-full-ru-XXX.zip (RU), clanicons-full-eu-XXX.zip (EU),
    clanicons-full-us-XXX.zip (US), clanicons-full-sea-XXX.zip (SEA)

  Изображение 6-ого чувства.
  Для замены изображения индикатора 6-ого чувства поместите альтернативное изображение PNG формата в
  res_mods/icons/SixthSense.png

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

  Часы в бою и на экране загрузки.
  Формат значений: Y:год, M:месяц, D:день, H:часы, N:минуты, S:секунды. "" - убрать часы.
  Например:
  "clockFormat": "H:N"          => 01:23
  "clockFormat": "Y-M-D H:N:S"  => 2012-12-31 01:23:45
  Так же в часах в бою допустимо использовать HTML.

  Диапазоны эффективности для {{teff}}, {{e}}.
    TEFF       E
    0..299     1 - очень плохой игрок
    300..499   2 - плохой игрок
    500..699   3 - удовлетворительный
    700..899   4 - ниже среднего
    900..1099  5 - средний
    1100..1299 6 - выше среднего
    1300..1549 7 - хороший
    1550..1799 8 - отличный
    1800..1999 9 - мастер
    2000+      E - Эксперт (топ-100 игроков на данной технике)
  Эти же диапазоны применимы к {{eff}} и {{wn}}.
