Update README

dzmuh97 · Jun 24, 2022 · ee1ea89 · ee1ea89
1 parent 1954b97
commit ee1ea89
Showing 1 changed file with 12 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -36,19 +36,19 @@
 
 По умолчанию включен тестовый режим. Можно сразу запустить симулятор `TwitchGenshinWishSim.exe` и посмотреть на результат 100 тестовых молитв. Тестовый режим отключается в файле конфигурации, параметр **test_mode**
 
-Чтобы симулятор отображался на трансляции, нужно добавить захват окна в OBS:
-![Окно захвата](https://media.discordapp.net/attachments/706496930414592080/980878746200453120/Sxxgzt6h_Ao.jpg)
-
-И настроить фильтр для корректной работы прозрачности окна:
-![Окно фильтра](https://media.discordapp.net/attachments/706496930414592080/980878745659375726/1HahxRWaJBF1kzE3BaChFSsMspC-LWBOcPf-kcj_f9g52D-Ia53P2osjQkR4F4wZXmfmu2-Gaavy5D7rU78ilhnS.jpg)
-
 В симуляторе используется 2 вида бота: чатбот, который читает сообщения из чата (секция **chat_bot**), и бот, который ждет использование баллов канала (секция **event_bot**). Так как эти боты работают раздельно друг от друга, возможны 2 варианта настройки:
 
  - Использовать разные учетные записи Twitch. Первая будет чатботом, вторая - аккаунт стримера, для баллов канала
  - Использовать одну учетную запись и для чатбота и для баллов канала
 
 При первом запуске будет предложено настроить аккаунты. Настройка автоматическая и интерактивная, нужно лишь следовать инструкциям и отвечать y или n (y - да, n - нет). Когда файл `auth.json` будет создан симулятор больше не будет предлагать настроить аккаунты. Далее можно переходить к настройкам симулятора в секцию [Описание config.json](#описание-configjson)
 
+Чтобы симулятор отображался на трансляции, нужно добавить захват окна в OBS:
+![Окно захвата](https://media.discordapp.net/attachments/706496930414592080/980878746200453120/Sxxgzt6h_Ao.jpg)
+
+И настроить фильтр для корректной работы прозрачности окна:
+![Окно фильтра](https://media.discordapp.net/attachments/706496930414592080/980878745659375726/1HahxRWaJBF1kzE3BaChFSsMspC-LWBOcPf-kcj_f9g52D-Ia53P2osjQkR4F4wZXmfmu2-Gaavy5D7rU78ilhnS.jpg)
+
 ### Регистрируем приложение на Twitch
 
 *Этот и следующие разделы можно пропустить, если сработала интерактивная настройка*
@@ -174,7 +174,7 @@
  - **send_dev_stats** - включение или отключение отправки анонимной статистики
  - **test_mode** - режим тестирования, твич бот не включается, автоматически делаются 100 молитв  
 
-### Описание секции MESSAGES
+## Описание `messages.json`
 
 Здесь перечислены блоки с текстом, которые симулятор или чатбот используют во время работы. В каждый блок можно добавлять или удалять строки. В каждом блоке должна быть минимум 1 строка.
 
@@ -202,11 +202,16 @@
  - Для блока **notify_text**
    - **username** - упоминание пользователя, который использовал команду
    - **command** - команда в виде **wish_command_prefix** + **wish_command**
+ - Для блока **user_splash_text**
+   - **wish_count** - сколько всего молитв сделал пользователь
+   - **wishes_in_cmd** - сколько будет сделано молитв за использоание команды
+   - **gems_in_cmd** - сколько стоят молитвы в примогемах
 
 ## Сервисные команды для чатбота
 
  - **!gbot_status** - выводит общую информацию о боте и молитвах в чат
  - **!gbot_sound** - включает или отключает звук во время молитв
  - **!gbot_pause** - включает или отключает обработку молитв. Бот по прежнему будет реагировать на использование баллов канала или команды чата, но анимации молитв воспроизводится не будут, при этом все молитвы будут находится в очереди пока обработка не будет снова включена
+ - **!gbot_history** - сгенерирует историю круток в html для зрителя, который использовал команду, и отправит общедоступную ссылку для ее просмотра
 
 *Проект собирает анонимную статистику. В нее входят время запуска и название канала из файла конфигурации. Никакие личные данные, IP адреса или токены от каналов\ботов не передаются.*