Пакеты модов

Статья в разработке

version 0.3, 2017-05-03
License: CC BY-SA 4.0

Общая информация

Пакеты это способ организации файлов модификаций, в котором весь контент отдельной модификации упакован в один файл.
В случае использования старой схемы распространения файлов, модификации устанавливаются в каталог <каталог WoT>/res_mods/<версия WoT>/. При этом, файлы разных модификаций располагаются в одних и тех же каталогах, и поэтому зачастую трудно определить, какой файл относится к какой именно модификации. Переход на дистрибуцию в пакетах может существенно упростить организацию файлов модификаций: для установки пользователю достаточно скопировать пакет в каталог <каталог WoT>/mods/<версия WoT>/ , а для деинсталляции удалить ровно тот же файл.

Структура пакета

Пакет представляет собой zip-архив со следующими свойствами:

• без сжатия
• расширение: .wotmod
• максимальный размер архива: 2 ГиБ - 1 байт (2 147 483 647 байт)

Внимание: архивы с компрессией в текущей версии World of Tanks не поддерживаются, поэтому, при создании архивов необходимо установливать опцию «уровень сжатия» в значение «без сжатия».

архивы размером 2 ГиБ и больше в текущей версии World of Tanks не поддерживаются, поэтому большие пакеты необходимо разбивать на более мелкие, размер каждого из которых не будет превышает 2 ГиБ - 1 байт.

Внутри себя пакет содержит:

• обязательно: каталог /res/. Сюда помещаются ресурсы модификации, то есть все те файлы, которые раньше устанавливались в <каталог WoT>/res_mods/<версия WoT>
• опционально: служебный файл meta.xml (смотрите раздел 5)
• опционально: файл LICENSE с лицензионным соглашением
• опционально: любой иной контент, который может понадобиться автору модификации: ссылка на сайт модификации, документация, список изменений и тому подобное.
  

Пример структуры пакета:

/package.wotmod

/meta.xml

/README.md

/LICENSE

/res

/scripts

/client

/gui

/mods

/mod_example.pyc

Установка пакета

Пакеты устанавливаются в <каталог WoT>/mods/<версия WoT>. Это может быть как ручное копирование, так и установка посредством инсталятора модификации или сборки модификаций.

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

mods/

0.9.17.1/

MultiHitLog_2.8.wotmod

DamagePanel/

Some_common_library_3.14.5.wotmod

DamagePanel_2.6.wotmod

DamagePanel_2.8.wotmod

DamagePanel_2.8_patch1.wotmod

Рекомендации по именованию пакетов

Для имени пакета (в дальнейшем package_id ) рекомендована следующая схема формирования:

package_id = author_id.mod_id

Где:

• author_id : идентификатор автора. Может быть сайтом разработчика модификации

( com.example ) или же просто его никнеймом ( noname )

• mod_id : идентификатор модификации. Выбирается автором модификации произвольно.

Данное имя используется в файле meta.xml (смотрите раздел 5), а также как часть имени файла пакета.
Пример имён пакетов:

com.example.coolmod noname.supermod

Имя файла пакета формируется следующим образом:

<author_id>.<mod_id>_<mod_version>.wotmod

Где:

• mod_version : версия модификации, задаётся автором в meta.xml (смотрите раздел 5).

Примеры:

com.example.coolmod_0.1.wotmod
noname.supermod_0.2.8.wotmod

Файл метаданных meta.xml

Необязательный файл meta.xml содержит опциональные поля, описывающие модификацию.
Пример заполнения:

<root>

<!‐‐ Идентификатор пакета ‐‐>

<id>noname.crosshair</id>

<!‐‐ Версия пакета ‐‐>

<version>0.2.8</version>

<!‐‐ Имя пакета понятное для пользователя ‐‐>

<name>Crosshair</name>

<!‐‐ Описание пакета ‐‐>

<description>New cool Crosshair with feature1.....N</description>

</root>

Значения из полей <id> и <version> используются для определения порядка монтирования пакетов. Значения полей <name> и <description> в будущем будут использоваться в системе управления модификациями.

Загрузка пакетов

Порядок загрузки

Все пакеты, находящиеся в каталоге <каталог_WoT>/mods/<версия_WoT>/ , сортируются по значению узла <id> в файле meta.xml и загружаются по порядку. В случае отсутствия файла meta.xml внутри пакета, в качестве идентификатора пакета будет использовано имя файла.

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

В случае, если все пакеты указаны в load_order.xml , то загрузка выполняется в указанном в файле порядке.

В случае, если часть пакетов в load_order.xml не указана, то сначала выполняется загрузка пакетов из load_order.xml , а затем отсутствующих в нём пакетов в алфавитном порядке.

Внимание: в данный момент использование файла load_orders.xml затруднено (смотрите раздел 9.4).

Совместное использование пакетов и res_mods

С точки зрения клиента игры, корень виртуальной системы формируется из:

• /res_mods/<версия_WoT>
• /mods/<версия_WoT>/<имя_пакета>.wotmod/res/
• /res/packages/*.pkg/
• /res/
• Иные пути, указанные в файле <Каталог_WoT>/paths.xml

Пути указаны в порядке уменьшения приоритета. То есть, файлы из /res_mods/<версия_WoT>/ имеют наивысший приоритет вне зависимости от содержания load_order.xml

Разрешение конфликтов при загрузке

В общем случае, система пакетов не допускает ситуации, когда в каталоге res/ внутри разных пакетов находятся одинаковые файлы. Такая ситуация cчитается конфликтом.

В случае обнаружения конфликта, пакет, его вызвавший, целиком исключается из обработки, о чем пользователю выдается соответствующее уведомление. То есть, в случае если оба пакета a.wotmod и b.wotmod будут содержать внутри себя файл res/scripts/entities.xml , то a.wotmod будет загружен успешно, а b.wotmod вызовет конфликт и загружен не будет.

Для управления обработкой конфликтов можно использовать:

1. Файл load_order.xml . Пакеты, перечисленные в этом файле, не считаются конфликтующими и загружаются без анализа на пересечение имен файлов.
2. Значение узлов <id> и <version> из meta.xml . При наличии узла <id> в файле meta.xml , имя файла пакета не влияет на порядок загрузки. Пакеты, у которых <id> совпадает, считаются разными версиями или частями одной и той же модификации, и конфликты между ними также не учитываются. Данные пакеты загружаются в порядке увеличения версии.
   

Версии пакетов сравниваются посимвольно согласно таблице ASCII. Поведение совпадает с функцией strcmp():

• версия 9.0.0 приоритетнее версии 10.0.0
• версия b приоритетнее версии B
• версия c<любые символы> приоритетнее версии c
• если версии совпадают, то приоритет у пакета, имя файла которого будет первым по алфавиту.

При наличии одноименных файлов внутри разных пакетов, конфликты между которыми разрешены посредством load_order.xml или meta.xml , приоритет имеет файл из пакета, который был подключен последним или имеет наибольшее значение <version> .

Исполнение Python-кода

После монтирования всех пакетов и разрешения конфликтов, происходит исполнение всех .pyc - файлов из каталога /scripts/client/gui/mods/ в алфавитном порядке, имя которых начинается с mod_ . В пакете данный файл должен быть расположен по следующему пути:

<author_id>.<mod_id>_<version>.wotmod/res/scripts/client/gui/mods/mod_<anything>.pyc

Рекомендованные пути для файлов модификаций