Начало работы
BTC Studio создаёт расширения для TypeWriter, движка квестов и повествования для серверов Paper. Эта документация описывает каждое расширение: что оно делает, как его установить и какие записи (entries) оно добавляет, поле за полем.
TypeWriter за пять минут
TypeWriter заменяет файлы конфигурации веб-панелью. Вы открываете панель с сервера (/typewriter connect), собираете страницы из записей, связываете их между собой и публикуете: сервер применяет изменения без перезапуска.
| Понятие | Что это |
|---|---|
| Страница (Page) | Контейнер для записей. Страницы-последовательности (sequence) содержат диалоги и действия, статические страницы (static) содержат определения (артефакты, говорящие, определения NPC), страницы-манифесты (manifest) содержат то, что всегда активно (аудитории, отображения), кинематографические страницы (cinematic) содержат таймлайны. |
| Запись (Entry) | Один строительный блок, определяемый своим типом (например, schematic_block). У каждой записи есть поля, которые вы заполняете в инспекторе. |
| Триггер (Trigger) | Связь от одной записи к следующей: событие запускает действие, которое запускает диалог… |
| Факт (Fact) | Значение, которое хранится или вычисляется для каждого игрока, используется в критериях (criteria), чтобы решить, выполняется ли запись, и изменяется модификаторами (modifiers). |
| Аудитория (Audience) | Фильтр игроков (находящиеся в регионе, держащие предмет, на определённом шаге квеста). Отображения, такие как неймплейты, фальшивые блоки или HUD, показываются аудитории. |
| Артефакт (Artifact) | Постоянные данные, принадлежащие расширению (размещённые схемы, запасы магазина, статистика). |
Расширения добавляют в этот набор инструментов новые типы записей. После установки расширения его записи появляются в строке поиска панели и за кнопкой + соответствующего типа страницы.
Установка расширения
- Установите TypeWriter на сервер Paper и убедитесь, что панель открывается.
- Скачайте расширение: из релизов GitHub для бесплатных расширений, с Voxel или BuiltByBit для платных. Кнопки находятся в верхней части страницы каждого расширения.
- Установите плагины, перечисленные в разделе Requires на странице расширения.
- Поместите JAR-файл в
plugins/Typewriter/extensions/и перезапустите сервер. - Откройте панель: новые записи доступны в строке поиска.
На странице каждого расширения указаны версия, которую оно описывает, и необходимая версия TypeWriter. Когда вы обновляете TypeWriter, одновременно обновляйте его расширения до соответствующего релиза.
Как ориентироваться в этой документации
- Каталог расширений содержит список всех расширений с фильтрами по доступности и теме.
- Каждая страница расширения построена по одной и той же структуре: обзор, возможности, установка, начало работы, команды, права, плейсхолдеры, записи, устранение неполадок.
- Каждая страница записи показывает запись так, как она выглядит в панели (идентификатор, вид, значок), и таблицу её полей с типом, значением по умолчанию и описанием. Эти таблицы генерируются из исходного кода расширения, поэтому соответствуют выпущенному коду.
| Доступность | Значение |
|---|---|
| Free | Открытый исходный код, можно скачать с GitHub. |
| Paid | Премиум-интеграции, продаются на Voxel и BuiltByBit. |
| Private | Работает в сети BornToCraft на сборке BTC для TypeWriter; документация приводится для ознакомления, не распространяется. |
| Soon | В разработке; записи ещё могут измениться. |
Получить помощь
Задавайте вопросы в Discord BTC Studio. Если вы нашли ошибку в бесплатном расширении, создайте issue в его репозитории на GitHub, указав версию расширения, версию TypeWriter и первую ошибку из лога сервера.