В этом руководстве описано, как установить фреймворк моддинга Oxide/uMod или Carbon на ваш сервер Rust, добавить плагины сообщества и управлять ими через консоль. Общие сведения о настройке сервера и переменных запуска см. в Руководстве по настройке сервера Rust.
Установка Oxide/uMod или Carbon
Oxide (в настоящее время поддерживается как uMod) и Carbon — это фреймворки моддинга для Rust, которые позволяют устанавливать плагины, созданные сообществом. Эти фреймворки добавляют такие возможности, как системы экономики, пользовательские наборы, награды за голосование, зоны защиты PvE и многое другое.
Вам не нужно загружать какие-либо файлы вручную. Фреймворк моддинга устанавливается автоматически путём установки одной переменной запуска:
- Остановите сервер на вкладке Console в GPanel.
- Войдите в GPanel и перейдите на вкладку Startup.
- Найдите переменную
FRAMEWORKи установите для неё значение:oxide— для Oxide/uMod (наиболее широко используемый фреймворк с самой большой библиотекой плагинов)carbon— для фреймворка Carbon (альтернатива с собственной экосистемой плагинов)vanilla— для запуска без какого-либо фреймворка моддинга
- Запустите сервер. Файлы фреймворка загружаются и применяются автоматически. При первом запуске с Oxide создаётся структура каталогов
oxide/. - Проверьте журнал консоли на наличие строки вроде
Loaded plugin Oxide.Core, чтобы убедиться, что Oxide активен.
FRAMEWORK и запускаете сервер, фреймворк загружается и устанавливается автоматически. Вам не нужно загружать файлы Oxide или Carbon через SFTP.
Установка плагинов
Плагины распространяются в виде файлов .cs (исходный код C#). Oxide компилирует их на сервере во время выполнения — предварительная компиляция не требуется.
- Загрузите файл плагина
.csс umod.org или из другого надёжного источника. - Загрузите файл
.csв каталогoxide/plugins/на вашем сервере с помощью SFTP или файлового менеджера GPanel. Помощь по SFTP см. в статье Как загружать файлы через SFTP. - Если сервер запущен, плагин будет обнаружен и скомпилирован автоматически в течение нескольких секунд. Вы увидите в консоли подтверждение его загрузки, например
Loaded plugin MyPlugin v1.2.3 by Author. - Если сервер не запущен, плагин загрузится при следующем запуске.
Структура каталогов Oxide
oxide/
plugins/
MyPlugin.cs <- place plugin files here
AnotherPlugin.cs
config/ <- auto-generated plugin config files
data/ <- plugin data files
logs/ <- plugin log filesoxide/plugins/. Файлы, размещённые в подкаталогах или имеющие неправильное расширение, будут проигнорированы. Каждый плагин должен иметь расширение .cs.
Настройка плагинов
Большинство плагинов при первой загрузке создают файл конфигурации JSON в oxide/config/. Чтобы настроить плагин:
- Дайте плагину загрузиться хотя бы один раз, чтобы он создал файл конфигурации по умолчанию.
- Остановите сервер (или учтите, что некоторые плагины поддерживают перезагрузку конфигурации «на лету»).
- Откройте файл конфигурации плагина
oxide/config/PluginName.jsonс помощью файлового менеджера GPanel или SFTP. - Отредактируйте настройки и сохраните файл.
- Перезагрузите плагин командой
oxide.reload PluginNameили перезапустите сервер.
Управление плагинами через консоль
Эти команды можно выполнять из консоли GPanel или через RCON-клиент. Настройку RCON см. в статье Доступ к RCON и команды администратора Rust.
| Команда | Описание |
|---|---|
oxide.plugins |
Показать список всех загруженных в данный момент плагинов и их версий. |
oxide.load PluginName |
Загрузить плагин, который присутствует в oxide/plugins/, но ещё не загружен. |
oxide.unload PluginName |
Выгрузить плагин без удаления файла. |
oxide.reload PluginName |
Перезагрузить плагин после обновления его файла .cs. Используйте это для применения обновлений плагина без полного перезапуска сервера. |
oxide.reload * |
Перезагрузить все загруженные плагины одновременно. |
Обновление плагинов
Чтобы обновить плагин до более новой версии:
- Загрузите обновлённый файл
.csсо страницы плагина на umod.org. - Загрузите новый файл в
oxide/plugins/, перезаписав существующий файл. - Если сервер запущен, Oxide обнаружит изменение файла и автоматически перекомпилирует и перезагрузит плагин. В качестве альтернативы выполните
oxide.reload PluginName. - Проверьте консоль на наличие ошибок. Некоторые обновления плагинов могут потребовать изменений в файле конфигурации в
oxide/config/.
Удаление плагинов
Чтобы полностью удалить плагин:
- Выполните
oxide.unload PluginName, чтобы выгрузить плагин во время работы сервера. - Удалите файл
.csизoxide/plugins/. - При необходимости удалите файл конфигурации плагина из
oxide/config/и файлы данных изoxide/data/, если они вам больше не нужны.
Популярные плагины
| Плагин | Категория | Описание |
|---|---|---|
| Kits | Игровой процесс | Позволяет игрокам получать предварительно настроенные наборы предметов. Полезно для стартовых наборов или наград VIP. |
| Economics | Экономика | Добавляет систему серверной валюты. Используется в качестве зависимости многими плагинами магазинов и наград. |
| ServerRewards | Экономика | Система наград на основе очков, часто сочетается с Economics для внутриигрового магазина. |
| VoteDay | Утилиты | Позволяет игрокам голосовать за переход ко дню. Уменьшает жалобы на долгие ночи. |
| Clans | Социальное | Добавляет систему кланов/команд с клановыми тегами и общим доступом к шкафам для инструментов. |
| TruePVE | PvE | Предотвращает урон между игроками. Необходим для конфигураций серверов PvE. |
| Teleportation | Утилиты | Добавляет команды телепортации между игроками и к дому с настраиваемым временем перезарядки. |
| DiscordCore / DiscordMessages | Интеграция | Отправляет события сервера (подключения, чат, смерти) в канал вебхука Discord. |
Устранение проблем с плагинами
Если ваши плагины не загружаются, проверьте следующее:
- Убедитесь, что Oxide установлен и активен. На вкладке Startup в GPanel переменная
FRAMEWORKдолжна иметь значениеoxide. В журнале консоли при запуске должна отображаться строкаLoaded plugin Oxide.Core. - Файлы плагинов должны быть размещены непосредственно в
oxide/plugins/с точным расширением.cs. Файлы в подкаталогах или с неправильным расширением игнорируются. - Проверьте консоль и
oxide/logs/на наличие ошибок компиляции. Плагин с синтаксической ошибкой не загрузится, а сообщение об ошибке опишет проблему. - Некоторые плагины зависят от других плагинов (например, многие плагины магазинов требуют Economics). Сначала установите все необходимые зависимости.
Другие распространённые проблемы с сервером см. в статье Устранение неполадок сервера Rust.
Нужна помощь?
Если вы столкнулись с проблемой, не описанной в этом руководстве, наша служба поддержки готова помочь. Отправьте обращение в поддержку и укажите ID вашего сервера, описание проблемы и любой соответствующий вывод консоли.
