Addon manifest (.txt) format/ru

From ESOUI Wiki

Jump to: navigation, search

Contents

Формат файла

Внутри каждой директории аддона, в добавок к фактическим Lua и XML файлам, есть один файл, который обязан присутствовать в аддоне, чтобы последний читался игрой. Этот "файл манифеста" имеет такое же название, как и директория аддона, плюс расширение .txt. Его базовая версия выглядит вроде этого:

## Title: Full Addon Title
## APIVersion: 100003

SomeLuaFile.lua
SomeInterfaceXml.xml

Строки, начинающиеся с ## являются метаданными об аддоне. Остальные строки это просто-напросто перечисление путей к файлам, относительно директории аддона, которые должны быть загружены, как часть аддона. Lua-файлы будут загружены в той последовательности, в которой они указаны здесь.

Относительные пути поддерживаются внутри директории аддона.

Dir/SomeLuaFile.lua

Доступны так же и некоторые переменные:

localization/$(language).lua

Поля метаданных

APIVersion (Версия API)

Определяет версию API аддона для которой он был написан. На данный момент, это все время 100003, но когда API станет немного стабильнее, то это число скорее всего будет увеличиваться в следующих релизах. Аддоны, у которых APIVersion не совпадает с текущей версией API клиента будут отключены, если не отмечена галочка в меню аддонов около "Allow out of date addons", с ней они продолжат работать.

Title (Заголовок)

Описывающий заголовок для аддона, отображается в окне со списком аддонов. Может содержать пробелы и другие спецсимволы, например указание цвета.

Description (Описание)

Описание аддона, отображается в подсказке в окне со списком аддонов. Может содержать пробелы и другие спецсимволы.

DependsOn (Зависит от)

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

OptionalDependsOn (Опционально зависит от)

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

SavedVariables (Сохраненные переменные)

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

Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox