Перейти к основному содержимому

proximaclient.json: подсказки команд в консоли ProximaClient

Блок content файла proximaclient.json добавляет в подсказки консоли сервера в ProximaClient команды вашего плагина или мода, его предметы, эффекты и другие объекты. Владелец сервера начинает набирать команду, и приложение предлагает её имя, а затем аргументы по порядку. Подсказки собираются из всех включённых плагинов в папке plugins и модов в папке mods. Где лежит файл и как приложение его проверяет, написано на странице про экран настроек.

{
  "schemaVersion": 1,
  "content": {
    "addedCommands": [
      { "name": "home", "slots": [],
        "description": { "ru": "Телепорт домой", "en": "Teleport home" },
        "usage": { "ru": "<имя дома>", "en": "<home name>" } },
      { "name": "homeadmin", "slots": [
        { "kind": "enum", "values": [
          { "value": "delete", "followedBy": [{ "kind": "player" }] },
          { "value": "give", "followedBy": [{ "kind": "player" }, { "kind": "items" }] },
          { "value": "reload" }
        ] }
      ] }
    ],
    "addedItems": [
      { "id": "homes:home_stone", "name": { "ru": "Камень дома", "en": "Home stone" } }
    ]
  }
}

Команда​

КлючЧто это
nameИмя без /, до 64 знаков: латиница, цифры, _, : и -. Подкоманда — не пробел в имени, а слот enum.
slotsАргументы по порядку, до 64. Пустой список — команда без аргументов.
descriptionОписание рядом с именем в подсказке. Необязателен.
usageПодсказка к тексту, который вводят свободно после последнего слота, например <имя дома>. Необязателен.

В addedCommands до 200 команд. Команда с именем встроенной заменяет её в подсказках, а removedCommands — список до 200 имён, которые из подсказок убираются.

Слоты​

Слот {"kind": "enum", "values": […]} предлагает свои варианты, от 1 до 256. У варианта есть value (до 64 знаков, уходит в команду как есть), необязательные label, description и followedBy — до 64 слотов, которые идут после этого варианта; среди них тоже может быть enum. Так устроены подкоманды: в примере у delete и give свои аргументы, а у reload их нет.

Остальные слоты пишутся одним ключом, например {"kind": "player"}:

kindЧто подсказывает
playerНики игроков онлайн и селекторы @a, @e, @p, @s, @r, @n.
items, effect, enchantment, mob, biome, attribute, sound, particle, structure, dimensionПредметы, эффекты, зачарования, мобов, биомы, атрибуты, звуки, частицы, структуры и измерения: встроенные для версии сервера и добавленные плагинами и модами.

Предметы и другие объекты​

Списки объектов — пары addedItems и removedItems, addedEffects и removedEffects, и так же для Enchantments, Mobs, Biomes, Attributes, Sounds, Particles, Structures и Dimensions. В каждом списке до 2000 записей. Любой список блока, как и addedCommands и removedCommands, можно не писать.

Объект в added…:

КлючЧто это
idДо 128 знаков, уходит в команду как есть: namespace:path или одно слово без двоеточия. До двоеточия и в id без двоеточия — только латиница, цифры и _; после двоеточия ещё ., / и -.
nameНазвание в подсказке.
iconUrlСсылка http:// или https:// на иконку рядом с названием. Необязателен.

В removed… пишутся только id. Объект с id встроенного заменяет его. То, что один плагин или мод убрал из подсказок, другой не вернёт.

Проверьте: после замены .jar откройте вкладку «Плагины» или «Моды» и начните набирать имя команды в консоли сервера: команда есть в подсказке.