Модули - major1ink/Beacon-Table GitHub Wiki

С версии 0.9.0 игровые системы и контент ставятся модулями. Программа приходит пустой: стол, базовые состояния и «Своя система» без правил. D&D 5e (2014 и 2024) и справочник SRD 5.2 лежат в репозитории beacon-table-modules и обновляются отдельно от программы.

Модуль системы приносит лист персонажа, карточки, правила боя и оформление. Модуль контента добавляет существ, заклинания, предметы и справочник к своей системе: например, dnd5e-2024-srd работает только вместе с dnd5e-2024.

Как поставить D&D

  1. На экране «Миры» нажмите «Модули».
  2. Найдите нужную редакцию D&D 5e и нажмите «Установить».
  3. Если нужен ещё и справочник SRD 5.2, поставьте его так же. Модуль, которому нужен другой, предложит поставить их вместе.

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

Страница «Модули»: каталог и описание модуля с кнопкой «Установить»

Если нет интернета

Скачайте файл .btmod со страницы релизов репозитория модулей на любом компьютере, перенесите его и поставьте кнопкой «Из файла» на странице «Модули». Там же есть «По ссылке» — для файла, который лежит где-то в вашей сети.

Модули хранятся в папке data/modules и доступны всем мирам на сервере.

Как выбрать систему для мира

Систему выбирают при создании мира. Поменять её можно позже: «Настройки» → «Модули» → «Сменить». Данные при этом не пропадают: поля прежней системы остаются в листах и карточках и вернутся, если вернуть систему.

На той же вкладке включаются модули контента для этого мира. Их карточки появятся в компендиуме, трекере и луте. Модуль для другой системы в этом мире не включится.

Карточки модулей нельзя редактировать. Чтобы поправить монстра или заклинание под свою кампанию, скопируйте карточку в библиотеку мира, картинки скопируются вместе с ней.

Настройки → Модули: система мира и модули контента

Обновление с 0.8.x

[!WARNING] Перед обновлением сделайте резервную копию вручную. В 0.9.0 изменилось многое, а вернуться на старую версию можно только из копии: 0.8.x базу после 0.9.0 не откроет. Остановите стол и скопируйте папки данных и загрузок, как описано в разделе Эксплуатация → Обновление. В десктопе это папка стола, по умолчанию «Документы/Beacon Table».

При первом запуске мира, созданного на D&D до 0.9.0, откроется окно со списком нужных модулей. Их можно поставить сразу, по одному или из файла, а можно продолжить без них. Данные мира не меняются: сцены, токены, листы и наложенные состояния остаются на месте. Без модулей лист персонажа будет универсальным, а на столе останется напоминание.

Для авторов модулей

Свой каталог модулей подключается флагом --modules-index или переменной BEACON_MODULES_INDEX (адрес index.json). Модуль в разработке можно читать прямо из папки, без упаковки: --modules-dev или BEACON_MODULES_DEV, несколько папок через : (на Windows через ;).

Проверка и упаковка делаются утилитой btmod из репозитория программы:

go run ./cmd/btmod validate <папка модуля>
go run ./cmd/btmod pack -o <папка выпуска> <папка модуля>
go run ./cmd/btmod index -o index.json --base-url <адрес загрузок> <папка выпуска>

Готовые модули D&D в beacon-table-modules можно взять за образец. Контент D&D там только из SRD 5.1 и 5.2, подробнее в CONTRIBUTING.md.