Files
moonwell-client/README.md
T

91 lines
6.1 KiB
Markdown

# MoonWell Client Sources
Репозиторий с ресурсами и исполняемым файлом модифицированного клиента World of Warcraft 3.3.5a.
Основная цель проекта: хранить и сопровождать клиентские изменения поверх стандартных MPQ-пакетов WoW, включая интерфейс, графику, звук и дополнительные данные для кастомных систем сервера.
## Что находится в репозитории
- `Wow.exe` - модифицированный клиентский исполняемый файл.
- Поддерживает использование до 4 ГБ ОЗУ.
- Игнорирует блокирование изменений в исходниках `GlueXML`, что позволяет вносить свои изменения в интерфейс и модели.
- `patch-4/` - наши изменения поверх стандартного `patch-4.MPQ`.
- Содержит графические элементы внутриигрового магазина.
- Основная зона изменений: `Interface/Store_UI`.
- `patch-ruRU-4/` - наши изменения поверх стандартных `patch-ruRU-1.MPQ`, `patch-ruRU-2.MPQ` и `patch-ruRU-3.MPQ`.
- Содержит ресурсы локали `ruRU`, связанные с экраном входа, `GlueXML`, заставками и звуком.
- Внутри есть `Interface/GlueXML`, `Interface/Glues`, `Interface/LoginScreen`, `Sound/Ambience`, `Sound/Music`.
- `patch-ruRU-5/` - пакет русской локализации и дополнительных интерфейсных ресурсов.
- Содержит перевод на русский язык для glue-интерфейса и связанных экранов клиента.
- Внутри есть `Interface/GlueXML`, `Interface/Glues`, `Interface/GluesVideo`, `Interface/Loginscreen`, `Interface/tooltips`, `Interface/cinematics`.
- `patch-Z/` - кастомный пакет для модуля Mythic+.
- Содержит графические ресурсы Mythic+.
- Также включает связанные клиентские данные в `DBFielsClient/` и иконки в `Interface/Icons/`.
## Структура по назначению
### Внутриигровой магазин
Файлы магазина находятся в [`patch-4/Interface/Store_UI`](./patch-4/Interface/Store_UI).
Примеры ресурсов:
- `Currencies/Gold.blp`
- `Currencies/Token.blp`
- `Frames/StoreFrame_Main.blp`
### Экран входа и локализованные ресурсы
Файлы экрана входа и связанные ресурсы находятся в [`patch-ruRU-4`](./patch-ruRU-4).
Основные каталоги:
- `Interface/GlueXML` - Lua/XML-исходники интерфейса загрузки и логина
- `Interface/Glues` - графика и модели для glue-экрана
- `Interface/LoginScreen` - фон и связанные изображения
- `Sound/Ambience/GlueScreen` - фоновые звуки
- `Sound/Music/GlueScreenMusic` - музыка экрана входа
### Русский перевод для `patch-ruRU-5`
Файлы русской локализации и расширенного glue-интерфейса находятся в [`patch-ruRU-5`](./patch-ruRU-5).
Основные каталоги:
- `Interface/GlueXML` - Lua/XML-исходники экранов логина, выбора реалма, выбора и создания персонажа
- `Interface/Glues` - текстуры, кнопки, логотипы и элементы интерфейса для `CharacterCreate` и `CharacterSelect`
- `Interface/GluesVideo` - видеоресурсы и ассеты glue-экранов
- `Interface/Loginscreen` - фон и изображения экрана входа
- `Interface/tooltips` - локализованные рамки и оформление тултипов
- `Interface/cinematics` - элементы интерфейса для роликов и заставок
Этот пакет используется как слой русификации для дополнительных экранов клиента и их визуальных элементов.
### Mythic+
Файлы Mythic+ находятся в [`patch-Z`](./patch-Z).
Основные каталоги:
- `Interface/MythicPlus/textures` - текстуры интерфейса Mythic+
- `Interface/MythicPlus/sounds` - звуки таймеров и событий
- `Interface/Icons` - дополнительные иконки
- `DBFielsClient` - клиентские DBC-данные, связанные с отображением предметов и интерфейсом
## Как воспринимать содержимое репозитория
- Каталоги `patch-*` представляют содержимое соответствующих MPQ-патчей в распакованном виде.
- Названия каталогов соответствуют именам клиентских патч-пакетов, поверх которых вносятся наши изменения.
- Репозиторий не является полной копией клиента WoW, а только набором модифицированных клиентских ресурсов и исполняемого файла.
## Для чего используется
Проект нужен для сопровождения клиентской части MoonWell:
- кастомизации GlueXML;
- поддержки русского перевода для `patch-ruRU-5`;
- поддержки внутриигрового магазина;
- добавления графики и данных для Mythic+;
- хранения пакетов графических улучшений;
- работы с модифицированным `Wow.exe` для WoW 3.3.5a.