Files
mod_mod_manager/docs/ru.md
T

82 lines
12 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Mod Manager — моды, игры и их документация
Mod Manager — это экран **Моды и коллекции** главного меню. Здесь видно, какие моды установлены, что делает каждый из них, отсюда устанавливают и обновляют моды из онлайн-каталога, выключают моды и заглядывают внутрь готовых игр, чтобы понять, из каких модов они собраны.
Он входит в оболочку, которая всегда загружается вместе с меню, поэтому работает ещё до запуска любой игры.
## Как открыть
В главном меню выберите **Моды и коллекции**. У экрана две вкладки:
- **Моды** — все моды, которые известны игре: установленные и предложенные каталогом.
- **Коллекции** — готовые игры и схема модов, из которых собрана каждая.
Кнопка **← Меню** возвращает в главное меню. Кнопка **?** в правом верхнем углу, или **F1**, включает контекстные подсказки: наведите курсор на элемент управления, чтобы узнать, что он делает, щёлкните, чтобы закрепить подсказку, **Esc** — чтобы уйти.
## Обзор модов
![Вкладка «Моды»: фильтры слева, сетка карточек модов с обложками, поле поиска с открытой подсказкой, сортировка и кнопка Refresh catalog.](assets/mods-list.jpg)
На каждой карточке — обложка, название, автор, каталог, откуда мод, сколькими играми он используется (**в 4 коллекциях**), состояние и версия, а также переключатель вкл/выкл.
- **Поиск модов...** фильтрует по названию, автору или идентификатору.
- **По имени / По автору / По статусу** сортируют список.
- **Фильтры** слева сужают список по **статусу** (Не установлен, Установлен, Есть обновление, Доступна старая версия, Изменён локально, Выключен) и по **категориям** — например Сюжет, Геймплей, Визуал, Аудио, Библиотека, Движок, Инструменты. **Сбросить** очищает фильтры и поиск.
- **Обновить каталог** скачивает актуальный список опубликованных модов.
*Изменён локально* значит, что установленные файлы отличаются от копии той же версии в каталоге, — например, мод, который вы правите сами.
## Описание мода
Щёлкните по карточке, чтобы открыть её страницу: обложка, выбор версии, действия, краткое описание из манифеста мода и, если мод его предоставляет, **Документация** — подробное руководство вроде этого.
![Страница мода: обложка и версия Audio Engine, кнопки Reinstall и Disable, «in 4 collections», описание и раздел Documentation с выбором языка.](assets/mod-page.jpg)
Документация — это руководство **установленной** версии. Если выбрать в селекторе другую версию, пометка напомнит, что руководство ниже по-прежнему относится к установленной.
**Язык документации.** Селектор справа от заголовка «Документация» стартует на значении **Авто · язык интерфейса**: руководство следует за языком интерфейса игры. Если руководства на этом языке у мода нет, менеджер покажет руководство мода по умолчанию, затем английское, затем первое доступное; строка над руководством называет реально показанный язык (например, `EN`). Язык можно выбрать и вручную. У мода без руководств вместо них остаётся описание из манифеста.
Авторам модов: положите руководство в `docs/en.md` (переводы — в `docs/<язык>.md`, либо `docs/default.md`), а картинки рядом, например `docs/assets/screen.png`, со ссылкой `assets/screen.png`. Просмотрщик понимает заголовки, абзацы, списки, цитаты, блоки кода, ссылки и картинки PNG/JPEG/WebP; HTML, таблицы и анимации он не исполняет.
## Установка, обновление, выключение, удаление
Кнопки на странице мода и переключатель на карточке:
- **Установить / Обновить / Понизить / Переустановить** скачивают выбранную версию из каталога в вашу пользовательскую папку (`user://mods/`).
- **Выключить / Включить** (или переключатель на карточке) решают, загружается ли мод. Выключенный мод хранит файлы и данные в ваших сохранениях.
- **Удалить** стирает скачанный мод после подтверждения.
После любого из этих действий появляется плашка **Изменения вступят в силу после перезапуска игры**. Сам Mod Manager нельзя удалить или выключить с его собственного экрана.
**Установлен — ещё не значит используется.** Игра загружает моды, названные в её коллекции, плюс оболочку меню. Установка делает мод доступным; в игре он появится, только когда коллекция этой игры его включит.
## Игры и коллекции
Вкладка **Коллекции** сначала показывает готовые игры. Игра — это *коллекция*: поименованный набор модов и место, с которого начинается игра.
![Галерея игр: карточки Cthangover, My Novel и RPG Plus, у каждой «Ready to play», счетчики модов 32/32, 11/11 и 36/36 и кнопки Edit scheme.](assets/games-gallery.jpg)
Карточка сообщает, установлено ли всё, что нужно игре (**Готова к игре**, либо **Не хватает N** / **Установить (N)** / **Включить (N)**). Одна кнопка устанавливает или включает недостающее. **Изменить схему** открывает устройство игры; **+ Собрать свою игру** начинает новую коллекцию.
### Схема игры
![Схема My Novel: блоки Story, Assets и 2D engine со своими модами, стрелки от каждой зависимости к моду, которому она нужна, и инспектор с требованием к версии My Novel.](assets/collection-scheme.jpg)
Схема показывает *механики* игры (блоки вроде Story, Assets, 2D engine) и моды внутри них. Стрелки идут от зависимости к моду, которому она нужна. Положение карточек и сами блоки нужны только для чтения: порядок загрузки они не задают.
Выберите блок или мод — он откроется в **Инспекторе**. Там меняется версия, которую требует игра: **Любая**, **Не ниже**, **Точно**, **Ветка** (`^1` принимает любую 1.x) и другие. Это требование игры, а не версия, установленная у вас. **Проверка** перечисляет проблемы; **План** показывает, что применит установка коллекции.
![Инспектор мода, у которого требование «Exactly 999.0.0» не совпадает с установленной версией 1.0.0: требование и установленная версия показаны красным.](assets/version-mismatch.jpg)
Прочие кнопки схемы: **+ Механика** и **Добавить мод** меняют игру, **Дублировать** делает вашу копию (и предлагает скопировать сохранения), **JSON** показывает исходное описание, **Сохранить** и **Сбросить** оставляют или отбрасывают правки, **Применить коллекцию** устанавливает и включает то, что перечислено в плане. Изменённую встроенную игру можно вернуть кнопкой **Вернуть встроенную**; сохранения останутся на месте.
Изменения игры применятся при её следующем запуске. Сохранения игры остаются рабочими при смене её модов: данные модов, покинувших игру, откладываются в сторону и возвращаются вместе с модом.
## Если что-то пошло не так
1. **Мода нет в игре.** Проверьте, что он включён, и что коллекция игры его содержит (откройте **Изменить схему**).
2. **«Не удалось установить».** Проверьте подключение к интернету и снова нажмите **Обновить каталог**.
3. **На карточке игры «Не хватает» или «Проблемы».** Откройте её схему и вкладку **Проверка**: там перечислены недостающие моды, несовпадения версий и конфликты.
4. **Конфликт каталогов.** Один и тот же мод и версия опубликованы с разным содержимым в двух каталогах; предпочитайте каталог, которому доверяете.
5. **Нет раздела документации.** У мода пока нет руководства в `docs/`; вместо него показано описание из манифеста.