Beilin Data Portability

Описание на английском

Beilin Data Portability — это серверный аддон для Fabric к Beilin Entry Control, предназначенный для серверов участников Beiyue.

Этот мод записывает минимальные данные о принадлежности построек и обрабатывает одобренные запросы на экспорт с beiyue.us. Когда запрос игрока одобрен, мод может создать пакет экспорта Litematica и загрузить его через систему доставки Beiyue.

Возможности

• Индексация принадлежности построек для экспорта переносимости
• Одобренные запросы на экспорт построек через API Beiyue
• Автоматическое создание и загрузка пакета Litematica
• Минимальные данные индекса в пределах мира
• Без изменений других модов или структуры сохранения ванильного мира

Требования

• Доступ к серверу участника Beiyue
• Сервер Fabric с установленным Fabric API
• Установленный и настроенный Beilin Entry Control
• Действительный API-ключ, предоставленный Beiyue

Этот проект в первую очередь предназначен для китайских пользователей.

Beilin Data Portability（北约建筑数据可携带导出系统）

Beilin Data Portability — это серверный аддон для Fabric к Beilin Entry Control, предназначенный для серверов участников 北约. Этот мод записывает принадлежность построек игроков на сервере и после того, как игрок отправит запрос через beiyue.us, экспортирует постройку в виде пакета Litematica и передаёт его пользователю.

Мод создан для удовлетворения потребности пользователей в «праве на переносимость данных» построек, а не как универсальный инструмент резервного копирования, и не может использоваться для восстановления полного сохранения.

Обзор возможностей

• Индексация принадлежности построек
  Когда игрок ставит или ломает блоки, мод записывает информацию о принадлежности для компонентов постройки.

• Автоматическое создание пакета экспорта
  После одобрения администратором мод автоматически создаёт файл .litematic и загружает его в цепочку доставки beiyue.us.

• Низкая нагрузка
  Мод индексирует только минимально необходимую для экспорта данных информацию, которая резервируется и откатывается вместе с каталогом мира.

• Наблюдаемость действий
  Администратор может войти на beiyue.us, чтобы узнать о запросах на экспорт, деталях компонентов, отметках риска, размере поставки и причинах сбоя.

Предварительные условия

Перед установкой и использованием этого мода убедитесь, что выполнены следующие условия:

• Статус сервера участника 北约
  Этот мод доступен только для серверов участников 北约, для неучастников поддержка пока не предоставляется.

• Серверная среда Minecraft
  Сервер должен работать на сервере Fabric с правильно установленным Fabric API, чтобы мод мог нормально загружаться и работать.

• Установленный Beilin Entry Control

  • Этот мод является аддоном к Beilin Entry Control;
  • На том же сервере должен быть установлен и правильно настроен Beilin Entry Control.

Шаги установки

1. Установите Beilin Entry Control

   • Следуя инструкциям, завершите установку и настройку Beilin Entry Control;
   • Убедитесь, что apiKey в config/beilin-entry-control.json настроен правильно.

2. Поместите файл мода

   • Поместите .jar файл этого мода в папку mods в корневом каталоге сервера.
   • Beilin Entry Control и Beilin Data Portability должны присутствовать одновременно.

3. Первый запуск сервера

   • Запустите сервер один раз, чтобы мод завершил инициализацию;
   • Мод автоматически создаст:
   • config/beilin-data-portability.json
   • world/beilin-data-portability/index.db

4. Готово

   • В большинстве случаев изменять файл конфигурации не нужно;
   • Если хотите настроить конфигурацию, отредактируйте config/beilin-data-portability.json;
   • В логе запуска должно быть видно, что Beilin Data Portability успешно открыл базу данных индекса и зарегистрировал прослушивание экспорта.

Описание конфигурации

Путь к файлу конфигурации: config/beilin-data-portability.json

Пример содержимого (только пример, фактически ориентируйтесь на созданный файл):

{
  "exportProcessingEnabled": true,
  "recordingEnabled": true,
  "recordWorldEditBulkPlacements": true,
  "recordEffortlessBulkPlacements": true,
  "structureAuditEnabled": true,
  "discardLinearBulkPlacements": true,
  "artifactDirectory": "beilin-data-portability-exports",
  "maxExportVolumeBlocks": 4000000,
  "scanChunksPerTick": 12
}

