FriendsFrame in camelot's layout (385 x 424): the metal frame with the battle.net portrait, the bottom tabs, and the Contacts page with top Friends / Ignore sub-tabs: online friends, a divider, offline ones (level, class, area, status), the selected row lit, the friend menu on a right click. Our window lies over FriendsFrame, which stays the panel; its tabs, sub-tabs and buttons click the client's, so FriendsFrame.lua runs as it does. The Who, Guild and Raid tabs show the client's window until they are ported. 1.12: four friend buttons (two rows; camelot has two and a menu); GetNumFriends answers the total, online friends are counted here; no status icons, AFK and DND as the client writes them. Verified in addon_harness with a stub (5 friends, 3 online, 2 ignored): 6 rows with the divider fourth, "Тралл, Шаман 60-го уровня" (the ruRU positional template), clicking the second row selected friend 3 (online first), the Ignore sub-tab titled the list and swapped the buttons, the Who tab gave back the client window. Captures of both sub-tabs. Classic style: the client's lists and tabs as they are. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
MoonWell UI: Forever UI для клиента 1.12.1
Форк mod-forever-ui для MoonWell, то есть для клиента benilla (World of Warcraft 1.12.1). Апстрим написан под 3.3.5a. Здесь его переносят на API 1.12 и поставляют отдельным патчем, без правок исходников клиента.
Что где лежит
data/— апстрим как есть: аддон и экраны входа под 3.3.5, арт, данные сервера. Это эталон для порта и источник арта. Здесь не правим, чтобыgit merge upstream/mainпроходил без конфликтов.vanilla/— порт под 1.12:Interface/FrameXML/MoonWellUI/— код, который клиент грузит вместе со стандартным UI: окно выбора стиля и пункт меню;Interface/FrameXML/MoonWellUI/Forever/— перенесённые файлы Forever UI, в порядкеForeverUI.toc(см.Forever.xml);art-src/— исходники нашего арта (PNG). Сборка кодирует их в BLP;tools/build.py— сборка источника патча.
Что перенесено
| Файл апстрима | Как |
|---|---|
UIAtlas*.lua, Texts.lua, Texts_enUS.lua, Texts_ruRU.lua |
как есть: сборка копирует их из data/ и ставит сверху проверку стиля |
AtlasUtil.lua |
целиком: атласы, заливка, nine-slice, панели, вставки, кнопки |
Layout.lua |
позиции и их сохранение (ForeverUIDB через RegisterForSave), /fui reset |
PlayerFrame.lua |
целиком, без транспорта и API угрозы |
PetFrame.lua |
рамка питомца camelot (оформление цели цели) под рамкой игрока вместо стоковой: полосы, имя, портрет, довольство питомца охотника с подсказкой, пульсация атаки; клики и меню как в стоковом PetFrame_OnClick |
PartyFrame.lua |
рамки группы camelot вместо стоковых PartyMemberFrame1..4: полосы, имя, портрет с тоном при смерти, призраке и 20 % здоровья и пульсацией, лидер, ответственный за добычу, PvP, отключение, четыре дебаффа (рассеиваемые по опции 1.12), подсветка рассеиваемого, питомцы участников по SHOW_PARTY_PETS, скрытие в рейде по HIDE_PARTY_INTERFACE; меню и подсказка аур — стоковые. Без угрозы, ролей и проверки готовности (их нет в 1.12) |
TargetFrame.lua |
рамка цели, цель цели, очки серии |
TargetFrameAuras.lua |
баффы и дебаффы цели; в 1.12 у ауры цели нет заклинателя и времени, поэтому все значки одного размера и без таймера |
ActionBar.lua |
главная панель: клиентские кнопки в новой отделке, рамка, стрелки страниц, грифоны/виверны, выезд бонусной панели |
MultiBars.lua |
панели 2–5; левый край считается от ряда, а позиции клиента (UIParent_ManageFramePositions) перебиваются после него |
StanceBar.lua, PetBar.lua |
панели стоек и питомца, без тотемной панели |
BottomBar.lua |
микроменю (кнопки 1.12; «Карта» и «Помощь» убраны, как в camelot), сумки и кольцо ключей, сборка ряда, задержка в подсказке кнопки меню |
StatusBars.lua |
полосы опыта и репутации; потолок уровня 60 |
CastBar.lua |
полоса заклинаний на событиях SPELLCAST_* из 1.12; без щита «нельзя прервать» (1.12 этого не сообщает) |
Minimap.lua |
миникарта: кольцо, маска, полоса зоны, отслеживание (значок способности в рамке), почта, масштаб колесом, кольцо день/ночь поверх GameTimeFrame, серверное время в полосе, координаты; константы в таблице C (лимит 32 upvalue в Lua 5.0) |
Buffs.lua |
баффы и дебаффы игрока на GetPlayerBuff/PLAYER_AURAS_CHANGED, сворачивание долгих баффов; без объединения баффов и отмены зачарований оружия (их нет в 1.12) |
Tooltips.lua |
подсказки: nine-slice camelot вместо рамки клиента, заголовок сравнения у ShoppingTooltip1/2 при их показе |
Bags.lua |
окна сумок: рамка, портрет, сетка, поиск, сортировка, раскладка столбцами; GetItemInfo по строке item:, общая сумка по подклассу аукциона; без валют |
CharacterFrame.lua |
лист персонажа 631×484 в вёрстке camelot: рамка, портрет, полоса уровня, модель с вращением мышью, слоты, статы 1.12 группами, сопротивления, колонка боковых вкладок; страницы регистрируются через CharacterSheet.RegisterPage; питомец пока в вёрстке клиента без старого фона |
ScrollBar.lua |
полоса прокрутки camelot, обработчики на this |
ReputationTab.lua |
страница репутации в панелях листа: свои строки по GetFactionInfo (без подзаголовков 1.12), подробности и флажки справа |
SkillsTab.lua |
страница навыков в панелях листа: свои строки по GetSkillLineInfo, ранг и описание выбранного справа |
PvPTab.lua |
страница чести: циферблат ранга camelot на нативных рангах 1.12 (UnitPVPRank, GetPVPRankProgress), статистика пяти периодов справа; без арен и списка полей боя |
PetTab.lua |
страница питомца: строка уровня и семейства, модель питомца с поворотом мышью, значок рациона и полоса опыта слева; преданность и очки обучения в каменной плашке, характеристики, ближний бой, защита и сопротивления справа; без спутников и маунтов (их нет в 1.12) |
SpellBook.lua |
книга заклинаний camelot: разворот на две страницы или одна (кнопка в заголовке), вкладки категорий (общая с иконкой класса, ветки класса, питомец), сетка с заголовком, листание стрелками и колесом, меню «Скрыть пассивные» и «Показывать все ранги»; обычные кнопки вместо secure-контроллера 3.3.5 (в 1.12 CastSpell не защищён), клики как в стоковом SpellButton_OnClick; без групп-выпадашек (в 1.12 нет GetSpellInfo) и без поиска |
WorldMap.lua |
карта мира camelot в окне: левая панель на месте camelot (16, −116) вместо полноэкранной 1.12, клавиатура не захватывается (можно двигаться с открытой картой), карта уменьшена до 697 px с обрезкой тайлов, рамка с портретом, навигация «Мир › континент › зона» со списками соседей, координаты игрока и курсора, кнопка панели заданий в углу; панель справа встаёт после карты. Без развёрнутого режима, фильтров и этажей (их нет в 1.12) |
QuestLog.lua |
журнал заданий как правая панель карты: L и кнопка меню открывают карту с ним, поиск, счётчик, заголовки зон со сворачиванием и меню «Отслеживать все», задания с цветом сложности, целями и галкой отслеживания, подсказка; по клику — страница задания (цели, описание, награды на выбор и обязательные, деньги, заклинание; «Отказаться», «Поделиться», «Отслеживать»). Отслеживание как в стоковом 1.12 (AutoQuestWatch_Insert); без меток на карте, ссылок на задания и текста завершения (их нет в 1.12) |
ObjectiveTracker.lua |
отслеживание заданий camelot вместо стоковых QuestWatchFrame и QuestTimerFrame: заголовок «Все задачи» и модуль «Задания» со сворачиванием, блок на задание (уровень, тип), цели «1/10 …» с галочками и анимацией выполнения, «Можно сдавать», полоса таймера, недостающие деньги; клик открывает страницу задания, Shift — перестать отслеживать, правый клик — меню; перемещается в режиме правки. Без достижений, предметов заданий и сортировки (их нет в 1.12) |
Templates.lua |
общие детали окон camelot: окно с портретом (камень, полосы, металл, заголовок), красный крестик, тонкая полоса прокрутки поверх стоковой, обводка качества предмета; общая расстановка панелей: левая с отступом 20, центральная справа от левой |
NpcDialog.lua |
окна NPC camelot 338 × 496 на пергаменте: разговор, задание (приветствие, описание, прогресс, награда), книга, хартия гильдии, регистратор; имя NPC в заголовке, портрет NPC или книга, полоса прокрутки прячется, когда текст влезает, и текст расширяется; обводка качества у наград и требуемых предметов |
Loot.lua |
окно добычи camelot: плоская панель «Предметы» до 290 px, карточка на каждый слот (фон по качеству, метка редкости, иконка, название), появление и выезд взятого слота вправо, прокрутка с тенями; кнопки карточек — LootButton 1.12 (иначе слот не взять), клики с Ctrl и Shift и выбор для ответственного за добычу как в стоковом LootFrameItem_OnClick |
Merchant.lua |
торговец camelot 336 × 444: вставка с мрамором, нижние вкладки «Торговец» и «Выкуп», иконки починки camelot, последний выкуп со стрелкой отмены, кошелёк в золотой рамке, название товара в цвете качества с обводкой иконки (качество из ссылки через GetItemInfo); у выкупа в 1.12 нет ссылок — без цвета |
Taxi.lua |
карта полётов camelot: бронзовая рамка без портрета, карта во вставке, значки узлов camelot (текущий, доступный, дальний) с подсветкой, линии маршрута и прямых рейсов; карта — клиентская 1.12, увеличенная до высоты camelot 580 в своих пропорциях: TaxiNodePosition в 1.12 отдаёт доли своей карты 316 × 352, а не мировой квадрат, на котором стоят картинки camelot |
Bank.lua |
банк camelot 480 px: банк и его сумки в одной сетке по 8, 88 ячеек на страницу со вкладками страниц справа, поиск с затемнением неподходящих, сортировка как у сумок, ячейки сумок с замком на некупленных, стоимость и покупка ячейки, кошелёк в золотой рамке; в 1.12 24 ячейки банка и 6 сумок, клики по ячейкам сумок — стоковые |
Mail.lua |
почта camelot 338 × 424: входящие на пергаменте с рамкой качества у вложений (серой у прочитанных), «Открыть все» (деньги и предметы по одному, после ответа ящика; письма ГМ и с наложенным платежом пропускаются), отправка и просмотр письма с полосой прокрутки по надобности и бумагой, обрезанной по окну; нижние вкладки camelot; в 1.12 одно вложение на письмо, поэтому ряд вложений один, а выбора бумаги нет и в стоке |
ProfessionsBook.lua |
книга профессий camelot 673 × 594 и её кнопка в микроменю (после портрета): карточки основных профессий с полосой навыка в цветах профессии, заклинаниями и кнопкой «Отказаться», три колонки вспомогательных (кулинария, рыбная ловля, первая помощь) с текстом-приглашением, если навыка нет; боковые вкладки: обзор и профессии с окном ремесла (вкладка применяет открывающее его заклинание). В 1.12 нет GetSpellInfo и номеров заклинаний в книге: профессия узнаётся по названию строки навыка (SkillLine.dbc, enUS и ruRU), её заклинания — по значку на вкладке «Общее» (Spell.dbc / SpellIcon.dbc); книга не двигается; вкладки стоят рядом с ней или с открытым окном ремесла |
Crafting.lua |
окно ремесла camelot 673 × 594 для обоих окон 1.12: TradeSkillFrame (ремёсла) и CraftFrame (наложение чар и дрессировка питомца, у которой вместо полосы навыка — очки обучения): список рецептов с заголовками, значками шанса повысить навык, поиском и фильтром (повышает навык, есть материалы, ячейки), полоса навыка в цветах профессии, карточка рецепта (результат с рамкой качества, инструменты или требование к уровню питомца, восстановление или стоимость в очках, описание, реагенты), кнопки «Создать», «Создать все» и счётчик; в 1.12 нет фильтров по имени и наличию материалов, ссылок на рецепты и GetStringHeight: поиск (с кириллицей без учёта регистра) и фильтры работают здесь, высота текста считается по ширине; открытие одного окна ремесла закрывает книгу и другое окно |
Chat.lua |
окна чата camelot: вместо стрелок — тонкая полоса прокрутки и кнопка «вниз», мигающая, пока чат не в самом низу; фон шире справа, под полосу; кнопка меню чата внизу колонки слева, кнопка друзей camelot над ней (открывает окно друзей); в покое видны только сообщения, колонка, полоса и кнопка проявляются при наведении; колесо мыши прокручивает чат (Shift — до конца, Ctrl — страница), как в camelot (в 1.12 колесо отдано камере); вкладки — клиентские, их рисунок совпадает с camelot; копирование выделением (Alt) из исходника не перенесено: ему нужны GetStringHeight и строки сообщений, которых 1.12 не даёт |
Social.lua |
окно друзей camelot 385 × 424: металлическая рамка с портретом battle.net, нижние вкладки, страница контактов с верхними вкладками «Друзья» и «Черный список»: друзья в сети, разделитель, не в сети (уровень, класс, зона, статус), выделение строки, меню по правому клику; кнопки нажимают клиентские, так что работает стоковый FriendsFrame.lua; в 1.12 у друзей четыре кнопки (добавить, сообщение, пригласить, удалить) — два ряда, GetNumFriends отдаёт только общее число (кто в сети, считается здесь), значков статуса нет — «отсутствует» и «не беспокоить» пишутся текстом; страницы «Кто», «Гильдия» и «Рейд» пока стоковые |
Compat.lua — наши помощники: HookScript, HookGlobal/HookMethod вместо hooksecurefunc,
сила через UnitMana, тексты полос по statusBarText.
Арт. Сборка кладёт в архив только листы, которые нужны перенесённым файлам: она ищет в них
имена атласов и пути Interface\ForeverUI\.... Сейчас это 6 листов, около 12 МБ.
Как это работает
Модуль — это один архив, Data/patch-F.MPQ:
Interface\FrameXML\FrameXML.toc— стандартный toc игрока плюс строкаMoonWellUI\MoonWellUI.xml. Сборка берёт toc из установки, файлов Blizzard в репозитории нет. benilla грузит этот toc из цепочки патчей так же, как 1.12 грузит пропатченный.Interface\FrameXML\MoonWellUI\— наш код. Он грузится после стандартных файлов и до слоя benilla.Interface\MoonWellUI\— наш арт (сейчас превью для окна выбора).
Стиль интерфейса хранится в CVar moonwellUIStyle (classic или forever; пусто, пока
игрок не выбрал). CVar общий для всего клиента и сохраняется в benilla-config/config.toml.
- Первый вход в мир. Пока стиль не выбран, после входа в мир открывается окно «Выберите интерфейс»: два превью, радиокнопки, «Готово». Escape его не закрывает, Enter подтверждает.
- Смена стиля. В меню игры (Esc) под «Макросами» есть пункт «Стиль интерфейса». Он открывает
то же окно, уже с «Отменой». Если стиль изменился, UI перезагружается (
ReloadUI). - Почему не на экране выбора персонажа. В 1.12 у экранов входа (GlueXML) нет
GetCVar/SetCVar. Общий для аккаунта выбор там не сохранить без правок клиента.
Сборка
Нужны Python 3.9+, Pillow и mpqx из benilla (cargo build -p benilla-formats --bin mpqx).
python vanilla\tools\build.py --data D:\WoW-1.12.1\Data `
--mpqx C:\Users\sindo\benilla\target\debug\mpqx.exe
Скрипт пишет build/patch-source/Data/patch-F/. Дальше — обычный деплой MoonWell:
# в C:\Users\sindo\benilla
.\scripts\deploy-moonwell.ps1 -DataPath D:\WoW-1.12.1\Data -IconPath ... -AuthHost ... `
-PatchSource C:\Users\sindo\moonwell-forever-ui\build\patch-source
-PatchSource принимает один каталог. Если у тебя есть другие свои патчи, положи
build/patch-source/Data/patch-F рядом с ними в их Data/.
Порядок патчей. Архивы patch-?.MPQ монтируются по имени, и побеждает последний. Если
архив с более поздней буквой (patch-G … patch-Z) тоже содержит
Interface\FrameXML\FrameXML.toc, он перекроет наш. Тогда либо дай нашему патчу более позднюю
букву (--patch patch-Z), либо добавь нашу строку в тот toc. Русский пакет Data/ruRU
монтируется после всех patch-?.MPQ, но FrameXML.toc в нём нет, поэтому наш он не перекрывает.
Проверка без сервера
Харнес benilla грузит стандартный UI с нашим патчем без окна и логина:
# Data с patch-F.MPQ; в харнесе только англ. локаль
WOW_DATA=<Data> target/debug/examples/addon_harness --probe-ui \
--eval 'return MoonWellUIChoiceFrame:IsVisible()'
Харнес сам шлёт VARIABLES_LOADED, PLAYER_LOGIN и PLAYER_ENTERING_WORLD, поэтому окно выбора
уже открыто.
Харнес и capture-режим ничего не сохраняют, и CVar в них всегда пустой. Чтобы проверить стиль
Forever, собери тестовый патч с --test-style forever: в нём невыбранный клиент сразу стартует
на Forever. Игрокам такой патч не отдаём.
Правила порта
- API — только 1.12. В обработчиках
this,event,arg1…, а неselfи.... Lua 5.0:table.getnвместо#,string.findвместоstring.match,argв функциях с...,math.modвместо%; не больше 32 upvalue на функцию. Нетhooksecurefunc, secure-шаблонов,SetAtlasиз 3.x (у ForeverUI свойAtlasUtilнаSetTexCoord). - Каждый файл Forever UI начинается с
if not MoonWellUI_IsForever() then return endи подключается вForever/Forever.xmlпередForever.lua. На классическом стиле он ничего не меняет. - Файл апстрима, который уже работает на 1.12 (только данные, синтаксис Lua 5.0), не
копируем руками, а добавляем в
UPSTREAM_AS_ISвbuild.py: тогда он обновляется вместе с апстримом. - Перенесённый файл называется как в апстриме и в первой строке говорит, откуда он и чем отличается.
- Не переносим то, чего нет в 1.12: транспорт, руны рыцаря смерти, символы, достижения и статистику, LFG, арены, гильдбанк, парикмахерскую, менеджер экипировки, валюты, тотемную панель.
- Арт берём из
data/art/interface/foreverui. Имя атласа или путь к текстуре пишем в перенесённом файле строкой целиком, или хотя бы его начало ("ui-hud-micromenu-".. набор .. состояние): по этим строкам сборка находит листы. Имя, склеенное из одних переменных, она не увидит.
Синхронизация с апстримом
git fetch upstream
git merge upstream/main # меняется только data/ и файлы апстрима в корне
Новые правки апстрима в data/addon и data/glue смотрим через git diff и переносим в
vanilla/ руками.
Лицензия и арт
Код апстрима — GPL-2 (LICENSE), наш код в vanilla/ — тоже. Арт в data/art взят из
современного клиента. Ни код, ни арт не кладём в репозиторий клиента (moonwell-client-core,
MIT/Apache, без ассетов): модуль живёт здесь и доезжает до игроков только архивом.