Работа с плагинами

На текущий момент сервер поддерживает загрузку пользовательских плагинов в двух форматах:

• скомпилированные плагины на языке C#;
• плагины на языке Lua.

Каждый из указанных способов имеет свои особенности, преимущества и ограничения.

Плагины на C#

Разработка плагинов на языке C# осуществляется с использованием официального API. Для этого доступна подробная документация:

Документация по разработке плагинов

Особенности:

• требуется компиляция плагина перед загрузкой на сервер;
• поддерживается использование сторонних библиотек помимо официальных;
• предоставляется наиболее полный доступ к функциональности сервера.

Плагины на Lua

Плагины на языке Lua не требуют компиляции и могут быть загружены напрямую на сервер.

Особенности:

• отсутствует необходимость использования компилятора и дополнительных инструментов;
• упрощённый процесс разработки и тестирования;
• официальная документация по Lua отсутствует, однако большинство методов аналогичны тем, что используются в C# API.

Установка плагинов

Для загрузки плагинов необходимо создать каталог Plugins в корневой директории сервера и разместить в нём файлы плагинов.

В случае если плагин использует дополнительные ресурсы (например, пользовательские модели), необходимо создать следующую структуру каталогов:

• Plugins/client — клиентские ресурсы;
• Plugins/server — серверные ресурсы;

Внутри каталога client требуется создать подпапки для различных платформ:

• Android;
• Windows;
• Linux;
• OSX.

Итоговая структура каталогов выглядит следующим образом:

Plugins/
├── client/
│   ├── Android/
│   ├── Windows/
│   ├── Linux/
│   └── OSX/
└── server/

При подключении к серверу пользователи автоматически загружают не только сами плагины, но и все дополнительные ресурсы, включая пользовательские модели (персонажей, объектов, помещений и других элементов).

Рекомендации

• используйте проверенные и совместимые плагины;
• следите за структурой каталогов при работе с дополнительными ресурсами;
• проверяйте работоспособность плагинов после установки.