• exportProcessingEnabled

  • Обрабатывать ли задачи экспорта в очереди;
  • Значение по умолчанию — true.

• recordingEnabled

  • Создавать ли индекс для построек игроков;
  • Значение по умолчанию — true.

• recordWorldEditBulkPlacements

  • Записывать ли изменения структур, созданные игроками через WorldEdit;
  • Значение по умолчанию — true.

• recordEffortlessBulkPlacements

  • Записывать ли изменения структур, созданные игроками через Effortless Structure;
  • Значение по умолчанию — true.

• structureAuditEnabled

  • Отправлять ли отчёт об изменениях структур, созданных WorldEdit и Effortless Structure;
  • Функция «结更审计» на beiyue.us зависит от работы этого параметра;
  • Значение по умолчанию — true.

• discardLinearBulkPlacements

  • Игнорировать ли добавление в индекс новых длинных линейных структур (например, железнодорожных линий);
  • Значение по умолчанию — true.

• artifactDirectory

  • Локальный каталог временных пакетов экспорта;
  • Относительный путь разрешается в каталоге config;
  • Значение по умолчанию — "beilin-data-portability-exports".

• maxExportVolumeBlocks

  • Максимальный объём одной области экспорта;
  • Значение по умолчанию — 4000000.

• scanChunksPerTick

  • Бюджет пакетной обработки сканирования экспорта;
  • Значение по умолчанию — 12.

После внесения изменений сохраните файл конфигурации и перезапустите сервер.

Процесс экспорта

1. Игрок подаёт заявку на экспорт постройки через панель игрока beiyue.us.
2. Администратор проверяет эту заявку в админ-панели beiyue.us.
3. После одобрения beiyue.us ставит задачу экспорта в очередь.
4. Beilin Data Portability забирает задачу и автоматически собирает экспортный пакет.
5. Экспортный пакет загружается фрагментами на beiyue.us, который обрабатывает дальнейшую цепочку доставки.

Индексация и хранение

• Путь к базе данных индекса: `/beilin-data-portability/index.db`
• Пути к файлам SQLite WAL: index.db-wal и index.db-shm в том же каталоге
• Каталог локальных временных экспортных пакетов: управляется настройкой artifactDirectory

База данных индекса резервируется и откатывается вместе с каталогом мира. При откате данных мира индекс построек portability также откатывается, чтобы избежать рассинхронизации индекса и состояния мира.

Текущая модель индекса сохраняет:

• измерение и ограничивающий бокс области постройки;
• принадлежность по имени пользователя и долю авторства;
• время последнего обращения, метки риска и информацию кэша сканирования.

При изменениях структур через ванильный /fill, WorldEdit или Effortless Structure мод записывает принадлежность на игрока, выполнившего команду. Режимы replace, keep, outline, hollow и destroy ванильного /fill обновляют индекс по фактически успешно записанным блокам; при выполнении из консоли или командного блока применяется стандартная обработка системных изменений блоков, и принадлежность игроку не приписывается.

Обновление и удаление

• Обновление мода

  • Остановите сервер;
  • Замените старую версию .jar в каталоге mods на новую;
  • Сохраните существующий config/beilin-data-portability.json, обычно менять его не нужно;
  • Перезапустите сервер.

• Удаление мода

  • Остановите сервер;
  • Удалите .jar этого мода из каталога mods;
  • При сохранении Beilin Entry Control контроль входа на сервер не затрагивается;
  • После перезапуска сервера индекс построек больше не будет создаваться, а задачи экспорта данных — обрабатываться.

Подсказка: если мод больше не используется, при необходимости можно вручную удалить config/beilin-data-portability.json, каталог локальных временных экспортных пакетов и каталог индекса beilin-data-portability в каталоге мира. Это не повлияет на другие настройки или сохранения.

Безопасность и прозрачность

• Этот мод создаёт лишь необходимый индекс для записи переносимости данных построек, подробнее см. Индексация и хранение.
• Он не изменяет конфигурационные файлы других модов или Minecraft и не затрагивает структуру ванильных сохранений мира.
• Всё взаимодействие с beiyue.us ограничено получением задач экспорта, загрузкой экспортных пакетов, отчётами о статусе и событиями изменения структур.
• Этот мод использует API-учётные данные и推送 задач экспорта Beilin Entry Control и не заменяет логику контроля входа на сервер.

Если остались другие вопросы, обращайтесь к Narek.