Surveyor Map Framework

Открытый бэкенд (и API) для модов карт мира и путевых точек с поддержкой кооператива!
Требует Connector и FFAPI на (neo)forge.

Surveyor — это бэкенд для таких модов карт, как Antique Atlas 4, Hoofprint и Dead Reckoning.

При установке на клиенте Surveyor позволяет:

• Просматривать исследованную местность и отмечать точки интереса путевыми точками
• Видеть на карте метки других модов через аддоны совместимости, например для Waystones и OPAC
• Менять интерфейс карты в любое время, сохраняя все данные карты
• Автоматически переносить путевые точки прямо из существующего сохранения Xaero's Minimap

При установке на обе стороны Surveyor позволяет:

• Исследовать местность на карте и редактировать путевые точки в кооперативных группах (по умолчанию на весь сервер)
• Видеть других игроков на своей карте, даже далеко или в других измерениях
• Менять инстансы или компьютеры — данные карты восстановятся с сервера
• Использовать оп-команды для создания глобальных меток на сервере для точек интереса: спавна, магазинов, хабов варпов и т.д.
• Копировать исследование с ванильных карт и на них, присев и используя стол картографа (стиль настраивается)

Как разработчик модов, с Surveyor вы можете:

• Создавать чистые интерфейсы карт, взяв на себя все данные карты — местность, структуры и путевые точки
• Создавать аддоны для пользовательских меток на карте с гибкой компонентной системой данных
• Создавать любые интерфейсы — опционально серверные, внутриигровые/смешанные, внешние/браузерные и т.д.
• Использовать систему путевых точек отдельно для небольших лёгких модов путевых точек/компаса

Настройка

Surveyor настраивается через config/surveyor.toml, McQoy или QoMC. Большинство изменений требуют перезапуска.

• Отключите кооператив на весь сервер, установив globalSharing=false (рекомендуется для публичных серверов)
• Настройте, какие данные синхронизируются между игроками, группами и сервером, в разделе Networking
• Включите или отключите встроенные автоматические путевые точки (например, порталы в Nether, метки могил) в разделе Builtins

Команды

С Surveyor в основном взаимодействуют через интерфейсы карт, но есть и несколько полезных команд:

• При globalSharing=false используйте /surveyor share/unshare, чтобы создавать группы для обмена путевыми точками и данными карты
• Используйте /surveyor, /waypoints и /landmarks для просмотра своих путевых точек и исследованных данных карты
• Используйте /waypoints new/remove для создания/редактирования своих путевых точек (например, если интерфейс карты не установлен)
• Используйте /landmarks new/remove (op 2) для создания/редактирования глобальных операторских путевых точек (например, для спавна сервера)

Решение проблем

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

Клиентские данные хранятся в .minecraft/data/surveyor/[world]/[dim], данные одиночной игры/сервера — в [world]/[dim]/data/surveyor
Файлы c.X.X содержат регионы местности, s.X.X — структуры, а landmarks.dat — данные путевых точек.

Если возникнут проблемы, можно попробовать следующее:

• Сделать резервную копию затронутых данных и удалить их (например, при ошибке, связанной со структурой, очистить данные структур)
• Отключить сеть для подсистемы (например, при кике клиента из-за пакета рельефа установить networking.terrain в NONE)
• Отключить подсистему (например, при чрезмерном использовании памяти сервером установить terrain в DISABLED на сервере)

Вклад / Дополнения

Не стесняйтесь обращаться, если хотите разработать что-то с surveyor — или просто беритесь за дело! Мы ценим:

• PR, в которых делаются попытки улучшений и исправлений surveyor
• PR с портами на более старые устоявшиеся версии (1.4.7, 1.17.10, 1.12.2, 1.16.5, 1.18.2) — или на последнюю, согласно политике
• PR с API-функциями, которые были бы вам полезны — в идеале сначала создайте issue, и мы сможем это обсудить
• Дополнения для совместимости, карты мира, миникарты и фронтенды путевых точек, использующие surveyor!

Ознакомьтесь с руководством для разработчиков фронтендов, чтобы разобраться в сложных частях внутреннего устройства.

Лицензирование / Упоминание авторства

По возможности используйте для своих дополнений лицензию LGPLv3 — это помогает улучшать экосистему surveyor!
(LGPLv3 — это копилефт-лицензия, поэтому она обязательна для всего, что напрямую адаптировано из Surveyor)

Если вы что-то написали, напишите нам, и мы, возможно, добавим ссылку здесь! Мы также ответим на вопросы по текущим проектам.
Разработчики могут связаться с нами в mastodon или по email.

Послесловие

Surveyor был создан на основе мыслей, советов, мнений и прошлых работ многих моддеров сообщества.

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

Мы сделали surveyor, потому что это звучало круто — надеемся, это поможет другим художникам/моддерам создавать крутые вещи!