Требования к серверу

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

Установка uMod/Oxide

  • Загрузите версию uMod для вашего сервера.
  • Скопируйте файлы из архива в папку сервера с подтверждением замены.

Плагины

  • Плагины – это отдельные фрагменты кода, которые изменяют поведение игрового сервера..
  • Для получения большего количества информации о плагинах посетите Plugins – Getting Started.
  • Посмотреть все плагины

Расширения

Получение дополнительной информации

Поиск

Пожалуйста, пользуйтесь поиском прежде чем задать свой вопрос.

Плагины и расширения

При возникновении проблем:
  • Посетите страницу ресурса и нажмите кнопку Help.
  • Создайте новую тему в обсуждениях ресурса.

Плагины

  • Плагины – это отдельные фрагменты кода, которые изменяют поведение игрового сервера.

Файлы плагина

  • Код плагинов написан на языке CSharp (C#), файл имеет расширение .cs.

Установка

  • Больше информации о установке плагина сможете найти на странице Plugins – Installation.

Конфигурирование плагина

  • Большинство плагинов во время установки генерируют JSON конфигурационный файл, в котором можно настраивать работу плагина.
  • Больше информации о конфигурировании плагина можете найти на странице Plugins – Configuration.

Разрешения плагинов (permissions)

Команды плагинов

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

Консольные команды

  • Консольная команда это команда, которая запускается из:
  • Внутриигровой консоли (если она есть в игре)
  • Программное окно сервера (если поддерживается платформой)
  • RCON консоль(если игра поддерживает RCON)
  • В теме “Софт для сервера” содержится описание, примеры, аналоги консолей RCON и панелей управления.

Chat – команды

  • Chat – команды вводятся игроками, которые подключены к игре. Chat – команды начинаются со знака /.
  • Например: /help

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

Установка uMod плагинов занимает всего пару щелчков мыши.

  • Необходимо подобрать нужный плагин
  • Нажать кнопку Скачать/Download
  • Положить файл .cs в папку …\oxide\plugins или Tom:\Server\name_server\oxide\plugins – зависит от конфигурации запускаемого .bat файла на сервере/хостинге. Ориентируйтесь по консоли. Как только плагин попадает в правильную директорию.
  • Там должно быть следующее сообщение белым/серым цветом. Это нам говорит о том, что плагин загружен и работает:Loaded plugin NamePlugin.cs v0.0.0 by EncoderName
  • Или что-то подобное (не имеет значения в данном примере), это нам говорит о том, что плагин загружен и не работает: Error while compiling: NamePlugin.cs(688,4): error CS0246: The type or namespace name `JsonObject' could not be found. Are you missing an assembly reference?

Требования сервера

  • Чтобы установить плагин на сервер, сервер должен поддерживать Oxide 2.0 или выше, иначе плагины не будут загружаться или делать что-либо.
  • Запустите сервер и проверьте установлен ли мод с помощью консольной команды: oxide.version

Загрузка исходного кода

Скачайте нужный плагин на этой странице.

  • Не переименовывайте плагин и не изменяйте его расширение!
  • Если вы не опытный пользователь и не кодер, то не редактируйте содержимое .cs!

Удалённое управление

  • Если сервер расположен не локально, тогда подключитесь к серверу с помощью FTP client. Данные для подключения уточните у технической поддержки хостинга.
  • Подробное описание, ссылки на скачивание и инструкции установки FTP в теме “Софт для сервера”.
  • Данный вариант нужен для загрузки плагинов на хостинг/vds/ect (туда, откуда запущен сервер).

Обновление

  • Если плагин уже установлен и доступно обновление, просто перезапишите исходный файл (.cs) в папке plugins, и новая версия будет загружена автоматически.
  • Т.е. еще раз скачайте исходный файл на странице плагина и поместите с заменой файла туда, где плагин (.cs) уже находился.

Конфигурация плагина

  • Большинство плагинов во время загрузки генерируют JSON конфигурацию. С помощью этого файла (конфигурации) администраторы могут настроить работу плагина.

NamePlugin was compiled successfully in 104ms
Loaded plugin NamePlugin v0.0.0 by EncoderName

Папка конфигураций

  • Конфиги располагаются в папке config, которая расположена по пути oxide/config.

Имя файла

  • Файл конфигурации плагина имеет то же имя, что и сам плагин.
  • Например, плагин, с названием MyPlugin.cs (если он имеет конфигурацию) будет иметь конфиг с названием MyPlugin.json
  • Если плагин установлен, но не настраивается, файл конфигурации не будет создан.
  • Если плагин настраивается, но файл конфигурации недоступен, плагин может быть поврежден; в этом случае проверьте файлы журнала на наличие ошибок в папках oxide/logs.
  • Не переименовывайте плагин и не изменяйте его расширение!
  • Если вы не опытный пользователь и не кодер, то не редактируйте содержимое .cs!

Синтаксис файлов конфигурации JSON

  • Все файлы конфигурации плагина сохраняются в формате JSON (JavaScript Object Notation).
  • Конфигурационные файлы не должны иметь ошибок в синтаксисе. Используйте валидатор типа jsonlint.com для проверки конфигов.

Применение изменений

  • После внесения изменений в конфигурацию плагина, перезагрузите плагин с помощью консоли командой oxide.reload <НАЗВАНИЕ ПЛАГИНА>
  • Например: o.reload MyPlugin

Файлы данных

  • Data – файлы это JSON файлы, которые плагины могут использовать для хранения произвольных данных.

Папка Data

  • Data – файлы располагаются в папке data, которую можно найти по пути oxide/data.

Названия файлов данных

  • Файлы данных не следуют никаким соглашениям об именах, автор плагина может указать любое имя при создании файла данных.
  • Как правило они совпадают с названием плагина или же содержат в имени его название.

Синтаксис файлов данных JSON

  • Все файлы данных плагинов хранятся в файле типа JSON (JavaScript Object Notation). Фалы данных не должны иметь синтаксических ошибок. При редактировании файла вручную используйте валидатор, например jsonlint.com

Синтаксические ошибки: последствия

Допустив хотя бы одну синтаксическую ошибку (пример ниже), плагин может:

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

Правильный конфиг:{
"ConnectMessage": "<color=orange>%PLAYERNAME%</color> зашел на сервер.",
"DisconnectMessage": "<color=orange>%PLAYERNAME%</color> вышел с сервера."
}

НЕ правильный конфиг:
{
"ConnectMessage": "<color=orange>%PLAYERNAME%</color> зашел на сервер."
"DisconnectMessage": "<color=orange>%PLAYERNAME%</color> вышел с сервера."
}

Ошибка:
{
"ConnectMessage": "<color=orange>%PLAYERNAME%</color> зашел на сервер.",
"DisconnectMessage": "<color=orange>%PLAYERNAME%</color> вышел с сервера."
}

Это правило действует на синтаксис в любом коде: исходного кода (.cs), конфигурации (.json), базы данных (.json / .data)!