📦 Общая структура и refmap

Для работы с ElyxCore ваш плагин должен иметь определённую структуру. В корневой папке плагина обязательно должен находиться файл refmap.json (или .yaml, .yml, .py), который определяет пути к основным файлам плагина.

Базовая структура плагина

your_plugin_name/
├── refmap.json
├── main.py
├── metainfo.json
├── assets/
│   ├── icon.png
│   └── background.svg
└── strings/
    ├── strings_ru.json
    └── strings_en.json

⚙️ Файл `refmap`

Файл refmap.json (или .yaml, .yml, .py) является сердцем плагина. Он сообщает ElyxCore, где искать остальные файлы плагина.

{
  "metainfo": "metainfo.json",
  "main": "path/to/main.py",
  "assets": "assets",
  "strings": "strings"
}

metainfo: metainfo.json
main: path/to/main.py
assets: assets
strings: strings

metainfo = "metainfo.json"
main = "path/to/main.py"
assets = "assets"
strings = "strings"

string path

required

Обязательный ключ. Указывает путь к файлу с метаданными.

string path

Необязательный ключ. Путь к основному файлу плагина. По умолчанию main.py в корне плагина. В этом файле должен находится главный класс плагина, наследующийся от BasePlugin или CactusUtils.Plugin

string path

Необязательный ключ. Путь к папке с ресурсами. По умолчанию папка assets в корне плагина.

string path

Необязательный ключ. Путь к папке или файлу с локализованными строками. По умолчанию папка strings в корне плагина.

Начало

Разработка

📦 Общая структура и refmap

⚙️ Файл `refmap`

​⚙️ Файл refmap

⚙️ Файл `refmap`