Анотації плагінів (RPG Maker MV та MZ)

Анотації плагінів або метадані плагінів в RPG Maker MV та MZ — це інформація про плагін, яка використовується у редакторі під час створення гри, але не в самій грі.

В анотаціях вказуються такі налаштування:

інформація про плагін,
які налаштування є у плагіну,
в RPG Maker MZ: які в плагіну є команди плагіну.

Формат налаштувань[ ]

Налаштування об'єднуються в блоки, а в блоках знаходяться окремі теги.

Блок[ ]

Налаштування записуються і блоках, які оформляються як багаторядкові коментарі /* ... */. Після зразу після символів /* йде тип блоку.

У найпростішому вигляді блок виглядає так:

/*:
  (зміст)
 */

Це блок, який не описує структуру і в якого англійська мова.

Мова блоку[ ]

RPG Maker MV та MZ підтримує декілька мов, і в плагіні можна додати різні блоки для різних мов.

Якщо плагін не має перекладу потрібною мовою, буде показано англійський текст. Тому англійський текст завжди має бути присутнім.

Якщо блок написаний іншою мовою, то код мови ставиться після знаку :. Наприклад, ось так можна додати текст українською:

/*:uk
  (зміст)
 */

В RPG Maker MV та MZ доступні такі мови:

en або пропущений код мови — англійська,
fr — французька,
it — італійська,
de — німецька,
es_ES або es — іспанська (Іспанія),
pt_BR або pt — португальська (Бразилія)
ru — російська,
ja — японська,
ko — корейська,
zh_TW — китайська (традиційна),
ar — арабська,
zh_CN — китайська (спрощена),
zh — китайська (буде показуватися як для традиційної, так і для спрощеної).

Крім того, в деяких плагінах зустрічаються інші коди за стандартом ISO 639-1, зокрема:

uk — українська,
be — білоруська.

Наразі в RPG Maker MV та MZ немає підтримки української або білоруської, але в деяких плагінах є українські тексти для майбутнього (якщо таку підтримку додадуть або якщо буде створено альтернативний редактор).

Якщо назва мови пропущена, використовується англійська.

Великі та малі літери з'являються різними літерами. Тобто ja — код японської, JA — помилка.

Блоки структур[ ]

Якщо блок описує структуру, то перед символом * в ньому йде йде текст ~struct~ і назва структури (в назві структури можуть вживатися лише англійські літери, цифри та символ _). Наприклад:

/*~struct~HudGauge:
 * @param Text
 *
 * @param Variable
 * @text variable
 */

Нові рядки в блоці[ ]

Якщо блок починається з пробільних символів, вони видаляються.

Якщо блок починається з символу «*», то видаляється він, а також один пробільний символ за ним (якщо він є).

Наприклад, всі ці рядки матимуть однаковий зміст, «текст»:

текст
       текст
             текст
 * текст
 *текст
    *текст
     * текст
*текст
* текст

А ось цей рядок буде іншим: в ньому буде два пробіли перед словом «текст», текст:

 *   текст

Дублювання блоків[ ]

Якщо є блоки-дублікати, тобто у декількох блоках після /* стоїть однакова мова і однаковий код структури, то використовується лише останній з них.

Так, у наступному прикладі команда @author буде ігноруватися:

/*:
 * @author Цей текст буде ігноруватися
 */
/*:
 * @plugindesc Плагін-приклад з блоками-дублікатами
 */

При цьому пустий тег мови і тег en вважаються одним і тим же при визначенні дублікатів.

Теги[ ]

Теги починаються з символа `@`, після яких йде назва тегу. В назві тегу можна використовувати тільки англійські літери, цифри та символ _.

Весь текст, який йде після назви тегу до наступного тегу (або кінця блоку) належить до цього тегу. Наприклад:

@author Спільнота РПГ.укр

Всі пробільні символи на початку або в кінці тексту обрізаються. Рекомендується ставити пробіл після назви тегу. Але якщо текст починається з символу, який неможливо використовувати в назві тегу, то це не обов'язково:

@authorСпільнота РПГ.укр (це працює, але так краще не писати)

Для зручності читання теги рекомендується ставити на початку рядка, але це не обов'язково: вони можуть стояти будь-де.

Посилання[ ]

Introduction to the new Plugin Manager in RPG Maker MV 1.5.0+ від orzfly на сайті Github,
アノテーションに関する解説 в документації з RPG Maker MZ.

Є пропозиції щодо покращення цієї сторінки. Якщо ви хочете цим зайнятися, зверніть увагу на коментарі  в коді сторінки.