# Створення плагінів

> Створи плагін, пройди перевірку й заробляй на промпті, який він додає.

Source: https://reverie.im/uk/docs/plugins/creating-plugins
Language: uk

Написати плагін може будь-хто, хто ввійшов в акаунт. Відкрий чат, перейди на вкладку **Плагіни** бічної панелі й натисни **Створити плагін**. Редактор проводить через три кроки: **Тип**, **Основне** і **Конфігурація**.

## Обери тип \[#pick-a-type]

Ти можеш створювати три з чотирьох типів плагінів. Четвертий налаштовує параметри семплінгу моделі й належить Reverie.

| Тип                      | Що ти пишеш                                                                                                                            | Обмеження                                                                                                                                                |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Промпт-плагін**        | Шаблон промпту, написаний на Handlebars, який додається до системного промпту персонажа                                                | Шаблон до 100 000 символів                                                                                                                               |
| **Плагін-інструмент**    | Шаблон промпту плюс визначення інструмента: назва, опис, вхідні параметри, структура виводу й необов'язковий шаблон картки на HTML/CSS | Назва інструмента починається з літери й складається з літер, цифр і підкреслень, до 64 символів; опис до 2000; шаблон картки й стилі — до 100 000 кожен |
| **Інтерактивний плагін** | Ідентифікатор і щонайменше одне з такого: кнопка-тригер із формою, згенерована AI поверхня або інструмент, який може викликати AI      | Ідентифікатор до 80 символів, літери/цифри/дефіс/підкреслення, починається з літери або цифри                                                            |

Тип не можна змінити пізніше — **Тип плагіна не можна змінити під час редагування**.

> Плагін-інструмент не виконує жодних мережевих запитів. Коли модель викликає
> твій інструмент, вона сама вигадує аргументи, а твоя структура виводу й
> шаблон картки лише впорядковують ці вигадані значення для показу. Пиши
> інструменти, що подають інформацію, — панелі стану, шкали, інвентарі, кидки
> кубиків, — а не інструменти, які нібито щось шукають.

## Заповни основне \[#fill-in-the-basics]

**Назва плагіна** обов'язкова, до 100 символів. **Опис** необов'язковий, до 1000.

Тут є два перемикачі, і вони незалежні — можна ввімкнути будь-який, обидва або жоден:

| Перемикач                           | Дія                                                                                               |
| ----------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Зробити плагін публічним**        | Надсилає версію на перевірку. Після схвалення вона з'являється на вкладці **Спільнота** для всіх. |
| **Пов'язати з поточним персонажем** | Обмежує плагін чатами з персонажем, у чаті з яким ти зараз перебуваєш.                            |

Запит на вміст згенерованої AI поверхні — це шаблон, як і шаблон промпту: у ньому можна використовувати ті самі заповнювачі, як-от `{{char}}`, `{{user}}` і `{{date}}`, а також будь-які налаштування, які ти відкриваєш тим, хто встановлює плагін. Сторінка, яку він створює, складається з фіксованого набору компонентів — заголовків, абзаців, цитат, плиток зі статистикою, індикаторів прогресу, рейтингів, хронологій, чеклистів, тегів, списків фактів, виносок, бульбашок діалогу, сіток вибору, перемикних вкладок, зображень, згорнутого блоку зі спойлером, кнопок і текстового поля, у яке читач може вводити текст, — і вибирає свій вигляд за змістом: тон, стиль картки (простий, папір, скло або рамка) і щільність, і все це підлаштовується під тему читача. Зображення беруться із самого чату — портрет або банер персонажа, аватар читача, ілюстрація сценарію чи моменту, — і ні на що інше сторінка посилатися не може. Її кнопки можуть говорити від імені читача, задавати напрям сцени, який розіграє персонаж, випадковим чином визначати результат на пристрої читача, відкривати глибшу сторінку, оновлювати сторінку на місці або закривати її. Поточний час і канон світу персонажа підставляються автоматично.

## Почни з прикладу \[#start-from-an-example]

**Завантажити приклад** відкриває каталог стартових варіантів — Динаміка стосунків, Налаштування сцени, Книга лору / банк пам'яті, Панель стану персонажа, Шкала прихильності, Кубики / перевірка навички, Плин часу, Щоденник персонажа, Внутрішні думки, Правда чи дія та інші, згруповані за категоріями.

Це шаблони для редактора, а не плагіни, які хтось установив. Вибраний приклад заповнює поля конфігурації, щоб ти міг редагувати щось уже робоче; нічого з цього не поширюється й не публікується, доки ти не збережеш і не опублікуєш власний плагін.

## Доручи чернетку AI \[#let-ai-draft-it]

Кожен тип має помічника AI — **Згенерувати з AI** для шаблону промпту зі змінними та аналогічні для конфігурацій інструмента й інтерактивного плагіна. Ти описуєш, що хочеш, одним-двома реченнями, і редактор заповнює поля. Налаштування, які ти відкриваєш тим, хто встановлює плагін, теж можна заповнити так — через **Заповнення конфігурації з AI**. Кожна генерація витрачає кредити.

