- Документация
- https://modrinth.com/mod/structure-credits
Что делает Structure Credits
Structure Credits — служебный мод, который при входе игрока в структуру показывает её название и источник-мод. Он помогает распознавать найденные локации и указывать происхождение контента в сборках с большим количеством зданий, подземелий и тематических областей.
Проект относится к категориям adventure, game-mechanics и utility. Лицензия — MIT, публично указан ECarrascon. Подтверждены Fabric и Minecraft 1.20.1, 1.21.1. Мод требуется на клиенте и сервере.
Скриншоты и внешний вид
Кому полезен мод
Structure Credits подходит игрокам, авторам модпаков и владельцам серверов, которым важно понимать происхождение структур. Основные сценарии:
• приключенческая сборка с множеством генераторов;
• похожие здания из разных проектов;
• демонстрационный мир с указанием источника;
• серверное прохождение с обсуждением локаций;
• проверка генерации после изменения модпака.
Новые структуры по заявленному назначению мод не добавляет. Он служит информационным слоем поверх существующей генерации.
Как работают сообщения
При входе в распознанную структуру отображаются название и источник. Заявлена интеграция с объектами других модов, но абсолютную совместимость со всеми форматами генерации считать доказанной нельзя. Покрытие проверяют на конкретной версии и сборке.
По умолчанию сообщение показывается один раз для каждой структуры. Это уменьшает повторные уведомления, если база находится внутри распознанного объекта. При отключении одноразового режима повторный показ, согласно описанию, возникает после выхода из структуры, посещения другой и возврата в первую, а не при каждом шаге внутри неё.
Настройки отображения
В structurecredits-config.json подтверждены возможности:
• полностью включать и отключать сообщения;
• показывать подпись один раз для каждой структуры;
• выбирать обычный вывод или чат;
• назначать собственные отображаемые названия;
• исключать целые пространства имён;
• исключать отдельные структуры;
• отключать уведомления назначаемой клавишей.
В исходной конфигурации названы параметры active, showOnlyOneTime, chatMessage, customStructureName, dontShowAll и dontShow. Перед правкой следует сохранить копию файла, менять один параметр за раз и проверять результат. Полная схема допустимых значений не приведена, поэтому добавлять неизвестные поля не следует.
Ванильные структуры и пользовательские названия
Пространство имён minecraft: может находиться в списке общих исключений, из-за чего ванильные структуры не показываются. Для их включения корректируют документированный список, а затем проверяют одну известную локацию в тестовом мире.
Отдельные объекты можно скрывать точечно; в примере упомянуты равнинная и пустынная деревни. Пользовательская подпись задаётся сопоставлением фактического идентификатора с отображаемым именем. Угадывать идентификатор нельзя: ошибочная запись просто не будет соответствовать нужной структуре.
В описании отдельно упомянута интеграция с Dimensional Dungeons. Исключение пространства dimdungeons: через dontShowAll рекомендовано для показа сообщений только в пользовательских комнатах. Это подтверждённая частная настройка, а не правило для всех модов подземелий.
Файлы и выбор версии
Подтверждены:
• structurecredits-1.21.1-3.0.jar, версия 1.21.1-3.0, 79813 байт;
• structurecredits-1.20.1-3.0.jar, версия 1.20.1-3.0, 79486 байт.
Имена однозначно указывают ветку Minecraft. Файл выбирают по точному совпадению версии игры; перенос JAR между 1.20.1 и 1.21.1 не подтверждён.
Зависимость и стороны установки
Обязательной зависимостью отмечена #CarrasconLib. Номер совместимого выпуска библиотеки в исходных данных не указан, поэтому его сверяют с метаданными выбранного файла.
Поскольку client=required и server=required, в многопользовательской сборке согласуют Structure Credits и библиотеку на обеих сторонах. Установка только клиенту или только серверу не является подтверждённым сценарием.
Подготовка и установка
Перед установкой нужно:
• Уточнить Minecraft 1.20.1 или 1.21.1 и Fabric.
• Выбрать соответствующий JAR.
• Подобрать совместимый #CarrasconLib.
• Скопировать мир, папки mods и конфигураций.
• Удалить старые версии обоих проектов.
• Не обновлять одновременно генераторы структур.
JAR мода и библиотеки помещают в папку mods, не распаковывая. На сервере файлы ставят в серверный экземпляр, клиенты используют согласованный набор.
Проверка файла
Для версии 1.21.1 опубликован SHA-1 3e71e95e87ab36847f46399331fbf42151a19e8a, для 1.20.1 — f21d85576d3b866aa5828c7c171a3f8cae454e27. В метаданных также приведены SHA-512.
Архивы получены по официальному HTTPS, сверены по опубликованным хешам и статически проверены по структуре и путям. Динамический запуск не выполнялся. Такая проверка не подтверждает работу каждого стороннего набора структур.
Как проверить результат
Проверку проводят в копии мира или новом тестовом мире:
• убедиться, что Fabric загрузил мод и #CarrasconLib;
• войти в известную модифицированную структуру;
• проверить название и указанный источник;
• выйти и войти повторно при одноразовом режиме;
• посетить другую структуру и вернуться после отключения этого режима;
• проверить одно пользовательское имя;
• отдельно протестировать ванильный объект, если minecraft: не исключён;
• повторить тест при подключении к серверу.
Если подписи нет, сначала проверяют списки исключений: объект может быть скрыт пространством имён или отдельной записью.
Ограничения
Мод зависит от того, распознаёт ли сборка нахождение игрока в структуре и связывает ли её с источником. Полного перечня поддерживаемых проектов, форматов комнат и случаев вложенных структур нет. Формулировку о работе с любой структурой следует воспринимать как цель проекта, а не гарантию.
Переименование меняет отображаемую подпись; данных о том, что оно меняет идентификатор, генерацию или сам объект, нет. Отключение сообщения также не удаляет структуру из мира.
Безопасное обновление
Перед заменой JAR сохраняют мир, текущий Structure Credits, #CarrasconLib и конфигурацию. На копии проверяют, сохранились ли параметры, пользовательские названия, исключения, одноразовый режим и клавиша отключения.
Не следует одновременно обновлять мод, библиотеку и несколько генераторов без промежуточного запуска. Иначе трудно отделить ошибку интерфейса от изменения генерации.
Откат
При неудачном обновлении игру или сервер останавливают, возвращают прежние JAR мода и библиотеки, затем восстанавливают сохранённую конфигурацию и при необходимости копию мира. Специальная процедура миграции не описана. Возвращать только основной JAR при другой версии библиотеки не следует.
Диагностика
Если игра не запускается, проверяют Minecraft, Fabric, #CarrasconLib, дубликаты JAR и сообщение загрузчика. Если подписи отсутствуют:
• убедиться, что active не выключен;
• проверить dontShowAll и dontShow;
• использовать структуру с известным идентификатором;
• временно убрать пользовательское переименование;
• проверить назначенную клавишу;
• повторить тест в минимальной сборке.
Если сообщения появляются слишком часто, проверяют showOnlyOneTime. При неверном источнике сначала исключают ошибочную запись customStructureName, затем сравнивают поведение без других модов. Универсального способа исправления неизвестных идентификаторов исходные данные не дают.
Лицензия и авторство
Structure Credits распространяется по MIT. При использовании следует сохранять название, авторство, не выдавая редакционные выводы за заявления автора.
FAQ
Добавляет ли Structure Credits новые здания?
Нет по заявленному назначению. Он показывает информацию об уже существующих структурах.
Почему ванильная структура не показывает подпись?
minecraft: может находиться в общем списке исключений. Следует проверить документированную настройку, предварительно сохранив файл.
Можно ли скрыть только одну структуру?
Да. Для этого предусмотрен список отдельных исключений dontShow.
Обязательно ли устанавливать #CarrasconLib?
Да. Библиотека отмечена как required-зависимость.
Будет ли сообщение постоянно появляться внутри базы?
По умолчанию используется показ один раз для каждой структуры. Его можно изменить настройкой или отключить назначенной клавишей.
