Плагины

Плагины позволяют вам добавлять новое поведение на ваш сервер Owncast без необходимости писать код самостоятельно. Это небольшие дополнения, которые работают внутри Owncast и могут реагировать на чат, зрителей, события потока и федиверс. Плагин поставляется в виде одного файла .ocpkg, который вы загружаете из администраторов.

Plugins require Owncast v0.3.0

Plugins are brand-new functionality, introduced in Owncast v0.3.0, and there are few plugins available today. If you hit a bug or have a suggestion, please open an issue or chat live with the community. If you have an idea for a plugin you'd like to see, share it with the community. You are encouraged to build your own plugins to share chat bots, stream overlays, custom integrations, themes and more. The plugin SDK has everything you need to get started.

Что может сделать плагин?

Плагин может:

• Добавить чат-бота, который отвечает на команды, публикует напоминания или удаляет спам.
• Добавить оверлей потока, который вы можете вставить в OBS в качестве браузерного источника (оверлеи живого чата, счетчики зрителей, оповещения и так далее).
• Подключить Owncast к другим сервисам, таким как Discord, федиверс или ваши собственные вебхуки, так что переход в прямой эфир или новый подписчик запускают что-то еще.
• Добавить пользовательские кнопки интерфейса, которые ссылаются на ваш магазин, страницу пожертвований, расписание или что-то другое.

Автор плагина решает, что делает его плагин. Вы решаете, устанавливать его или нет.

Как плагин запрашивает разрешение

Прежде чем плагин сможет сделать что-либо чувствительное, он должен это объявить. Когда вы устанавливаете плагин, администратор показывает вам список Разрешений, на простом языке, о каждой возможности, которую будет использовать плагин: такие, как "Публиковать сообщения в чате от имени бота-плагина" или "Делать исходящие HTTP-запросы к другим сервисам". Вы просматриваете этот список и решаете, включать плагин или нет.

Если плагин позже обновляется и запрашивает больше доступа, чем ранее, Owncast приостанавливает плагин и показывает значок "требуется повторное одобрение". Плагин не будет работать снова, пока вы не пересмотрите новые разрешения и не одобрите их. Ваши текущие одобрения никогда не расширяются без вашего ведома.

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

Откройте Плагины в боковом меню администратора. Существуют два способа добавить один.

Просмотреть каталог. Вкладка Просмотреть отображает плагины, опубликованные в публичном каталоге. Каждая карточка показывает, что делает плагин, кто его создал и какие разрешения он запрашивает. Нажмите Установить на любом из них, и Owncast загрузит его для вас.

Загрузить свой собственный. На вкладке Установленные нажмите Загрузить плагин и выберите файл .ocpkg. Используйте это для плагина, который вы создали сами или получили из другого места, кроме каталога. Every plugin has a unique identifier, so an upload that collides with a plugin you already have installed is rejected. Uninstall the old copy first if you are replacing it by hand.

В любом случае, Owncast показывает вам список разрешений плагина и спрашивает, хотите ли вы его включить. Переключите Включено, чтобы загрузить его. Плагин сохраняется после перезапусков, поэтому вам не нужно включать его снова после перезагрузки.

Отключение и удаление

• Отключить сохраняет плагин установленным, но останавливает его выполнение. Снова включите Включено, чтобы загрузить его вновь.
• Удалить полностью удаляет плагин. На странице Плагины нажмите иконку корзины на его строке и подтвердите. Файл плагина удаляется с сервера, и он немедленно перестает выполнять свои функции.

Чат-команды и !help

Многие плагины добавляют команды чата. Это короткие сообщения, которые начинаются с префикса, обычно !, которые говорят плагину сделать что-то. Пример с ботом Таймера ниже добавляет !remind, !countdown и несколько других. Зритель вводит команду, и плагин отвечает в чате.

Вам не нужно запоминать, что предлагает каждый плагин. В Owncast есть встроенная команда !help. Anyone in chat can type !help (or !commands) and Owncast replies with a single message listing every command from supported plugins, grouped by plugin, each with a short description.

Несколько вещей, которые стоит знать о !help:

• Automatically generated. Install a plugin that adds commands and they appear in !help right away. Отключите его, и они исчезнут.
• Плагины рекламируют свои собственные команды. Плагин объявляет свои команды и их описания, так что вам ничего настраивать не нужно. Описания, которые вы видите в !help, поступают напрямую от плагина.
• Команды модератора остаются скрытыми. Команды, которые плагин помечает как только для модераторов, появятся в !help только для ваших модераторов.

Hardware and resource usage

Plugins are standalone tiny programs that run inside Owncast. If you enable plugins they will take up some additional CPU and memory for the runtimes and plugin themselves. Generally the first plugin will see the most RAM usage jump, and then small increases from there. If you notice your server slowing down after enabling a plugin, try disabling it to see if performance improves.

Откуда берутся плагины?

Плагины создаются и делятся их авторами.

Когда вы устанавливаете плагин стороннего производителя, список Разрешений — это ваша граница доверия. Если плагин запрашивает больше доступа, чем вы ожидаете от того, что он утверждает делать, это стоит еще раз внимательно рассмотреть, прежде чем его включать.

Хотите создать один?

The full developer documentation lives at our plugin development docs.