Как использовать /ratio

Вступление

ratio — команда для проведения опроса среди пользователей чата с компактной визуализацией всех голосов относительно каждого голосовавшего. Исходно ratio был написан как шуточная функция для наглядной визуализации превосходства одного мнения в чате над другим. Теперь это достаточно гибкий инструмент для согласования и просто сбора мнения с наименьшим возможным трением.

/ratio

/ratio используется для создания опроса. Работяга присылает сообщение с таблицей всех зарегистрированных членов чата с иконками, показывающих голос каждого. Ratio настраиваемый как для конкретного опроса, так и на уровне чата. Для изменения параметров конкретного ratio вместе с командой передаются аргументы в виде «<key>: <value>». Двоеточие обязательно, если есть value, иначе достаточно только ключа; количество пробелов после двоеточия может быть любым, в том числе нулём.

Ниже приведены все аргументы, поддерживаемые ratio. Через | перечислены альтернативные названия ключей

Кнопки

Под ratio могут быть следующие кнопки:

🔴n - Против

🟡m - Воздержался

🟢y - За

🔵Y - За, даже если что-то изменится

❗d - Мне есть что сказать перед голосованием

↩️0 - Отменить голос

⛔x - Безвозвратно покинуть голосование

Аргументы

Ответ: если команда используется в ответ на другое сообщение, то это сообщение становится темой опроса. Если текст слишком длинный, опрос будет ссылаться на отвеченное сообщение.

тема|title — Заголовок для опроса. value должно быть заключено в двойные кавычки (чтобы тема поддерживала пробелы). Пример: тема: «Новый опрос»

all — Изменить вес голосов всех участников на выбранный. Пример: all:2

@username — Изменить вес голоса указанного участника. Пример: @Folegle: 4

goal|цель — Указать цель, к которой стремится опрос. Пример: goal: 6

lim|limit|лимит — Указать ограничение по времени для опроса. Доступные множители: d, h, m Пример: lim: 24h

btn|кн — Выбрать, какие кнопки будут доступны в этом опросе. Для отмены всех кнопок, кроме светофора, указать N, иначе любая комбинация из Y (синий), 0 (отмена), x (выход), d (обсуждение). Пример: btn: Yx или btn: N

diff|разность — Изменить фактическую цель. Без diff, goal означает количество голосов (вне зависимости от их значения), необходимого для окончания опроса. Так, без diff goal:3 означает, что для окончания опроса нужно участие трёх человек. С diff goal означает необходимую разницу между голосами за и против, необходимую для завершения опроса.

hide|закрыто — скрыть выбор каждого проголосовавшего. Отменяет diff. Требует goal

revote|смена — Поменять возможность переголосования в опросе на противоположное относительно стандартного для чата. Если в настройках чата переголосование разрешено, то revote его запрещает. Пример: revote

king|final|король — Добавить в опрос участника, голос которого является решающим. Также используется в шаблоне stakeholder как выбранный участник опроса, мнение которого будет учитываться. king без значения делает королём автора опроса Примеры: king | king: @Folegle

temp|template|ш|шаблон — выбрать шаблон для завершения опроса. Описания шаблонов будут ниже

Шаблоны

default — шаблон, используемый когда не указаны другие. Либо не имеет конца, либо голосование заканчивается, когда goal участников проголосовало

diff — выбирается автоматически, если указано diff. Голосование заканчивается, когда разность между за и против равна goal

king — выбирается автоматически, когда выбирается king. Голосование заканчивается, когда king выбирает за или против, либо выходит из голосования

stakeholder — требует выбранного пользователя king. Для окончания голосования king и любой из пользователей группы head и subs должны проголосовать одинаково.

consensus — требует goal. Когда выполняется goal по количеству участников, голосование закончится только если нет одновременно голосов за и против

tops — для принятия решения head и все subs, не отказавшиеся участвовать в голосовании должны проголосовать за. Голос против от любого из них прекращает голсование.

head — окончательное решение лежит за пользователем head

/ratioreg

Команда для регистрации в ratio или изменении своих данных

Синтаксис: /ratioreg firstname lastname

Команда заблокирует выполнение если нет двух аргументов. Все аргументы после второго игнорируются. firstname - Имя в ratio, lastname - Фамилия в ratio

ratioreg позволяет зарегистрироваться пользователям, не сделавших это другим образом. При этом регистрация возможная только если на аккаунте есть username

/ratioset

Команда для настройки ratio Использовать могут Админ и Администраторы текущего чата

Синтаксис: /ratioset [ключ1: значение1] [ключ2:значение2] ...

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

Отсутствие аргументов инициализирует ratio для этого чата. Появится сообщение, нажатие на кнопку под которым регистрирует пользователей.

Аргументы

head: username — сделать пользователя главой голосований

addsub: username — сделать пользователя заместителем

rmvsub: username — убрать пользователя из заместителей

adduser: user_id,username,first_name,last_name — добавить пользователя с указанными параметрами. Все параметры обязательные

upduser: username,first_name,last_name — для уже добавленного пользователя изменить имя и фамилию

rmvuser: username — удалить пользователя из ratio этого чата

@username: weight — установить стандартный вес голоса для пользователя

Далее идут команды, принимающие бинарные значения. Доступные аргументы для них: y/n; д/н; yes/no; 1/0; да/нет; true/false. Вместо параметра будут показаны стандартные значения для новых чатов:

king: True - включить опцию king

die: True - добавить кнопку ⛔

discuss: True - добавить кнопку ❗

undo: False - добавить кнопку ↩️

pin: False - закреплять новые опросы

revote: True - включить возможность переголосования в опросах