Настройка (config.yml)
Файл — plugins/OstrakFree/config.yml. Каждый ключ ниже — с допустимыми
значениями и поведением по умолчанию, как в самом файле. Большинство ключей
читаются заново на каждое действие, но применяются только к новым
запросам/сессиям — уже открытый GUI или ожидающий запрос /doc inspect
изменение не затронет.
language
Какой файл из plugins/OstrakFree/lang/ использовать для всех сообщений.
Свой перевод/стиль — скопируйте lang/ru_RU.yml рядом под другим именем
(например lang/en_US.yml), отредактируйте и укажите здесь без расширения.
Файл не найден — тихий откат на ru_RU с предупреждением в консоли.
language: ru_RU # по умолчанию
passport.disabled-fields
Список ключей полей встроенного паспорта, которые нужно убрать целиком: не
показывать в GUI, не спрашивать в анкете self-режима, /doc set для них
отвечает «нет такого поля». Единственный способ убрать поле в free —
passport.yml зашит в jar и не редактируется напрямую.
passport:
disabled-fields: [discord, telegram, profession] # по умолчанию: []
Уже заполненные значения отключённых полей не удаляются — просто перестают
отображаться (включить поле обратно — данные на месте). Поле с ролью
given_name (источник имени гражданина) отключить нельзя — его ключ в
списке молча игнорируется. Полный список ключей — на странице
Паспорт и его поля.
inspect.radius
Максимальное расстояние в блоках между тем, кто требует документы
(/doc inspect), и тем, у кого требуют. Дальше — команда отклоняется, даже
если у требующего есть ostrak.inspect.force (форс обходит только согласие
цели, не расстояние).
inspect:
radius: 8 # по умолчанию
inspect.timeout-seconds
Через сколько секунд непринятый/неотклонённый запрос /doc inspect сгорает
сам. Требующему приходит «не ответил на запрос», игрок больше не может
ответить именно на этот запрос (/doc show//doc deny) — нужно запрашивать заново.
inspect:
timeout-seconds: 30 # по умолчанию
expiration.interval-minutes
Как часто (в минутах) фоновая задача проверяет документы на истёкший срок и
переводит их в статус EXPIRED. Встроенный паспорт бессрочный, но ключ
действует на любой другой тип документа со сроком (появится в premium).
expiration:
interval-minutes: 5 # по умолчанию
citizen.bootstrap-mode
Что происходит при первом входе игрока.
| Значение | Поведение |
|---|---|
self (по умолчанию) | Пошаговая анкета в чате: имя, фамилия, дата рождения и т.д. по одному полю. Кнопка «Пропустить» — оставить поле пустым |
auto | Пустой паспорт создаётся молча, без вопросов — подходит, если паспорт заполняет админ вручную (/doc set) или отдельная анкета на сайте/в Discord |
request | Заявка на утверждение чиновником — premium-функция, free откатывается на auto с предупреждением в консоли |
Любое другое/отсутствующее значение — тоже тихий откат на auto.
citizen:
bootstrap-mode: self # по умолчанию
gui.categories-enabled
Визуал GUI документа. true — поля типа документа с объявленными
categories (у встроенного паспорта — Личность/Семья/Гражданство/Работа/
Контакты) показываются по одной крупной иконке на раздел, все поля видны в
лоре при наведении. false — прежняя плоская раскладка: один слот
инвентаря на поле.
gui:
categories-enabled: true # по умолчанию
death.mode
Что происходит с паспортом при смерти персонажа.
| Значение | Поведение |
|---|---|
auto (по умолчанию) | Статус документа не меняется. Если физический предмет-паспорт потерян (выпал при смерти без keepInventory), при возрождении выдаётся новый экземпляр того же документа |
restore | В момент смерти паспорт аннулируется (REVOKED, как при /doc revoke). Восстановление — только вручную, через /doc issue passport <игрок> от того, у кого есть право ostrak.doc.passport (не обязательно полноценный админ) |
death:
mode: auto # по умолчанию
update-check
Проверка новой версии на Modrinth — при старте (только лог в консоль) и по
команде /ostrak update (ответ в чат). Ничего не скачивает и не
устанавливает, только сообщает номер последней версии.
update-check:
enabled: true
modrinth-slug: "" # slug/id проекта на Modrinth; пусто — проверка выключена молча