## Попередній перегляд і налагодження — це різне \[#preview-and-debug-are-different]

|                            | **Попередній перегляд**                                                                                                          | **Налагодження**                                                                                   |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| Що робить                  | Рендерить твій шаблон із тестовими значеннями, які ти вводиш, — ім'я персонажа за замовчуванням *Alice*, ім'я користувача *User* | По-справжньому запускає незбережену чернетку з персонажем, із чату якого ти відкрив редактор       |
| Що показує                 | Згенерований промпт, системний промпт і відрендерений результат                                                                  | Відповідь персонажа, відрендерений вивід інструмента, журнал виконання, модель, тривалість, токени |
| Який контекст використовує | Лише заповнювачі                                                                                                                 | Знімок стану персонажа, сценарію, персони, спогадів, останніх повідомлень і ввімкнених плагінів    |
| Вартість                   | Безкоштовно                                                                                                                      | Безкоштовно — кредити не списуються                                                                |
| Ліміт                      | Без обмежень                                                                                                                     | 30 запусків за 3 години; діалог показує, скільки запусків залишилося                               |

Налагодження також обмежує тестове повідомлення 1000 символами, а тестову конфігурацію — 50 000 символами. Плагін-інструмент можна налагоджувати лише на моделі з підтримкою інструментів.

## Публікація й перевірка \[#publishing-and-review]

Збережений приватний плагін одразу стає доступним — тобі, і він установлюється в чат, з якого ти його створив. Якщо ж увімкнути **Зробити плагін публічним**, ця версія натомість іде на перевірку:

1. На вкладці **Мої** картка показує **На перевірці**, і ніхто інший не може його встановити.
2. Автоматична попередня перевірка запускається за розкладом і фіксує свій вердикт.
3. Людина схвалює або відхиляє плагін. Схвалені плагіни показують **Опубліковано** й з'являються на вкладці **Спільнота**.

Редагування схваленого плагіна створює нову версію, яка знову проходить перевірку, — картка повертається до стану **Оновлення на перевірці**, а попередня схвалена версія продовжує працювати в усіх, хто її встановив.

> Кожне збереження фіксує незмінну копію плагіна разом із його перекладами.
> Встановлені плагіни запускають ту копію, яку закріпили, тож ті, хто встановив
> версію 2, залишаються на версії 2, доки не натиснуть оновлення. За замовчуванням
> для персонажа можна закріпити лише версію, що пройшла перевірку.

## Скільки ти заробляєш \[#what-you-earn]

Коли хтось інший використовує твій плагін у платному повідомленні, ти отримуєш **5% від вартості в кредитах того тексту, який твій плагін сам додає до промпту**, — а не 5% від повідомлення. Сума — це власні токени промпту плагіна, помножені на множник кредитів моделі, помножені на 5% і масштабовані на частку цього повідомлення, оплачену платними кредитами.

Нічого не нараховується, коли:

| Випадок                                                | Чому                                                                          |
| ------------------------------------------------------ | ----------------------------------------------------------------------------- |
| Плагін офіційний                                       | Власні плагіни Reverie комісії не приносять                                   |
| Ти користуєшся власним плагіном                        | Платити самому собі не можна                                                  |
| У плагіна немає шаблону промпту                        | Інтерактивні плагіни нічого не заробляють — вони нічого не додають до промпту |
| Повідомлення повністю оплачено безкоштовними кредитами | Платна частка дорівнює нулю                                                   |

> **Інтерактивні плагіни ніколи не приносять комісії.** Якщо тобі важливий
> заробіток, створюй промпт-плагін або плагін-інструмент — це ті два типи,
> що додають текст до промпту.

## Як отримати виплату \[#getting-paid]

Комісії накопичуються як кредити в очікуванні й нараховуються **щомісяця, 1-го числа**. Якщо на момент нарахування твій баланс в очікуванні менший за **100 кредитів**, того місяця нічого не виплачується, і баланс переноситься на наступний.

**Переглянути дохід** на вкладці **Мої** показує **Усього зароблено**, **Очікує**, **Цього місяця** і **Наступне нарахування**, розбивку за плагінами з доходом, кількістю використань і датою останнього використання, а також історію нарахувань.

## Пов'язане \[#related]

* [Використання плагінів](https://reverie.im/uk/docs/plugins/using-plugins) — як твою роботу бачать ті, хто її встановлює
* [Огляд плагінів](https://reverie.im/uk/docs/plugins) — три види пліч-о-пліч
* [Джерела доходу](https://reverie.im/uk/docs/creators/revenue-streams) — інші способи заробітку для авторів
* [Кредити](https://reverie.im/uk/docs/billing/credits) — що таке кредит і як тарифікуються повідомлення
